Make env files more readable.

.env.docker

@@ -1,12 +1,24 @@
+# You can leave this on "local". If you change it to production most console commands will ask for extra confirmation.
+# Never set it to "testing".
 APP_ENV=${FF_APP_ENV}
+
+# Set to true if you want to see debug information in error screens.
 APP_DEBUG=false
-APP_NAME=FireflyIII
+
+# This should be your email address
+SITE_OWNER=mail@example.com
+
+# The encryption key for your database and sessions. Keep this very secure.
+# If you generate a new one all existing data must be considered LOST.
+# Change it to a string of exactly 32 chars or use command `php artisan key:generate` to generate it
 APP_KEY=${FF_APP_KEY}
-APP_LOG=daily
+
-APP_LOG_LEVEL=warning
+# APP_URL and TRUSTED_PROXIES are useful when using Docker and/or a reverse proxy.
 APP_URL=${APP_URL}
 TRUSTED_PROXIES=${TRUSTED_PROXIES}
 
+# Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
+# If you use SQLite, set connection to `sqlite` and remove the database, username and password settings.
 DB_CONNECTION=mysql
 DB_HOST=${FF_DB_HOST}
 DB_PORT=3306
@@ -14,19 +26,27 @@ DB_DATABASE=${FF_DB_NAME}
 DB_USERNAME=${FF_DB_USER}
 DB_PASSWORD=${FF_DB_PASSWORD}
 
-BROADCAST_DRIVER=log
+# 'daily' is the default logging mode giving you 5 daily rotated log files in /storage/logs/.
+# Several other options exist. You can use 'single' for one big fat error log (not recommended).
+# Also available are 'syslog' and 'errorlog' which will log to the system itself.
+APP_LOG=daily
+
+# Log level. You can set this from least severe to most severe:
+# debug, info, notice, warning, error, critical, alert, emergency
+# If you set it to debug your logs will grow large, and fast. If you set it to emergency probably
+# nothing will get logged, ever.
+APP_LOG_LEVEL=warning
+
+# If you're looking for performance improvements, you could install memcached.
 CACHE_DRIVER=file
 SESSION_DRIVER=file
-QUEUE_DRIVER=sync
 
+# Cookie settings. Should not be necessary to change these.
 COOKIE_PATH="/"
 COOKIE_DOMAIN=
 COOKIE_SECURE=false
 
-REDIS_HOST=127.0.0.1
+# If you want Firefly III to mail you, update these settings
-REDIS_PASSWORD=null
-REDIS_PORT=6379
-
 MAIL_DRIVER=smtp
 MAIL_HOST=smtp.mailtrap.io
 MAIL_PORT=2525
@@ -35,26 +55,36 @@ MAIL_USERNAME=null
 MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
 
+# Firefly III can send you the following messages
 SEND_REGISTRATION_MAIL=true
 SEND_ERROR_MESSAGE=true
 
-CACHE_PREFIX=firefly
+# Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
-
-SEARCH_RESULT_LIMIT=50
-EXCHANGE_RATE_SERVICE=fixerio
-
 MAPBOX_API_KEY=
+
+# If you wish to track your own behavior over Firefly III, set a valid analytics tracker ID here.
 ANALYTICS_ID=
-SITE_OWNER=mail@example.com
+
+# Most parts of the database are encrypted by default, but you can turn this off if you want to.
+# This makes it easier to migrate your database. Not that some fields will never be decrypted.
 USE_ENCRYPTION=true
 
+# Leave the following configuration vars as is.
+# Unless you like to tinker and know what you're doing.
+APP_NAME=FireflyIII
+BROADCAST_DRIVER=log
+QUEUE_DRIVER=sync
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+CACHE_PREFIX=firefly
+SEARCH_RESULT_LIMIT=50
+EXCHANGE_RATE_SERVICE=fixerio
 PUSHER_KEY=
 PUSHER_SECRET=
 PUSHER_ID=
-
 DEMO_USERNAME=
 DEMO_PASSWORD=
