firefly-iii/.env.example

185 lines
5.8 KiB
Plaintext
Raw Normal View History

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".
APP_ENV=local
2018-01-10 07:37:40 -06:00
# Set to true if you want to see debug information in error screens.
2015-04-20 11:06:21 -05:00
APP_DEBUG=false
2018-01-10 07:37:40 -06:00
# This should be your email address
SITE_OWNER=mail@example.com
2019-07-31 09:53:09 -05:00
# The encryption key for your sessions. Keep this very secure.
# If you generate a new one existing data must be considered LOST.
2018-01-10 07:37:40 -06:00
# Change it to a string of exactly 32 chars or use command `php artisan key:generate` to generate it
2015-08-13 10:34:08 -05:00
APP_KEY=SomeRandomStringOf32CharsExactly
2018-01-10 07:37:40 -06:00
2018-03-05 12:39:41 -06:00
# Change this value to your preferred time zone.
# Example: Europe/Amsterdam
TZ=Europe/Amsterdam
2018-03-05 12:39:41 -06: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.
2016-09-15 23:19:40 -05:00
APP_URL=http://localhost
2018-08-24 00:17:50 -05:00
# TRUSTED_PROXIES is a useful variable when using Docker and/or a reverse proxy.
2019-08-04 01:01:13 -05:00
# Set it to ** and reverse proxies work just fine.
2017-10-02 11:20:03 -05:00
TRUSTED_PROXIES=
2015-12-24 01:35:08 -06:00
2018-03-07 13:47:39 -06:00
# The log channel defines where your log entries go to.
2018-08-17 13:01:46 -05: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).
# Also available are 'syslog', 'errorlog' and 'stdout' which will log to the system itself.
2018-03-07 13:47:39 -06:00
LOG_CHANNEL=daily
2018-08-17 13:01:46 -05: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.
APP_LOG_LEVEL=notice
2018-01-10 07:37:40 -06:00
# Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
2018-03-19 09:44:08 -05:00
# For other database types, please see the FAQ: http://firefly-iii.readthedocs.io/en/latest/support/faq.html
2015-02-07 03:24:54 -06:00
DB_CONNECTION=mysql
2016-09-15 23:19:40 -05:00
DB_HOST=127.0.0.1
DB_PORT=3306
2015-02-05 21:39:52 -06:00
DB_DATABASE=homestead
DB_USERNAME=homestead
DB_PASSWORD=secret
2019-03-02 07:33:46 -06:00
# PostgreSQL supports SSL. You can configure it here.
PGSQL_SSL_MODE=prefer
PGSQL_SSL_ROOT_CERT=null
PGSQL_SSL_CERT=null
PGSQL_SSL_KEY=null
PGSQL_SSL_CRL_FILE=null
2018-01-10 07:37:40 -06:00
# If you're looking for performance improvements, you could install memcached.
2015-02-05 21:39:52 -06:00
CACHE_DRIVER=file
SESSION_DRIVER=file
2015-02-14 09:13:28 -06:00
2018-10-14 01:53:00 -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_PORT=
SFTP_UPLOAD_PATH=
SFTP_EXPORT_PATH=
# SFTP uses either the username/password combination or the private key to authenticate.
SFTP_USERNAME=
SFTP_PASSWORD=
SFTP_PRIV_KEY=
2018-01-10 07:37:40 -06:00
# Cookie settings. Should not be necessary to change these.
2016-03-22 09:04:51 -05: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-04-24 12:23:32 -05:00
MAIL_DRIVER=log
2017-09-10 01:39:00 -05:00
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_FROM=changeme@example.com
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
2015-12-20 00:34:01 -06:00
2018-06-16 00:23:54 -05:00
# Other mail drivers:
MAILGUN_DOMAIN=
MAILGUN_SECRET=
MANDRILL_SECRET=
SPARKPOST_SECRET=
2018-01-10 07:37:40 -06:00
# Firefly III can send you the following messages
SEND_REGISTRATION_MAIL=true
SEND_ERROR_MESSAGE=true
2016-12-26 03:00:40 -06:00
2018-10-13 06:19:41 -05:00
# These messages contain (sensitive) transaction information:
SEND_REPORT_JOURNALS=true
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.
MAPBOX_API_KEY=
2018-01-10 07:37:40 -06:00
# Firefly III currently supports two provider for live Currency Exchange Rates:
2019-08-05 10:07:19 -05:00
# "fixer", and "ratesapi".
# RatesApi.IO (see https://ratesapi.io) is a FREE and OPEN SOURCE live currency exchange rates,
2019-07-31 09:53:09 -05:00
# built compatible with Fixer.IO, based on data published by European Central Bank, and doesn't require API key.
CER_PROVIDER=ratesapi
2019-08-04 01:01:13 -05:00
# 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=
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.
2015-12-20 00:34:01 -06:00
ANALYTICS_ID=
2018-01-10 07:37:40 -06:00
2018-10-13 08:06:56 -05:00
# Firefly III has two options for user authentication. "eloquent" is the default,
2019-02-15 00:22:51 -06:00
# and "ldap" for LDAP servers.
2018-10-13 08:06:56 -05:00
# For full instructions on these settings please visit:
# https://firefly-iii.readthedocs.io/en/latest/installation/authentication.html
LOGIN_PROVIDER=eloquent
# LDAP connection configuration
2018-10-21 04:07:19 -05:00
# OpenLDAP, FreeIPA or ActiveDirectory
ADLDAP_CONNECTION_SCHEME=OpenLDAP
2018-10-13 08:06:56 -05:00
ADLDAP_AUTO_CONNECT=true
# LDAP connection settings
ADLDAP_CONTROLLERS=
ADLDAP_PORT=389
ADLDAP_TIMEOUT=5
ADLDAP_BASEDN=""
ADLDAP_FOLLOW_REFFERALS=false
ADLDAP_USE_SSL=false
ADLDAP_USE_TLS=false
ADLDAP_ADMIN_USERNAME=
ADLDAP_ADMIN_PASSWORD=
ADLDAP_ACCOUNT_PREFIX=
ADLDAP_ACCOUNT_SUFFIX=
# LDAP authentication settings.
ADLDAP_PASSWORD_SYNC=false
ADLDAP_LOGIN_FALLBACK=false
ADLDAP_DISCOVER_FIELD=distinguishedname
ADLDAP_AUTH_FIELD=distinguishedname
# Will allow SSO if your server provides an AUTH_USER field.
WINDOWS_SSO_DISCOVER=samaccountname
WINDOWS_SSO_KEY=AUTH_USER
# field to sync as local username.
2018-10-21 04:07:19 -05:00
ADLDAP_SYNC_FIELD=userprincipalname
2018-10-13 08:06:56 -05: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=false
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-13 08:06:56 -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
2016-09-15 23:19:40 -05:00
PUSHER_KEY=
PUSHER_SECRET=
2017-09-10 01:39:00 -05:00
PUSHER_ID=
2016-12-26 02:18:45 -06:00
DEMO_USERNAME=
2017-01-02 08:22:30 -06:00
DEMO_PASSWORD=
2017-11-08 00:54:42 -06:00
IS_DOCKER=false
2019-05-05 09:16:03 -05:00
USE_ENCRYPTION=false
2017-11-08 01:23:58 -06:00
IS_SANDSTORM=false
2017-12-01 11:43:37 -06:00
IS_HEROKU=false
2018-08-17 13:01:46 -05:00
BUNQ_USE_SANDBOX=false
2018-11-17 01:28:04 -06:00
FFIII_LAYOUT=v1