From 1a502417f9c412b3a7ff605c5bf3cfee82ab007b Mon Sep 17 00:00:00 2001
From: Henne Vogelsang <hvogel@opensuse.org>
Date: Wed, 5 Sep 2018 01:51:56 +0200
Subject: [PATCH] Document the DB variables in dotenv.example

---
 dotenv.example | 63 ++++++++++++++++++++++++++++++--------------------
 1 file changed, 38 insertions(+), 25 deletions(-)

diff --git a/dotenv.example b/dotenv.example
index 2f4d1da4..dc4da3b0 100644
--- a/dotenv.example
+++ b/dotenv.example
@@ -1,12 +1,30 @@
-# Set environment variables for OSEM in this file
-# and copy it to .env or .env.rails_environment
-# (like env.production or env.development)
+# Set environment variables for OSEM in this file and copy it to .env or
+# .env.$environment (like env.production or env.development)
 #
-# The following is a list of variables and default
-# values that OSEM uses to configure some aspects
-# of the app
+# The following is a list of variables and default values that OSEM uses to
+# configure some aspects of the app
 
-# The name of your page
+# Your secret key base. You can generate a secure one with
+# bundle exec rake secret
+SECRET_KEY_BASE=''
+
+# The type of database to use (postgresql, mysql2, sqlite3)
+OSEM_DB_ADAPTER=postgresql
+# The name of the host the database runs on
+OSEM_DB_HOST=database
+# The port the databse runs on
+OSEM_DB_PORT=5432
+# The user to access the database with
+OSEM_DB_USER=postgres
+# The password to access the database with
+OSEM_DB_PASSWORD=mysecretpassword
+# The name of the database
+OSEM_DB_NAME=postgres
+
+# The ruby version to use
+OSEM_RUBY_VERSION='2.5.0'
+
+# The name of your OSEM installation
 OSEM_NAME="OSEM"
 
 # The host this OSEM instance runs on. Used for
@@ -16,12 +34,6 @@ OSEM_HOSTNAME="localhost:3000"
 # The address OSEM uses for sending mails
 OSEM_EMAIL_ADDRESS="no-reply@localhost"
 
-# (Optional) The Conference#short_title to redirect the root URL to
-#OSEM_ROOT_CONFERENCE=''
-
-# (Optional) log level in production environment
-OSEM_LOG_LEVEL='info'
-
 # The api key for transifex.com.
 # See TRANSLATION.md for details
 OSEM_TRANSIFEX_APIKEY=""
@@ -52,10 +64,6 @@ OSEM_SUSE_SECRET=''
 STRIPE_PUBLISHABLE_KEY=''
 STRIPE_SECRET_KEY=''
 
-# (OPTIONAL) Skylight keys. See https://www.skylight.io/oss.
-# SKYLIGHT_AUTHENTICATION=''
-# SKYLIGHT_PUBLIC_DASHBOARD_URL='https://oss.skylight.io/app/applications/xxxxxxxxxxxx'
-
 # Disable linting of factories in the test suite.
 # Speeds up turn around times of tests
 OSEM_FACTORY_LINT="false"
@@ -74,16 +82,21 @@ OSEM_SMTP_OPENSSL_VERIFY_MODE=""
 # Enable the usage of the devise ichain plugin
 OSEM_ICHAIN_ENABLED=false
 
-# enable this to force SSL
-# FORCE_SSL="1"
-
 # ReCAPTCHA keys
 RECAPTCHA_SITE_KEY=""
 RECAPTCHA_SECRET_KEY=""
 
-# The url of the redis server
-OSEM_REDIS_URL='redis://localhost:6379/1'
+## Optional settings
+#
+# The Conference#short_title to redirect the root URL to
+# OSEM_ROOT_CONFERENCE=''
 
-# The ruby version you want to use with OSEM
-# Please note: We only test 2.5.0
-OSEM_RUBY_VERSION=2.5.0
+# log level in production environment
+# OSEM_LOG_LEVEL='info'
+
+# enable this to force SSL
+# FORCE_SSL="1"
+
+# Your skylight.io keys
+# SKYLIGHT_AUTHENTICATION=''
+# SKYLIGHT_PUBLIC_DASHBOARD_URL='https://oss.skylight.io/app/applications/xxxxxxxxxxxx'