-
 IS_DOCKER=true
 IS_SANDSTORM=false
 IS_HEROKU=false

.env.example

@@ -1,12 +1,24 @@
+# You can leave this on "local". If you change it to production most console commands will ask for extra confirmation.
+# Never set it to "testing".
 APP_ENV=local
+
+# Set to true if you want to see debug information in error screens.
 APP_DEBUG=false
-APP_NAME=FireflyIII
+
+# This should be your email address
+SITE_OWNER=mail@example.com
+
+# The encryption key for your database and sessions. Keep this very secure.
+# If you generate a new one all existing data must be considered LOST.
+# Change it to a string of exactly 32 chars or use command `php artisan key:generate` to generate it
 APP_KEY=SomeRandomStringOf32CharsExactly
-APP_LOG=daily
+
-APP_LOG_LEVEL=notice
+# APP_URL and TRUSTED_PROXIES are useful when using Docker and/or a reverse proxy.
 APP_URL=http://localhost
 TRUSTED_PROXIES=
 
+# Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
+# If you use SQLite, set connection to `sqlite` and remove the database, username and password settings.
 DB_CONNECTION=mysql
 DB_HOST=127.0.0.1
 DB_PORT=3306
@@ -14,19 +26,27 @@ DB_DATABASE=homestead
 DB_USERNAME=homestead
 DB_PASSWORD=secret
 
-BROADCAST_DRIVER=log
+# 'daily' is the default logging mode giving you 5 daily rotated log files in /storage/logs/.
+# Several other options exist. You can use 'single' for one big fat error log (not recommended).
+# Also available are 'syslog' and 'errorlog' which will log to the system itself.
+APP_LOG=daily
+
+# Log level. You can set this from least severe to most severe:
+# debug, info, notice, warning, error, critical, alert, emergency
+# If you set it to debug your logs will grow large, and fast. If you set it to emergency probably
+# nothing will get logged, ever.
+APP_LOG_LEVEL=notice
+
+# If you're looking for performance improvements, you could install memcached.
 CACHE_DRIVER=file
 SESSION_DRIVER=file
-QUEUE_DRIVER=sync
 
+# Cookie settings. Should not be necessary to change these.
 COOKIE_PATH="/"
 COOKIE_DOMAIN=
 COOKIE_SECURE=false
 
-REDIS_HOST=127.0.0.1
+# If you want Firefly III to mail you, update these settings
-REDIS_PASSWORD=null
-REDIS_PORT=6379
-
 MAIL_DRIVER=smtp
 MAIL_HOST=smtp.mailtrap.io
 MAIL_PORT=2525
@@ -35,26 +55,36 @@ MAIL_USERNAME=null
 MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
 
+# Firefly III can send you the following messages
 SEND_REGISTRATION_MAIL=true
 SEND_ERROR_MESSAGE=true
 
-CACHE_PREFIX=firefly
+# Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
-
-SEARCH_RESULT_LIMIT=50
-EXCHANGE_RATE_SERVICE=fixerio
-
 MAPBOX_API_KEY=
+
+# If you wish to track your own behavior over Firefly III, set a valid analytics tracker ID here.
 ANALYTICS_ID=
-SITE_OWNER=mail@example.com
+
+# Most parts of the database are encrypted by default, but you can turn this off if you want to.
+# This makes it easier to migrate your database. Not that some fields will never be decrypted.
 USE_ENCRYPTION=true
 
+# Leave the following configuration vars as is.
+# Unless you like to tinker and know what you're doing.
+APP_NAME=FireflyIII
+BROADCAST_DRIVER=log
+QUEUE_DRIVER=sync
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+CACHE_PREFIX=firefly
+SEARCH_RESULT_LIMIT=50
+EXCHANGE_RATE_SERVICE=fixerio
 PUSHER_KEY=
 PUSHER_SECRET=
 PUSHER_ID=
-
 DEMO_USERNAME=
 DEMO_PASSWORD=
-
 IS_DOCKER=false
 IS_SANDSTORM=false
 IS_HEROKU=false

