clones/firefish
1
0
Fork 0
mirror of https://git.joinfirefish.org/firefish/firefish.git synced 2024-09-21 11:57:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: link to main branch

Browse Source
This commit is contained in:
naskya 2024-07-10 10:31:58 +09:00
parent aa30743f43
commit 5d034076aa
No known key found for this signature in database
GPG Key ID: 712D413B3A9FED5C
6 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -17,9 +17,9 @@ Firefish is based off of Misskey, a powerful microblogging server on ActivityPub
# Documents
- [Installation guide](./docs/install.md)
- [Installation guide](https://firefish.dev/firefish/firefish/-/blob/main/docs/install.md)
- [Contributing guide](./CONTRIBUTING.md)
- [Changelog](./docs/changelog.md)
- [Changelog](https://firefish.dev/firefish/firefish/-/blob/main/docs/changelog.md)
# Links

4
docs/changelog.md
View File

@ -2,8 +2,8 @@
Critical security updates are indicated by the :warning: icon.
- Server administrators must check [notice-for-admins.md](./notice-for-admins.md) as well.
- Third-party client/bot developers may want to check [api-change.md](./api-change.md) as well.
- Server administrators must check [notice-for-admins.md](https://firefish.dev/firefish/firefish/-/blob/main/docs/notice-for-admins.md) as well.
- Third-party client/bot developers may want to check [api-change.md](https://firefish.dev/firefish/firefish/-/blob/main/docs/api-change.md) as well.
## Unreleased

2
docs/install-container.md
View File

@ -51,4 +51,4 @@ NOTE: This will take some time to come fully online, even after download and ext
Once the server is up you can use a web browser to access the web interface at `http://serverip:3000` (where `serverip` is the IP of the server you are running the firefish server on).
To publish your server, please follow the instructions in [section 5 of this installation guide](./install.md#5-preparation-for-publishing-a-server).
To publish your server, please follow the instructions in [section 5 of this installation guide](https://firefish.dev/firefish/firefish/-/blob/main/docs/install.md#5-preparation-for-publishing-a-server).

2
docs/install.md
View File

@ -365,7 +365,7 @@ In this instruction, we use [Caddy](https://caddyserver.com/) to make the Firefi
## Upgrade Firefish version
Please refer to the [upgrade instruction](./upgrade.md). Be sure to switch to `firefish` user and go to the Firefish directory before executing the `git` command:
Please refer to the [upgrade instruction](https://firefish.dev/firefish/firefish/-/blob/main/docs/upgrade.md). Be sure to switch to `firefish` user and go to the Firefish directory before executing the `git` command:
```sh
sudo su --login firefish

2
docs/notice-for-admins.md
View File

@ -1,6 +1,6 @@
# Notice for server administrators
You can skip intermediate versions when upgrading from an old version, but please read the notices and follow the instructions for each intermediate version before [upgrading](./upgrade.md).
You can skip intermediate versions when upgrading from an old version, but please read the notices and follow the instructions for each intermediate version before [upgrading](https://firefish.dev/firefish/firefish/-/blob/main/docs/upgrade.md).
## Upcoming breaking change (unreleased)

4
docs/upgrade.md
View File

@ -2,7 +2,7 @@
## For systemd/pm2 users
1. Check [`docs/notice-for-admins.md`](./notice-for-admins.md)
1. Check [`docs/notice-for-admins.md`](https://firefish.dev/firefish/firefish/-/blob/main/docs/notice-for-admins.md)
1. Stop the server
```sh
sudo systemctl stop your-firefish-service.service
@ -28,7 +28,7 @@
## For Docker/Podman users
1. Check [`docs/notice-for-admins.md`](./notice-for-admins.md)
1. Check [`docs/notice-for-admins.md`](https://firefish.dev/firefish/firefish/-/blob/main/docs/notice-for-admins.md)
1. Pull the latest container image
```sh
docker pull registry.firefish.dev/firefish/firefish:latest