From 959e38ac5c2c2bce82446ed6368f730b4dd01b4a Mon Sep 17 00:00:00 2001
From: tobi <31960611+tsmethurst@users.noreply.github.com>
Date: Sun, 30 Jan 2022 17:06:28 +0100
Subject: [bug] Fix sqlite empty address issue (#370)

* error when empty address has been set for sqlite

* better explain sqlite db-address setting
---
 example/config.yaml | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

(limited to 'example')

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: ""
 
-- 
cgit v1.2.3