.env.heroku

@@ -1,12 +1,24 @@
+# You can leave this on "local". If you change it to production most console commands will ask for extra confirmation.
+# Never set it to "testing".
 APP_ENV=heroku
-APP_DEBUG=true
-APP_NAME=FireflyIII
-APP_KEY=7ahyYVPVsmxjdhsweWCauGeJfwc92NP2
-APP_LOG=errorlog
-APP_LOG_LEVEL=debug
-APP_URL=http://localhost
-TRUSTED_PROXIES=*
 
+# Set to true if you want to see debug information in error screens.
+APP_DEBUG=false
+
+# This should be your email address
+SITE_OWNER=heroku@example.com
+
+# The encryption key for your database and sessions. Keep this very secure.
+# If you generate a new one all existing data must be considered LOST.
+# Change it to a string of exactly 32 chars or use command `php artisan key:generate` to generate it
+APP_KEY=7ahyYVPVsmxjdhsweWCauGeJfwc92NP2
+
+# APP_URL and TRUSTED_PROXIES are useful when using Docker and/or a reverse proxy.
+APP_URL=http://localhost
+TRUSTED_PROXIES=
+
+# Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
+# If you use SQLite, set connection to `sqlite` and remove the database, username and password settings.
 DB_CONNECTION=pgsql
 
 
@@ -14,19 +26,27 @@ DB_CONNECTION=pgsql
 
 
 
-BROADCAST_DRIVER=log
+# 'daily' is the default logging mode giving you 5 daily rotated log files in /storage/logs/.
+# Several other options exist. You can use 'single' for one big fat error log (not recommended).
+# Also available are 'syslog' and 'errorlog' which will log to the system itself.
+APP_LOG=errorlog
+
+# Log level. You can set this from least severe to most severe:
+# debug, info, notice, warning, error, critical, alert, emergency
+# If you set it to debug your logs will grow large, and fast. If you set it to emergency probably
+# nothing will get logged, ever.
+APP_LOG_LEVEL=debug
+
+# If you're looking for performance improvements, you could install memcached.
 CACHE_DRIVER=file
 SESSION_DRIVER=file
-QUEUE_DRIVER=sync
 
+# Cookie settings. Should not be necessary to change these.
 COOKIE_PATH="/"
 COOKIE_DOMAIN=
 COOKIE_SECURE=false
 
-REDIS_HOST=127.0.0.1
+# If you want Firefly III to mail you, update these settings
-REDIS_PASSWORD=null
-REDIS_PORT=6379
-
 MAIL_DRIVER=smtp
 MAIL_HOST=smtp.mailtrap.io
 MAIL_PORT=2525
@@ -35,26 +55,36 @@ MAIL_USERNAME=null
 MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
 
+# Firefly III can send you the following messages
 SEND_REGISTRATION_MAIL=true
 SEND_ERROR_MESSAGE=true
 
-CACHE_PREFIX=firefly
+# Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
-
-SEARCH_RESULT_LIMIT=50
-EXCHANGE_RATE_SERVICE=fixerio
-
 MAPBOX_API_KEY=
+
+# If you wish to track your own behavior over Firefly III, set a valid analytics tracker ID here.
 ANALYTICS_ID=
-SITE_OWNER=heroku@example.com
+
+# Most parts of the database are encrypted by default, but you can turn this off if you want to.
+# This makes it easier to migrate your database. Not that some fields will never be decrypted.
 USE_ENCRYPTION=true
 
+# Leave the following configuration vars as is.
+# Unless you like to tinker and know what you're doing.
+APP_NAME=FireflyIII
+BROADCAST_DRIVER=log
+QUEUE_DRIVER=sync
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+CACHE_PREFIX=firefly
+SEARCH_RESULT_LIMIT=50
+EXCHANGE_RATE_SERVICE=fixerio
 PUSHER_KEY=
 PUSHER_SECRET=
 PUSHER_ID=
-
 DEMO_USERNAME=
 DEMO_PASSWORD=
