diff --git a/.env.docker b/.env.docker index 8b96edf6f8..05f2035445 100644 --- a/.env.docker +++ b/.env.docker @@ -66,6 +66,8 @@ SEND_ERROR_MESSAGE=false MAPBOX_API_KEY=${MAPBOX_API_KEY} # 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 severly limited +# the free API up to the point where you might as well offer nothing. FIXER_API_KEY=${FIXER_API_KEY} # If you wish to track your own behavior over Firefly III, set a valid analytics tracker ID here. diff --git a/.env.example b/.env.example index 5e0f5d98a2..d8a506824c 100644 --- a/.env.example +++ b/.env.example @@ -70,6 +70,8 @@ SEND_ERROR_MESSAGE=true MAPBOX_API_KEY= # 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 severly limited +# the free API up to the point where you might as well offer nothing. FIXER_API_KEY= # If you wish to track your own behavior over Firefly III, set a valid analytics tracker ID here. diff --git a/.env.heroku b/.env.heroku index cf2f0b623c..c798fc0a29 100644 --- a/.env.heroku +++ b/.env.heroku @@ -70,6 +70,8 @@ SEND_ERROR_MESSAGE=true MAPBOX_API_KEY= # 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 severly limited +# the free API up to the point where you might as well offer nothing. FIXER_API_KEY= # If you wish to track your own behavior over Firefly III, set a valid analytics tracker ID here. diff --git a/.env.sandstorm b/.env.sandstorm index 8b6262c761..9b3a8f8e86 100755 --- a/.env.sandstorm +++ b/.env.sandstorm @@ -70,6 +70,8 @@ SEND_ERROR_MESSAGE=true MAPBOX_API_KEY= # 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 severly limited +# the free API up to the point where you might as well offer nothing. FIXER_API_KEY= # If you wish to track your own behavior over Firefly III, set a valid analytics tracker ID here. diff --git a/.env.testing b/.env.testing index b83b5c5d0a..4b34af2d4e 100644 --- a/.env.testing +++ b/.env.testing @@ -1,36 +1,54 @@ +# 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=testing + +# Set to true if you want to see debug information in error screens. APP_DEBUG=true -APP_NAME=FireflyIII + +# This should be your email address +SITE_OWNER=thegrumpydictator+testing@gmail.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=TestTestTestTestTestTestTestTest -APP_LOG=daily -APP_LOG_LEVEL=debug -APP_URL=http://localhost -TRUSTED_PROXIES= + +# Change this value to your preferred time zone. +# Example: Europe/Amsterdam TZ=Europe/Amsterdam -DB_CONNECTION=sqlite -DB_HOST=127.0.0.1 -DB_PORT=3306 -#DB_DATABASE=firefly -DB_USERNAME=homestead -DB_PASSWORD= - -BROADCAST_DRIVER=log -CACHE_DRIVER=file -SESSION_DRIVER=file -QUEUE_DRIVER=sync - -COOKIE_PATH="/" -COOKIE_DOMAIN= -COOKIE_SECURE=false - -REDIS_HOST=127.0.0.1 -REDIS_PASSWORD=null -REDIS_PORT=6379 +# APP_URL and TRUSTED_PROXIES are useful when using Docker and/or a reverse proxy. +APP_URL=http://localhost +TRUSTED_PROXIES= # The log channel defines where your log entries go to. LOG_CHANNEL=dailytest +# 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 +DB_CONNECTION=sqlite + +# '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=debug + +# If you're looking for performance improvements, you could install memcached. +CACHE_DRIVER=file +SESSION_DRIVER=file + +# Cookie settings. Should not be necessary to change these. +COOKIE_PATH="/" +COOKIE_DOMAIN= +COOKIE_SECURE=false + +# If you want Firefly III to mail you, update these settings MAIL_DRIVER=log MAIL_HOST=smtp.mailtrap.io MAIL_PORT=2525 @@ -39,26 +57,41 @@ MAIL_USERNAME=null MAIL_PASSWORD=null MAIL_ENCRYPTION=null -SEND_REGISTRATION_MAIL=true +# Firefly III can send you the following messages +SEND_REGISTRATION_MAIL=false SEND_ERROR_MESSAGE=false -CACHE_PREFIX=firefly - -SEARCH_RESULT_LIMIT=50 +# Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places. MAPBOX_API_KEY= -FIXER_API_KEY= -ANALYTICS_ID= -SITE_OWNER=mail@example.com -USE_ENCRYPTION=true +# 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 severly limited +# the free API up to the point where you might as well offer nothing. +FIXER_API_KEY= + +# If you wish to track your own behavior over Firefly III, set a valid analytics tracker ID here. +ANALYTICS_ID= + +# 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=false + +# 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_tst +SEARCH_RESULT_LIMIT=50 PUSHER_KEY= PUSHER_SECRET= PUSHER_ID= - DEMO_USERNAME= DEMO_PASSWORD= - IS_DOCKER=false IS_SANDSTORM=false IS_HEROKU=false