· 5 years ago · Dec 12, 2020, 11:58 PM
1# You can leave this on "local". If you change it to production most console commands will ask for extra confirmation.
2# Never set it to "testing".
3APP_ENV=production
4
5# Set to true if you want to see debug information in error screens.
6APP_DEBUG=false
7
8# This should be your email address.
9# If you use Docker or similar, you can set this variable from a file by using SITE_OWNER_FILE
10SITE_OWNER=you@personal.io
11
12# The encryption key for your sessions. Keep this very secure.
13# Change it to a string of exactly 32 chars or use something like `php artisan key:generate` to generate it.
14# If you use Docker or similar, you can set this variable from a file by using APP_KEY_FILE
15APP_KEY=7pBjBqpd7fkmppUytestVqMBHDn6test
16
17# Firefly III will launch using this language (for new users and unauthenticated visitors)
18# For a list of available languages: https://github.com/firefly-iii/firefly-iii/tree/main/resources/lang
19#
20# If text is still in English, remember that not everything may have been translated.
21DEFAULT_LANGUAGE=ru_RU
22
23# The locale defines how numbers are formatted.
24# by default this value is the same as whatever the language is.
25DEFAULT_LOCALE=ru_RU
26
27# Change this value to your preferred time zone.
28# Example: Europe/Amsterdam
29# For a list of supported time zones, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
30TZ=Europe/Moscow
31
32# TRUSTED_PROXIES is a useful variable when using Docker and/or a reverse proxy.
33# Set it to ** and reverse proxies work just fine.
34TRUSTED_PROXIES=**
35
36# The log channel defines where your log entries go to.
37# Several other options exist. You can use 'single' for one big fat error log (not recommended).
38# Also available are 'syslog', 'errorlog' and 'stdout' which will log to the system itself.
39# A rotating log option is 'daily', creates 5 files that (surprise) rotate.
40# Default setting 'stack' will log to 'daily' and to 'stdout' at the same time.
41
42# - Docker + versions <= 4.8.1.8 and before: use "stdout"
43# - Docker + versions > 4.8.1.8 : use "docker_out"
44# - Docker + versions >= 5.1.1 : use "stack"
45# - For everything else (als not Docker) : use 'stack'
46
47LOG_CHANNEL=stack
48
49# Log level. You can set this from least severe to most severe:
50# debug, info, notice, warning, error, critical, alert, emergency
51# If you set it to debug your logs will grow large, and fast. If you set it to emergency probably
52# nothing will get logged, ever.
53APP_LOG_LEVEL=notice
54
55# Database credentials. Make sure the database exists. I recommend a dedicated user for Firefly III
56# For other database types, please see the FAQ: https://docs.firefly-iii.org/support/faq
57# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
58# Use "pgsql" for PostgreSQL
59# Use "mysql" for MySQL and MariaDB.
60# Use "sqlite" for SQLite.
61DB_CONNECTION=mysql
62DB_HOST=fireflyiiidb
63DB_PORT=3306
64DB_DATABASE=firefly
65DB_USERNAME=firefly
66DB_PASSWORD=secret_firefly_password
67
68# MySQL supports SSL. You can configure it here.
69# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
70MYSQL_USE_SSL=false
71MYSQL_SSL_VERIFY_SERVER_CERT=true
72# You need to set at least of these options
73MYSQL_SSL_CAPATH=/etc/ssl/certs/
74MYSQL_SSL_CA=
75MYSQL_SSL_CERT=
76MYSQL_SSL_KEY=
77MYSQL_SSL_CIPHER=
78
79# PostgreSQL supports SSL. You can configure it here.
80# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
81PGSQL_SSL_MODE=prefer
82PGSQL_SSL_ROOT_CERT=null
83PGSQL_SSL_CERT=null
84PGSQL_SSL_KEY=null
85PGSQL_SSL_CRL_FILE=null
86
87# If you're looking for performance improvements, you could install memcached.
88CACHE_DRIVER=file
89SESSION_DRIVER=file
90
91# If you set either of these to 'redis', you might want to update these settings too
92# If you use Docker or similar, you can set REDIS_HOST_FILE, REDIS_PASSWORD_FILE or
93# REDIS_PORT_FILE to set the value from a file instead of from an environment variable
94
95# can be tcp, unix or http
96REDIS_SCHEME=tcp
97
98# use only when using 'unix' for REDIS_SCHEME. Leave empty otherwise.
99REDIS_PATH=
100
101# use only when using 'tcp' or 'http' for REDIS_SCHEME. Leave empty otherwise.
102REDIS_HOST=127.0.0.1
103REDIS_PORT=6379
104
105REDIS_PASSWORD=null
106# always use quotes and make sure redis db "0" and "1" exists. Otherwise change accordingly.
107REDIS_DB="0"
108REDIS_CACHE_DB="1"
109
110# Cookie settings. Should not be necessary to change these.
111# If you use Docker or similar, you can set COOKIE_DOMAIN_FILE to set
112# the value from a file instead of from an environment variable
113COOKIE_PATH="/"
114COOKIE_DOMAIN=
115COOKIE_SECURE=false
116
117# If you want Firefly III to mail you, update these settings
118# For instructions, see: https://docs.firefly-iii.org/advanced-installation/email
119# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
120MAIL_MAILER=log
121MAIL_HOST=null
122MAIL_PORT=2525
123MAIL_FROM=changeme@example.com
124MAIL_USERNAME=null
125MAIL_PASSWORD=null
126MAIL_ENCRYPTION=null
127
128# Other mail drivers:
129# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
130MAILGUN_DOMAIN=
131MAILGUN_SECRET=
132
133
134# If you are on EU region in mailgun, use api.eu.mailgun.net, otherwise use api.mailgun.net
135# If you use Docker or similar, you can set this variable from a file by appending it with _FILE
136MAILGUN_ENDPOINT=api.mailgun.net
137
138# If you use Docker or similar, you can set these variables from a file by appending them with _FILE
139MANDRILL_SECRET=
140SPARKPOST_SECRET=
141
142# Firefly III can send you the following messages
143SEND_REGISTRATION_MAIL=true
144SEND_ERROR_MESSAGE=true
145SEND_LOGIN_NEW_IP_WARNING=true
146
147# These messages contain (sensitive) transaction information:
148SEND_REPORT_JOURNALS=true
149
150# Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
151# If you use Docker or similar, you can set this variable from a file by appending it with _FILE
152MAPBOX_API_KEY=
153
154# The map will default to this location:
155MAP_DEFAULT_LAT=51.983333
156MAP_DEFAULT_LONG=5.916667
157MAP_DEFAULT_ZOOM=6
158
159# Firefly III has two options for user authentication. "eloquent" is the default,
160# and "ldap" for LDAP servers.
161# For full instructions on these settings please visit:
162# https://docs.firefly-iii.org/advanced-installation/authentication
163# If you use Docker or similar, you can set this variable from a file by appending it with _FILE
164LOGIN_PROVIDER=eloquent
165
166# It's also possible to change the way users are authenticated. You could use Authelia for example.
167# Authentication via the REMOTE_USER header is supported. Change the value below to "remote_user_guard".
168#
169# This will also allow Windows SSO.
170#
171# If you do this please read the documentation for instructions and warnings:
172# https://docs.firefly-iii.org/advanced-installation/authentication
173#
174# This function is available in Firefly III v5.3.0 and higher.
175AUTHENTICATION_GUARD=web
176
177# If the guard is changed, Firefly III uses the 'REMOTE_USER' header as per RFC 3875.
178# You can also use another header, like AUTH_USER when using Windows SSO.
179# Some systems use X-Auth headers. In that case, use HTTP_X_AUTH_USERNAME or HTTP_X_AUTH_EMAIL
180# Depending on your system, REMOTE_USER may need to be changed to HTTP_REMOTE_USER
181#
182# If this header is 'unexpectedly empty', check out the documentation.
183# https://docs.firefly-iii.org/advanced-installation/authentication
184#
185AUTHENTICATION_GUARD_HEADER=REMOTE_USER
186
187#
188# Firefly III uses email addresses as user identifiers. When you're using an external authentication guard
189# that doesn't do this, Firefly III is incapable of emailing you. Messages sent to "Bill Gates" always fail.
190#
191# However, if you set this value, Firefly III will store the value from this header as the user's backup
192# email address and use it to communicate. So user "Bill Gates" could still have
193# the email address "bill@microsoft.com".
194#
195# Example value: AUTHENTICATION_GUARD_EMAIL=HTTP_X_AUTH_EMAIL
196#
197AUTHENTICATION_GUARD_EMAIL=
198
199
200# It's impossible to log out users who's authentication is handled by an external system.
201# Enter a custom URL here that will force a logout (your authentication provider can tell you).
202# Setting this variable only works when AUTHENTICATION_GUARD != web
203#
204CUSTOM_LOGOUT_URI=
205
206# LDAP connection configuration
207# OpenLDAP, FreeIPA or ActiveDirectory
208# # If you use Docker or similar, you can set this variable from a file by appending it with _FILE
209ADLDAP_CONNECTION_SCHEME=OpenLDAP
210ADLDAP_AUTO_CONNECT=true
211
212# LDAP connection settings
213# You can set the following variables from a file by appending them with _FILE:
214# ADLDAP_CONTROLLERS, ADLDAP_PORT, ADLDAP_BASEDN
215ADLDAP_CONTROLLERS=
216ADLDAP_PORT=389
217ADLDAP_TIMEOUT=5
218ADLDAP_BASEDN=""
219ADLDAP_FOLLOW_REFFERALS=false
220
221# SSL/TLS settings
222ADLDAP_USE_SSL=false
223ADLDAP_USE_TLS=false
224ADLDAP_SSL_CACERTDIR=
225ADLDAP_SSL_CACERTFILE=
226ADLDAP_SSL_CERTFILE=
227ADLDAP_SSL_KEYFILE=
228ADLDAP_SSL_CIPHER_SUITE=
229ADLDAP_SSL_REQUIRE_CERT=
230
231# You can set the following variables from a file by appending them with _FILE:
232ADLDAP_ADMIN_USERNAME=
233ADLDAP_ADMIN_PASSWORD=
234
235# You can set the following variables from a file by appending them with _FILE:
236ADLDAP_ACCOUNT_PREFIX=
237ADLDAP_ACCOUNT_SUFFIX=
238
239# LDAP authentication settings.
240ADLDAP_PASSWORD_SYNC=false
241ADLDAP_LOGIN_FALLBACK=false
242
243ADLDAP_DISCOVER_FIELD=distinguishedname
244ADLDAP_AUTH_FIELD=distinguishedname
245
246# field to sync as local username.
247# You can set the following variable from a file by appending it with _FILE:
248ADLDAP_SYNC_FIELD=userprincipalname
249
250# You can disable the X-Frame-Options header if it interferes with tools like
251# Organizr. This is at your own risk. Applications running in frames run the risk
252# of leaking information to their parent frame.
253DISABLE_FRAME_HEADER=false
254
255# You can disable the Content Security Policy header when you're using an ancient browser
256# or any version of Microsoft Edge / Internet Explorer (which amounts to the same thing really)
257# This leaves you with the risk of not being able to stop XSS bugs should they ever surface.
258# This is at your own risk.
259DISABLE_CSP_HEADER=false
260
261# If you wish to track your own behavior over Firefly III, set valid analytics tracker information here.
262# Nobody uses this except for me on the demo site. But hey, feel free to use this if you want to.
263# Do not prepend the TRACKER_URL with http:// or https://
264# The only tracker supported is Matomo.
265# You can set the following variables from a file by appending them with _FILE:
266TRACKER_SITE_ID=
267TRACKER_URL=
268
269# Firefly III can collect telemetry on how you use Firefly III. This is opt-in.
270# In order to allow this, change the following variable to true.
271# To read more about this feature, go to this page: https://docs.firefly-iii.org/support/telemetry
272SEND_TELEMETRY=false
273
274# You can fine tune the start-up of a Docker container by editing these environment variables.
275# Use this at your own risk. Disabling certain checks and features may result in lost of inconsistent data.
276# However if you know what you're doing you can significantly speed up container start times.
277# Set each value to true to enable, or false to disable.
278
279# Check if the SQLite database exists. Can be skipped if you're not using SQLite.
280# Won't significantly speed up things.
281DKR_CHECK_SQLITE=true
282
283# Run database creation and migration commands. Disable this only if you're 100% sure the DB exists
284# and is up to date.
285DKR_RUN_MIGRATION=true
286
287# Run database upgrade commands. Disable this only when you're 100% sure your DB is up-to-date
288# with the latest fixes (outside of migrations!)
289DKR_RUN_UPGRADE=true
290
291# Verify database integrity. Includes all data checks and verifications.
292# Disabling this makes Firefly III assume your DB is intact.
293DKR_RUN_VERIFY=true
294
295# Run database reporting commands. When disabled, Firefly III won't go over your data to report current state.
296# Disabling this should have no impact on data integrity or safety but it won't warn you of possible issues.
297DKR_RUN_REPORT=true
298
299# Generate OAuth2 keys.
300# When disabled, Firefly III won't attempt to generate OAuth2 Passport keys. This won't be an issue, IFF (if and only if)
301# you had previously generated keys already and they're stored in your database for restoration.
302DKR_RUN_PASSPORT_INSTALL=true
303
304# Leave the following configuration vars as is.
305# Unless you like to tinker and know what you're doing.
306APP_NAME=FireflyIII
307ADLDAP_CONNECTION=default
308BROADCAST_DRIVER=log
309QUEUE_DRIVER=sync
310CACHE_PREFIX=firefly
311PUSHER_KEY=
312PUSHER_SECRET=
313PUSHER_ID=
314DEMO_USERNAME=
315DEMO_PASSWORD=
316IS_HEROKU=false
317FIREFLY_III_LAYOUT=v1
318
319#
320APP_URL=https://finance.personal.io