161sh/iceshrimp-161sh
1
0
Fork 0
mirror of https://iceshrimp.dev/crimekillz/iceshrimp-161sh.git synced 2024-11-21 19:53:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Add information on running with multiple workers

Browse Source
This commit is contained in:
Laura Hausmann 2023-11-25 03:18:39 +01:00
parent 6849a10a6a
commit 49e2edfa6c
No known key found for this signature in database
GPG Key ID: D044E84C5BE01605
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docker-compose-install.md
View File

@ -27,6 +27,8 @@ Run `cp .config/example-docker.yml .config/default.yml`, and edit `.config/defau
- Replace example database credentials with the ones you entered in `.config/docker.env` - Replace example database credentials with the ones you entered in `.config/docker.env`
- Change other configuration - Change other configuration
If you are running Iceshrimp on a system with more than one CPU thread, you might want to set the `clusterLimit` config option to about half of your thread count, depending on your system configuration. Please note that each worker requires around 10 PostgreSQL connections, so be sure to set `max_connections` appropriately. To do this with docker-compose, add `args: ["-c", "max_connections=n"]` to the `db:` section of `docker-compose.yml`, with `n` being `(10 * no_workers) + 10`.
## Installation and first start ## Installation and first start
Choose a method, whether you chose to build the image yourself or not. Choose a method, whether you chose to build the image yourself or not.

2
docs/install.md
View File

@ -89,6 +89,8 @@ yarn run init
### Optimizing performance ### Optimizing performance
If you are running Iceshrimp on a system with more than one CPU thread, you might want to set the `clusterLimit` config option to about half of your thread count, depending on your system configuration. Please note that each worker requires around 10 PostgreSQL connections, so be sure to set `max_connections` appropriately (aim for `(10 * no_workers) + 10`, if you have no other applications accessing the PostgreSQL database).
For optimal database performance, it's highly recommended to configure PostgreSQL with [PGTune](https://pgtune.leopard.in.ua/) using the "Mixed type of application" profile. This is especially important should your database server use HDD instead of SATA or NVMe SSD storage. For optimal database performance, it's highly recommended to configure PostgreSQL with [PGTune](https://pgtune.leopard.in.ua/) using the "Mixed type of application" profile. This is especially important should your database server use HDD instead of SATA or NVMe SSD storage.
## Setting up Webproxy ## Setting up Webproxy