summaryrefslogtreecommitdiff
path: root/example
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2022-01-30 17:06:28 +0100
committerLibravatar GitHub <noreply@github.com>2022-01-30 17:06:28 +0100
commit959e38ac5c2c2bce82446ed6368f730b4dd01b4a (patch)
tree8c06e0b2a651bb696812ef074c42bd4f5f2dd300 /example
parent[bug] Fix minimum description length check (#369) (diff)
downloadgotosocial-959e38ac5c2c2bce82446ed6368f730b4dd01b4a.tar.xz
[bug] Fix sqlite empty address issue (#370)
* error when empty address has been set for sqlite * better explain sqlite db-address setting
Diffstat (limited to 'example')
-rw-r--r--example/config.yaml12
1 files changed, 11 insertions, 1 deletions
diff --git a/example/config.yaml b/example/config.yaml
index ffc966863..cb84a028c 100644
--- a/example/config.yaml
+++ b/example/config.yaml
@@ -93,7 +93,17 @@ trusted-proxies:
db-type: "postgres"
# String. Database address or parameters.
-# Examples: ["localhost","my.db.host","127.0.0.1","192.111.39.110",":memory:"]
+#
+# For Postgres, this should be the address or socket at which the database can be reached.
+#
+# For Sqlite, this should be the path to your sqlite database file. Eg., /opt/gotosocial/sqlite.db.
+# If the file doesn't exist at the specified path, it will be created.
+# If just a filename is provided (no directory) then the database will be created in the same directory
+# as the GoToSocial binary.
+# If address is set to :memory: then an in-memory database will be used (no file).
+# WARNING: :memory: should NOT BE USED except for testing purposes.
+#
+# Examples: ["localhost","my.db.host","127.0.0.1","192.111.39.110",":memory:", "sqlite.db"]
# Default: ""
db-address: ""