-
 IS_DOCKER=false
 IS_SANDSTORM=false
 IS_HEROKU=true

.env.sandstorm

@@ -1,12 +1,24 @@
+# You can leave this on "local". If you change it to production most console commands will ask for extra confirmation.
+# Never set it to "testing".
 APP_ENV=local
+
+# Set to true if you want to see debug information in error screens.
 APP_DEBUG=false
-APP_NAME=FireflyIII
+
+# This should be your email address
+SITE_OWNER=sandstorm@example.com
+
+# The encryption key for your database and sessions. Keep this very secure.
+# If you generate a new one all existing data must be considered LOST.
+# Change it to a string of exactly 32 chars or use command `php artisan key:generate` to generate it
 APP_KEY=SomeRandomStringOf32CharsExactly
-APP_LOG=syslog
+
-APP_LOG_LEVEL=info
+# APP_URL and TRUSTED_PROXIES are useful when using Docker and/or a reverse proxy.
 APP_URL=http://localhost
 TRUSTED_PROXIES=
 
+# Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
+# If you use SQLite, set connection to `sqlite` and remove the database, username and password settings.
 DB_CONNECTION=mysql
 DB_HOST=127.0.0.1
 DB_PORT=3306
@@ -14,19 +26,27 @@ DB_DATABASE=firefly
 DB_USERNAME=firefly
 DB_PASSWORD=firefly
 
-BROADCAST_DRIVER=log
+# 'daily' is the default logging mode giving you 5 daily rotated log files in /storage/logs/.
+# Several other options exist. You can use 'single' for one big fat error log (not recommended).
+# Also available are 'syslog' and 'errorlog' which will log to the system itself.
+APP_LOG=syslog
+
+# Log level. You can set this from least severe to most severe:
+# debug, info, notice, warning, error, critical, alert, emergency
+# If you set it to debug your logs will grow large, and fast. If you set it to emergency probably
+# nothing will get logged, ever.
+APP_LOG_LEVEL=info
+
+# If you're looking for performance improvements, you could install memcached.
 CACHE_DRIVER=file
 SESSION_DRIVER=file
-QUEUE_DRIVER=sync
 
+# Cookie settings. Should not be necessary to change these.
 COOKIE_PATH="/"
 COOKIE_DOMAIN=
 COOKIE_SECURE=false
 
-REDIS_HOST=127.0.0.1
+# If you want Firefly III to mail you, update these settings
-REDIS_PASSWORD=null
-REDIS_PORT=6379
-
 MAIL_DRIVER=smtp
 MAIL_HOST=smtp.mailtrap.io
 MAIL_PORT=2525
@@ -35,26 +55,36 @@ MAIL_USERNAME=null
 MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
 
+# Firefly III can send you the following messages
 SEND_REGISTRATION_MAIL=true
 SEND_ERROR_MESSAGE=true
 
-CACHE_PREFIX=firefly
+# Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
-
-SEARCH_RESULT_LIMIT=50
-EXCHANGE_RATE_SERVICE=fixerio
-
 MAPBOX_API_KEY=
+
+# If you wish to track your own behavior over Firefly III, set a valid analytics tracker ID here.
 ANALYTICS_ID=
-SITE_OWNER=mail@example.com
+
+# Most parts of the database are encrypted by default, but you can turn this off if you want to.
+# This makes it easier to migrate your database. Not that some fields will never be decrypted.
 USE_ENCRYPTION=true
 
+# Leave the following configuration vars as is.
+# Unless you like to tinker and know what you're doing.
+APP_NAME=FireflyIII
+BROADCAST_DRIVER=log
+QUEUE_DRIVER=sync
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+CACHE_PREFIX=firefly
+SEARCH_RESULT_LIMIT=50
+EXCHANGE_RATE_SERVICE=fixerio
 PUSHER_KEY=
 PUSHER_SECRET=
 PUSHER_ID=
-
 DEMO_USERNAME=
 DEMO_PASSWORD=
-
 IS_DOCKER=false
 IS_SANDSTORM=true
 IS_HEROKU=false