add more documentation

DEPLOY.md

@@ -106,11 +106,31 @@ allow_federation = true
 
 trusted_servers = ["matrix.org"]
 
-#db_cache_capacity = 1073741824 # in bytes, 1024 * 1024 * 1024
 #max_concurrent_requests = 100 # How many requests Conduit sends to other servers at the same time
 #workers = 4 # default: cpu core count * 2
 
 address = "127.0.0.1" # This makes sure Conduit can only be reached using the reverse proxy
+
+## sqlite
+
+# The amount of memory that the database will use, with the following formula;
+# (db_cache_capacity * (sqlite_read_pool_size + 1)), in bytes
+#db_cache_capacity = 1073741824 # in bytes, 1024 * 1024 * 1024
+
+# How many permanent read connections will be open to the database,
+# increase this if you see "creating spillover reader" in your logs.
+#sqlite_read_pool_size = 2 # default: max(cpu core count, 1)
+
+# If the database WAL (conduit.db-wal file) should be cleaned on a timer.
+#sqlite_wal_clean_timer = false
+
+# How many seconds should pass before the WAL clean task should fire.
+# Note: Is dependant on sqlite_wal_clean_timer being true.
+#sqlite_wal_clean_second_interval = 60
+
+# How long the WAL clean task should (in seconds) try to wait while
+# getting exclusive access to the database (before giving up).
+#sqlite_wal_clean_second_timeout = 2
 ```
 
 ## Setting the correct file permissions

conduit-example.toml

@@ -35,7 +35,6 @@ max_request_size = 20_000_000 # in bytes
 
 trusted_servers = ["matrix.org"]
 
-#db_cache_capacity = 1073741824 # in bytes, 1024 * 1024 * 1024
 #max_concurrent_requests = 100 # How many requests Conduit sends to other servers at the same time
 #log = "info,state_res=warn,rocket=off,_=off,sled=off"
 #workers = 4 # default: cpu core count * 2
@@ -43,3 +42,24 @@ trusted_servers = ["matrix.org"]
 address = "127.0.0.1" # This makes sure Conduit can only be reached using the reverse proxy
 
 proxy = "none" # more examples can be found at src/database/proxy.rs:6
+
+## sqlite
+
+# The amount of memory that the database will use, with the following formula;
+# (db_cache_capacity * (sqlite_read_pool_size + 1)), in bytes
+#db_cache_capacity = 1073741824 # in bytes, 1024 * 1024 * 1024
+
+# How many permanent read connections will be open to the database,
+# increase this if you see "creating spillover reader" in your logs.
+#sqlite_read_pool_size = 2 # default: max(cpu core count, 1)
+
+# If the database WAL (conduit.db-wal file) should be cleaned on a timer.
+#sqlite_wal_clean_timer = false
+
+# How many seconds should pass before the WAL clean task should fire.
+# Note: Is dependant on sqlite_wal_clean_timer being true.
+#sqlite_wal_clean_second_interval = 60
+
+# How long the WAL clean task should (in seconds) try to wait while
+# getting exclusive access to the database (before giving up).
+#sqlite_wal_clean_second_timeout = 2

debian/postinst

@@ -73,10 +73,30 @@ max_request_size = 20_000_000 # in bytes
 # Enable jaeger to support monitoring and troubleshooting through jaeger.
 #allow_jaeger = false
 
-#db_cache_capacity = 1073741824 # in bytes, 1024 * 1024 * 1024
 #max_concurrent_requests = 100 # How many requests Conduit sends to other servers at the same time
 #log = "info,state_res=warn,rocket=off,_=off,sled=off"
 #workers = 4 # default: cpu core count * 2
+
+## sqlite
+
+# The amount of memory that the database will use, with the following formula;
+# (db_cache_capacity * (sqlite_read_pool_size + 1)), in bytes
+#db_cache_capacity = 1073741824 # in bytes, 1024 * 1024 * 1024
+
+# How many permanent read connections will be open to the database,
+# increase this if you see "creating spillover reader" in your logs.
+#sqlite_read_pool_size = 2 # default: max(cpu core count, 1)
+
+# If the database WAL (conduit.db-wal file) should be cleaned on a timer.
+#sqlite_wal_clean_timer = false
+
+# How many seconds should pass before the WAL clean task should fire.
+# Note: Is dependant on sqlite_wal_clean_timer being true.
+#sqlite_wal_clean_second_interval = 60
+
+# How long the WAL clean task should (in seconds) try to wait while
+# getting exclusive access to the database (before giving up).
+#sqlite_wal_clean_second_timeout = 2
 EOF
     fi
     ;;