SuperSeriousBusiness
/
GoToSocial
mirror of https://github.com/superseriousbusiness/gotosocial
1
1
Fork 0
Code Issues Projects Releases Wiki Activity

[docs] Add a warning about SQLite cache sizes (#2378) 

* [docs] Add a warning about SQLite cache sizes

* [docs] Fix admonition text

* [docs] Lorde the indenting

* [docs] Rework the text a bit
This commit is contained in:
Daenney 2023-11-22 19:06:30 +01:00 committed by GitHub
parent 71e0aaee3c
commit e9f636ea59
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/configuration/database.md
View File

@ -46,6 +46,9 @@ GoToSocial makes use of ULIDs (Universally Unique Lexicographically Sortable Ide
## Settings ## Settings
!!! danger "SQLite cache sizes"
More is not necessarily better for caches. They need to be tuned to the workload. The defaults should be plenty for most instances and you shouldn't change it. If you do change it, ensure you mention this when requesting help in the GoToSocial Help channel.
```yaml ```yaml
############################ ############################
##### DATABASE CONFIG ###### ##### DATABASE CONFIG ######
@ -156,6 +159,12 @@ db-sqlite-synchronous: "NORMAL"
# SQLite only -- unused otherwise. # SQLite only -- unused otherwise.
# If set to empty string or zero, the sqlite default (2MiB) will be used. # If set to empty string or zero, the sqlite default (2MiB) will be used.
# See: https://www.sqlite.org/pragma.html#pragma_cache_size # See: https://www.sqlite.org/pragma.html#pragma_cache_size
#
# More is not necessarily better for caches. They need to be tuned to the
# workload. The defaults should be plenty for most instances and you shouldn't
# change it. If you do change it, ensure you mention this when requesting help
# in the GoToSocial Help channel.
#
# Examples: ["0", "2MiB", "8MiB", "64MiB"] # Examples: ["0", "2MiB", "8MiB", "64MiB"]
# Default: "8MiB" # Default: "8MiB"
db-sqlite-cache-size: "8MiB" db-sqlite-cache-size: "8MiB"

6
example/config.yaml
View File

@ -229,6 +229,12 @@ db-sqlite-synchronous: "NORMAL"
# SQLite only -- unused otherwise. # SQLite only -- unused otherwise.
# If set to empty string or zero, the sqlite default (2MiB) will be used. # If set to empty string or zero, the sqlite default (2MiB) will be used.
# See: https://www.sqlite.org/pragma.html#pragma_cache_size # See: https://www.sqlite.org/pragma.html#pragma_cache_size
#
# More is not necessarily better for caches. They need to be tuned to the
# workload. The defaults should be plenty for most instances and you shouldn't
# change it. If you do change it, ensure you mention this when requesting help
# in the GoToSocial Help channel.
#
# Examples: ["0", "2MiB", "8MiB", "64MiB"] # Examples: ["0", "2MiB", "8MiB", "64MiB"]
# Default: "8MiB" # Default: "8MiB"
db-sqlite-cache-size: "8MiB" db-sqlite-cache-size: "8MiB"