2018-01-10 07:37:40 -06:00
|
|
|
# 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".
|
2017-02-10 21:33:20 -06:00
|
|
|
APP_ENV=${FF_APP_ENV}
|
2018-01-10 07:37:40 -06:00
|
|
|
|
|
|
|
# Set to true if you want to see debug information in error screens.
|
2018-02-25 10:39:09 -06:00
|
|
|
APP_DEBUG=${APP_DEBUG}
|
2018-01-10 07:37:40 -06:00
|
|
|
|
|
|
|
# This should be your email address
|
2018-02-25 10:39:09 -06:00
|
|
|
SITE_OWNER=${SITE_OWNER}
|
2018-01-10 07:37:40 -06:00
|
|
|
|
|
|
|
# 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
|
2017-02-10 21:33:20 -06:00
|
|
|
APP_KEY=${FF_APP_KEY}
|
2018-01-10 07:37:40 -06:00
|
|
|
|
2018-08-17 13:01:46 -05:00
|
|
|
# Change this value to your preferred time zone.
|
|
|
|
# Example: Europe/Amsterdam
|
2018-09-03 01:40:22 -05:00
|
|
|
TZ=${TZ}
|
2018-08-17 13:01:46 -05:00
|
|
|
|
2018-08-24 00:17:50 -05:00
|
|
|
# This variable must match your installation's external address but keep in mind that
|
|
|
|
# it's only used on the command line as a fallback value.
|
2018-01-10 06:15:12 -06:00
|
|
|
APP_URL=${APP_URL}
|
2018-08-24 00:17:50 -05:00
|
|
|
|
|
|
|
# TRUSTED_PROXIES is a useful variable when using Docker and/or a reverse proxy.
|
2018-01-10 06:15:12 -06:00
|
|
|
TRUSTED_PROXIES=${TRUSTED_PROXIES}
|
2017-02-10 21:33:20 -06:00
|
|
|
|
2018-03-07 13:47:39 -06:00
|
|
|
# The log channel defines where your log entries go to.
|
2018-01-10 07:37:40 -06:00
|
|
|
# '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).
|
2018-08-17 13:01:46 -05:00
|
|
|
# Also available are 'syslog', 'errorlog' and 'stdout' which will log to the system itself.
|
|
|
|
LOG_CHANNEL=stdout
|
2018-01-10 07:37:40 -06:00
|
|
|
|
|
|
|
# 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.
|
2018-08-17 14:51:15 -05:00
|
|
|
APP_LOG_LEVEL=${APP_LOG_LEVEL}
|
2018-08-17 13:01:46 -05:00
|
|
|
|
|
|
|
# Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
|
|
|
|
# For other database types, please see the FAQ: http://firefly-iii.readthedocs.io/en/latest/support/faq.html
|
2018-08-17 14:12:26 -05:00
|
|
|
DB_CONNECTION=${FF_DB_CONNECTION}
|
|
|
|
DB_HOST=${FF_DB_HOST}
|
|
|
|
DB_PORT=${FF_DB_PORT}
|
|
|
|
DB_DATABASE=${FF_DB_NAME}
|
|
|
|
DB_USERNAME=${FF_DB_USER}
|
2018-10-14 02:05:02 -05:00
|
|
|
DB_PASSWORD="${FF_DB_PASSWORD}"
|
2018-01-10 07:37:40 -06:00
|
|
|
|
|
|
|
# If you're looking for performance improvements, you could install memcached.
|
2017-02-10 21:33:20 -06:00
|
|
|
CACHE_DRIVER=file
|
|
|
|
SESSION_DRIVER=file
|
|
|
|
|
2018-10-14 02:05:02 -05:00
|
|
|
# You can configure another file storage backend if you cannot use the local storage option.
|
|
|
|
# To set this up, fill in the following variables. The upload path is used to store uploaded
|
|
|
|
# files and the export path is to store exported data (before download).
|
|
|
|
SFTP_HOST=${SFTP_HOST}
|
|
|
|
SFTP_PORT=${SFTP_PORT}
|
|
|
|
SFTP_UPLOAD_PATH=${SFTP_UPLOAD_PATH}
|
|
|
|
SFTP_EXPORT_PATH=${SFTP_EXPORT_PATH}
|
|
|
|
|
|
|
|
# SFTP uses either the username/password combination or the private key to authenticate.
|
|
|
|
SFTP_USERNAME=${SFTP_USERNAME}
|
|
|
|
SFTP_PASSWORD="${SFTP_PASSWORD}"
|
|
|
|
SFTP_PRIV_KEY=${SFTP_PRIV_KEY}
|
|
|
|
|
2018-01-10 07:37:40 -06:00
|
|
|
# Cookie settings. Should not be necessary to change these.
|
2017-02-10 21:33:20 -06:00
|
|
|
COOKIE_PATH="/"
|
|
|
|
COOKIE_DOMAIN=
|
|
|
|
COOKIE_SECURE=false
|
|
|
|
|
2018-01-10 07:37:40 -06:00
|
|
|
# If you want Firefly III to mail you, update these settings
|
2018-06-16 00:23:54 -05:00
|
|
|
# For instructions, see: https://firefly-iii.readthedocs.io/en/latest/installation/mail.html
|
2018-02-25 10:39:09 -06:00
|
|
|
MAIL_DRIVER=${MAIL_DRIVER}
|
|
|
|
MAIL_HOST=${MAIL_HOST}
|
|
|
|
MAIL_PORT=${MAIL_PORT}
|
|
|
|
MAIL_FROM=${MAIL_FROM}
|
|
|
|
MAIL_USERNAME=${MAIL_USERNAME}
|
2018-10-14 02:05:02 -05:00
|
|
|
MAIL_PASSWORD="${MAIL_PASSWORD}"
|
2018-02-25 10:39:09 -06:00
|
|
|
MAIL_ENCRYPTION=${MAIL_ENCRYPTION}
|
2017-02-10 21:33:20 -06:00
|
|
|
|
2018-06-16 00:23:54 -05:00
|
|
|
# Other mail drivers:
|
|
|
|
MAILGUN_DOMAIN=${MAILGUN_DOMAIN}
|
|
|
|
MAILGUN_SECRET=${MAILGUN_SECRET}
|
|
|
|
MANDRILL_SECRET=${MANDRILL_SECRET}
|
|
|
|
SPARKPOST_SECRET=${SPARKPOST_SECRET}
|
|
|
|
|
2018-01-10 07:37:40 -06:00
|
|
|
# Firefly III can send you the following messages
|
2017-02-10 21:33:20 -06:00
|
|
|
SEND_REGISTRATION_MAIL=true
|
2018-02-25 10:39:09 -06:00
|
|
|
SEND_ERROR_MESSAGE=false
|
2017-02-10 21:33:20 -06:00
|
|
|
|
2018-10-13 06:19:41 -05:00
|
|
|
# These messages contain (sensitive) transaction information:
|
|
|
|
SEND_REPORT_JOURNALS=${SEND_REPORT_JOURNALS}
|
|
|
|
|
2018-01-10 07:37:40 -06:00
|
|
|
# Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
|
2018-02-25 10:39:09 -06:00
|
|
|
MAPBOX_API_KEY=${MAPBOX_API_KEY}
|
2018-01-10 07:37:40 -06:00
|
|
|
|
2019-01-01 09:32:22 -06:00
|
|
|
# Firefly III currently supports two provider for live Currency Exchange Rates:
|
|
|
|
# "fixer" is the default (for backward compatibility), and "ratesapi" is the new one.
|
|
|
|
# RatesApi.IO (see https://ratesapi.io) is a FREE and OPEN SOURCE live currency exchange rates,
|
|
|
|
# built compatible with Fixer.IO, based on data published by European Central Bank, and don't require API key.
|
|
|
|
CER_PROVIDER=${CER_PROVIDER}
|
|
|
|
# If you have select "fixer" as default currency exchange rates,
|
|
|
|
# set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
|
|
|
|
# Please note that this WILL ONLY WORK FOR PAID fixer.io accounts because they severely limited
|
2018-03-30 00:00:20 -05:00
|
|
|
# the free API up to the point where you might as well offer nothing.
|
2018-03-25 02:00:45 -05:00
|
|
|
FIXER_API_KEY=${FIXER_API_KEY}
|
|
|
|
|
2018-01-10 07:37:40 -06:00
|
|
|
# If you wish to track your own behavior over Firefly III, set a valid analytics tracker ID here.
|
2018-02-25 10:39:09 -06:00
|
|
|
ANALYTICS_ID=${ANALYTICS_ID}
|
2018-01-10 07:37:40 -06:00
|
|
|
|
|
|
|
# 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.
|
2017-02-10 21:33:20 -06:00
|
|
|
USE_ENCRYPTION=true
|
|
|
|
|
2018-10-14 02:05:02 -05:00
|
|
|
# Firefly III has two options for user authentication. "eloquent" is the default,
|
|
|
|
# and "adldap" for LDAP servers.
|
|
|
|
# For full instructions on these settings please visit:
|
|
|
|
# https://firefly-iii.readthedocs.io/en/latest/installation/authentication.html
|
|
|
|
LOGIN_PROVIDER=${LOGIN_PROVIDER}
|
|
|
|
|
|
|
|
# LDAP connection configuration
|
|
|
|
ADLDAP_CONNECTION_SCHEME=${ADLDAP_CONNECTION_SCHEME}
|
|
|
|
ADLDAP_AUTO_CONNECT=${ADLDAP_AUTO_CONNECT}
|
|
|
|
|
|
|
|
# LDAP connection settings
|
|
|
|
ADLDAP_CONTROLLERS=${ADLDAP_CONTROLLERS}
|
|
|
|
ADLDAP_PORT=${ADLDAP_PORT}
|
|
|
|
ADLDAP_TIMEOUT=${ADLDAP_TIMEOUT}
|
|
|
|
ADLDAP_BASEDN="${ADLDAP_BASEDN}"
|
|
|
|
ADLDAP_FOLLOW_REFFERALS=${ADLDAP_FOLLOW_REFFERALS}
|
|
|
|
ADLDAP_USE_SSL=${ADLDAP_USE_SSL}
|
|
|
|
ADLDAP_USE_TLS=${ADLDAP_USE_TLS}
|
|
|
|
|
|
|
|
ADLDAP_ADMIN_USERNAME=${ADLDAP_ADMIN_USERNAME}
|
|
|
|
ADLDAP_ADMIN_PASSWORD="${ADLDAP_ADMIN_PASSWORD}"
|
|
|
|
|
|
|
|
ADLDAP_ACCOUNT_PREFIX="${ADLDAP_ACCOUNT_PREFIX}"
|
|
|
|
ADLDAP_ACCOUNT_SUFFIX="${ADLDAP_ACCOUNT_SUFFIX}"
|
|
|
|
ADLDAP_ADMIN_ACCOUNT_PREFIX="${ADLDAP_ADMIN_ACCOUNT_PREFIX}"
|
|
|
|
ADLDAP_ADMIN_ACCOUNT_SUFFIX="${ADLDAP_ADMIN_ACCOUNT_SUFFIX}"
|
|
|
|
|
|
|
|
# LDAP authentication settings.
|
|
|
|
ADLDAP_PASSWORD_SYNC=${ADLDAP_PASSWORD_SYNC}
|
|
|
|
ADLDAP_LOGIN_FALLBACK=${ADLDAP_LOGIN_FALLBACK}
|
|
|
|
|
|
|
|
ADLDAP_DISCOVER_FIELD=${ADLDAP_DISCOVER_FIELD}
|
|
|
|
ADLDAP_AUTH_FIELD=${ADLDAP_AUTH_FIELD}
|
|
|
|
|
|
|
|
# Will allow SSO if your server provides an AUTH_USER field.
|
|
|
|
WINDOWS_SSO_DISCOVER=${WINDOWS_SSO_DISCOVER}
|
|
|
|
WINDOWS_SSO_KEY=${WINDOWS_SSO_KEY}
|
|
|
|
|
|
|
|
# field to sync as local username.
|
|
|
|
ADLDAP_SYNC_FIELD=${ADLDAP_SYNC_FIELD}
|
|
|
|
|
2018-11-24 00:24:32 -06:00
|
|
|
# You can disable the X-Frame-Options header if it interfears with tools like
|
|
|
|
# Organizr. This is at your own risk.
|
|
|
|
DISABLE_FRAME_HEADER=${DISABLE_FRAME_HEADER}
|
|
|
|
|
2018-01-10 07:37:40 -06:00
|
|
|
# Leave the following configuration vars as is.
|
|
|
|
# Unless you like to tinker and know what you're doing.
|
|
|
|
APP_NAME=FireflyIII
|
2018-10-14 02:05:02 -05:00
|
|
|
ADLDAP_CONNECTION=default
|
2018-01-10 07:37:40 -06:00
|
|
|
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
|
2017-02-10 21:33:20 -06:00
|
|
|
PUSHER_KEY=
|
|
|
|
PUSHER_SECRET=
|
2017-09-10 01:40:02 -05:00
|
|
|
PUSHER_ID=
|
2017-02-10 21:33:20 -06:00
|
|
|
DEMO_USERNAME=
|
|
|
|
DEMO_PASSWORD=
|
2017-11-08 00:54:42 -06:00
|
|
|
IS_DOCKER=true
|
2017-11-08 01:23:58 -06:00
|
|
|
IS_SANDSTORM=false
|
2017-12-01 11:43:37 -06:00
|
|
|
IS_HEROKU=false
|
2018-05-13 08:00:30 -05:00
|
|
|
BUNQ_USE_SANDBOX=false
|
2018-11-17 01:28:04 -06:00
|
|
|
FFIII_LAYOUT=v1
|