diff --git a/packaging/rustbox.toml b/packaging/rustbox.toml index dbc4dc2..02d7b25 100644 --- a/packaging/rustbox.toml +++ b/packaging/rustbox.toml @@ -1,4 +1,4 @@ -# RustBox 0.1.0 - packaged production configuration (DEB/RPM) +# RustBox 0.1.1 - packaged production configuration (DEB/RPM) # # The active values below intentionally keep the existing package profile. # Alternative storage/cluster examples are provided at the end of this file @@ -13,9 +13,9 @@ environment = "production" data_dir = "/var/lib/rustbox" log_dir = "/var/log/rustbox" -# Sessions and "remember me". -# With no database/session backend keys configured, RustBox defaults to -# persistent SQLite sessions under data_dir and survives process restarts. +# Database, sessions and "remember me". +# With no database/session backend keys configured, the whole application uses +# SQLite at data_dir/rustbox.sqlite; sessions are stored in that database. session_timeout_hours = 72 remember_me_enabled = true remember_me_days = 30 @@ -74,21 +74,21 @@ pgp_allow_private_export = true # Copy/uncomment only the keys required by the selected profile. # # session_encryption_key must represent the same 32-byte key on every node that -# shares a SQL/Redis session store. Keep it secret and outside source control. +# shares the configured SQL database or Redis session backend. Keep it secret and outside source control. # ----------------------------------------------------------------------------- -# Profile A: standalone SQLite sessions (default package behavior) +# Profile A: standalone SQLite application database (default package behavior) # ----------------------------------------------------------------------------- # No extra keys are required. The equivalent explicit configuration is: # database_backend = "sqlite" # session_backend = "database" # cluster_mode = false # -# RustBox stores sessions in data_dir/rustbox.sqlite and creates/uses the local -# session encryption key for this single-node SQLite setup. +# RustBox stores account data and sessions in data_dir/rustbox.sqlite and +# creates/uses the local session encryption key for this single-node setup. # ----------------------------------------------------------------------------- -# Profile B: PostgreSQL-backed persistent sessions +# Profile B: PostgreSQL application database (data + database sessions) # ----------------------------------------------------------------------------- # database_backend = "pgsql" # database_url = "postgres://rustbox:change-me@127.0.0.1/rustbox" @@ -97,7 +97,7 @@ pgp_allow_private_export = true # session_encryption_key = "BASE64_32_BYTE_KEY" # ----------------------------------------------------------------------------- -# Profile C: MySQL-backed persistent sessions +# Profile C: MySQL application database (data + database sessions; MySQL 8.0.13+) # ----------------------------------------------------------------------------- # database_backend = "mysql" # database_url = "mysql://rustbox:change-me@127.0.0.1/rustbox" @@ -106,7 +106,7 @@ pgp_allow_private_export = true # session_encryption_key = "BASE64_32_BYTE_KEY" # ----------------------------------------------------------------------------- -# Profile D: Redis sessions, single application node +# Profile D: Redis sessions, single application node (account data stays in database_backend) # ----------------------------------------------------------------------------- # session_backend = "redis" # redis_url = "redis://127.0.0.1:6379/" @@ -119,6 +119,9 @@ pgp_allow_private_export = true # ----------------------------------------------------------------------------- # Profile E: Redis Sentinel sessions for multiple RustBox nodes # ----------------------------------------------------------------------------- +# Cluster nodes must also share the main application database. +# database_backend = "pgsql" +# database_url = "postgres://rustbox:change-me@db.internal/rustbox" # session_backend = "redis" # cluster_mode = true # redis_sentinel_nodes = ["sentinel-a:26379", "sentinel-b:26379", "sentinel-c:26379"] @@ -128,7 +131,7 @@ pgp_allow_private_export = true # session_encryption_key = "BASE64_32_BYTE_KEY" # ----------------------------------------------------------------------------- -# Profile F: PostgreSQL sessions shared by a RustBox application cluster +# Profile F: PostgreSQL application database shared by a RustBox cluster # ----------------------------------------------------------------------------- # database_backend = "pgsql" # database_url = "postgres://rustbox:change-me@db.internal/rustbox" @@ -137,7 +140,7 @@ pgp_allow_private_export = true # session_encryption_key = "BASE64_32_BYTE_KEY" # ----------------------------------------------------------------------------- -# Profile G: MySQL sessions shared by a RustBox application cluster +# Profile G: MySQL application database shared by a RustBox cluster # ----------------------------------------------------------------------------- # database_backend = "mysql" # database_url = "mysql://rustbox:change-me@db.internal/rustbox"