HoovesSocial/hippofish
2
0
Fork 0
Code Issues 3 Pull requests 1 Projects Releases Packages Wiki Activity Actions

docs: minor enhancement

Browse source
This commit is contained in:
naskya 2024-07-03 15:18:50 +09:00
parent 2cb0078f3f
commit 34903eb024
No known key found for this signature in database
GPG key ID: 712D413B3A9FED5C
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/install.md
View file

@ -361,9 +361,9 @@ In this instruction, we use [Caddy](https://caddyserver.com/) to make the Firefi
sudo systemctl enable --now firefish sudo systemctl enable --now firefish
``` ```
## Maintain the server # Maintain the server
### Upgrade Firefish version ## 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](./upgrade.md). Be sure to switch to `firefish` user and go to the Firefish directory before executing the `git` command:
@ -372,7 +372,7 @@ sudo su --login firefish
cd ~/firefish cd ~/firefish
``` ```
### Rotate logs ## Rotate logs
If the server runs long, the size of log files increases, filling up disk space. To prevent this, you should set up a log rotation (removing old logs automatically). If the server runs long, the size of log files increases, filling up disk space. To prevent this, you should set up a log rotation (removing old logs automatically).
@ -411,7 +411,7 @@ The PGroonga log file (`pgroonga.log`) is located under this directory:
psql --user postgres --command 'SHOW data_directory' psql --user postgres --command 'SHOW data_directory'
``` ```
### Tune database configuration ## Tune database configuration
The default PostgreSQL configuration not suitable for running a Firefish server. Thus, it is highly recommended that you use [PGTune](https://pgtune.leopard.in.ua/) to tweak the configuration. The default PostgreSQL configuration not suitable for running a Firefish server. Thus, it is highly recommended that you use [PGTune](https://pgtune.leopard.in.ua/) to tweak the configuration.
@ -422,7 +422,7 @@ Here is an example set of parameters you can provide to PGTune:
| DB version | 16 (your PostgreSQL major version) | | DB version | 16 (your PostgreSQL major version) |
| OS Type | Linux | | OS Type | Linux |
| DB Type | Data warehouse | | DB Type | Data warehouse |
| Total Memory | (total physical memory) - 700 MB | | Total Memory | [total physical memory] minus 700 MB |
| Number of CPUs | number of CPU threads (or lower value if you have many) | | Number of CPUs | number of CPU threads (or lower value if you have many) |
| Number of connections | 200 | | Number of connections | 200 |
| Data storage | SSD storage | | Data storage | SSD storage |
@ -431,7 +431,7 @@ Since this is not a dedicated database server, be sure to leave some memory spac
Once you have entered the appropriate values for your environment, click the "Generate" button to generate a configuration and replace the values in `postgresql.conf` with the suggested values. Once you have entered the appropriate values for your environment, click the "Generate" button to generate a configuration and replace the values in `postgresql.conf` with the suggested values.
### VACUUM your database ## VACUUM your database
If the database runs long, "garbage" can degrade its performance or cause problems. To prevent this, you should execute the following commands regularly. If the database runs long, "garbage" can degrade its performance or cause problems. To prevent this, you should execute the following commands regularly.

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

@ -8,7 +8,7 @@ Please take a look at #10947.
## Unreleased ## Unreleased
This is not related to the recent changes, but we have added a new subsection called "[Maintain the server](https://firefish.dev/firefish/firefish/-/blob/develop/docs/install.md#maintain-the-server)" in the installation guide. We suggest that you take a look at it. This is not related to the recent changes, but we have added a new section called "[Maintain the server](https://firefish.dev/firefish/firefish/-/blob/develop/docs/install.md#maintain-the-server)" in the installation guide. We suggest that you take a look at it.
## v20240607 ## v20240607