nSBW9vAj

1# Firefly Data Importer (FIDI) configuration file
2
3# Where is Firefly III?
4#
5# 1) Make sure you ADD http:// or https://
6# 2) Make sure you REMOVE any trailing slash from the end of the URL.
7# 3) In case of Docker, refer to the internal IP of your Firefly III installation.
8#
9# Setting this value is not mandatory. But it is very useful.
10#
11# This variable can be set from a file if you append it with _FILE
12#
13FIREFLY_III_URL=http://app:666
14
15#
16# Imagine Firefly III can be reached at "http://172.16.0.2:8082" (internal Docker network or something).
17# But you have a fancy URL: "https://personal-finances.bill.microsoft.com/"
18#
19# In those cases, you can overrule the URL so when the data importer links back to Firefly III, it uses the correct URL.
20#
21# 1) Make sure you ADD http:// or https://
22# 2) Make sure you REMOVE any trailing slash from the end of the URL.
23#
24# IF YOU SET THIS VALUE, YOU MUST ALSO SET THE FIREFLY_III_URL
25#
26# This variable can be set from a file if you append it with _FILE
27#
28VANITY_URL=http://localhost
29
30#
31# Set your Firefly III Personal Access Token (OAuth)
32# You can create a Personal Access Token on the /profile page:
33# go to the OAuth tab, then Personal Access Token and "Create token".
34#
35# - Do not use the "command line token". That's the WRONG one.
36# - Do not use "APP_KEY" value from your Firefly III installation. That's the WRONG one.
37#
38# Setting this value is not mandatory. Instructions will follow if you omit this field.
39#
40# This variable can be set from a file if you append it with _FILE
41#
42FIREFLY_III_ACCESS_TOKEN=
43
44#
45# You can also use a public client ID. This is available in Firefly III 5.4.0-alpha.3 and higher.
46# This is a number (1, 2, 3). If you use the client ID, you can leave the access token empty and vice versa.
47#
48# This value is not mandatory to set. Instructions will follow if you omit this field.
49#
50# This variable can be set from a file if you append it with _FILE
51#
52FIREFLY_III_CLIENT_ID=
53
54#
55# GoCardless information.
56# The key and ID can be set from a file if you append it with _FILE
57#
58NORDIGEN_ID=
59NORDIGEN_KEY=
60
61#
62# If you want to use the GoCardless sandbox, set this to true.
63#
64NORDIGEN_SANDBOX=false
65
66#
67# GoCardless has a rate limit in place. The data importer can wait it out, or exit.
68# Valid values are "wait" or "exit"
69#
70RESPOND_TO_GOCARDLESS_LIMIT=wait
71
72#
73# The data importer collects account details, which are currently unused.
74# This is disabled, since it costs a lot of API calls.
75# You can enable it if you want to.
76#
77GOCARDLESS_GET_ACCOUNT_DETAILS=false
78
79#
80# The data importer also collects balances, which can be used for (manual)
81# balance verification ("did the import go well?").
82# This is disabled by default, since it costs a lot of API calls.
83# You can enable it if you want to.
84#
85GOCARDLESS_GET_BALANCE_DETAILS=false
86
87#
88# Spectre information
89#
90# The ID and secret can be set from a file if you append it with _FILE
91SPECTRE_APP_ID=
92SPECTRE_SECRET=
93
94#
95# Use cache. No need to do this.
96#
97USE_CACHE=false
98
99#
100# If set to true, the data import will not complain about running into duplicates.
101# This will give you cleaner import mails if you run regular imports.
102#
103# This means that the data importer will not import duplicates, but it will not complain about them either.
104#
105# This setting has no influence on the settings in your configuration(.json).
106#
107# Of course, if something goes wrong *because* the transaction is a duplicate you will
108# NEVER know unless you start digging in your log files. So be careful with this.
109#
110IGNORE_DUPLICATE_ERRORS=false
111
112#
113# If you set this to true, the importer will not complain about transactions that can't be found after they've
114# been imported. This happens when rule on the Firefly III side deletes the transaction immediately after creating it.
115# This can be useful when you have a rule that immediately deletes GoCardless' "pending" transactions. Setting this
116# to true reduces some noise.
117#
118IGNORE_NOT_FOUND_TRANSACTIONS=false
119
120#
121# Auto import settings. Due to security constraints, you MUST enable each feature individually.
122# You must also set a secret. The secret is used for the web routes.
123#
124# The auto-import secret must be a string of at least 16 characters.
125# Visit this page for inspiration: https://www.random.org/passwords/?num=1&len=16&format=html&rnd=new
126#
127# Submit it using ?secret=X
128#
129# This variable can be set from a file if you append it with _FILE
130#
131AUTO_IMPORT_SECRET=
132
133#
134# Is the /autoimport even endpoint enabled?
135# By default it's disabled, and the secret alone will not enable it.
136#
137CAN_POST_AUTOIMPORT=false
138
139#
140# Is the /autoupload endpoint enabled?
141# By default it's disabled, and the secret alone will not enable it.
142#
143CAN_POST_FILES=false
144
145#
146# Import directory white list. You need to set this before the auto importer will accept a directory to import from.
147#
148# This variable can be set from a file if you append it with _FILE
149#
150IMPORT_DIR_ALLOWLIST=
151
152#
153# If you import from a directory, you can save a fallback configuration file in the directory.
154# This file must be called "_fallback.json" and will be used when your CSV or CAMT.053 file is not accompanied
155# by a configuration file.
156#
157# This fallback configuration will only be used if this variable is set to true.
158# https://docs.firefly-iii.org/how-to/data-importer/advanced/post/#importing-a-local-directory
159#
160FALLBACK_IN_DIR=false
161
162#
163# When you're running Firefly III under a (self-signed) certificate,
164# the data importer may have trouble verifying the TLS connection.
165#
166# You have a few options to make sure the data importer can connect
167# to Firefly III:
168# - 'true': will verify all certificates. The most secure option and the default.
169# - 'file.pem': refer to a file (you must provide it) to your custom root or intermediate certificates.
170# - 'false': will verify NO certificates. Not very secure.
171VERIFY_TLS_SECURITY=true
172
173#
174# If you want, you can set a directory here where the data importer will look for import configurations.
175# This is a separate setting from the /import directory that the auto-import uses.
176# Setting this variable isn't necessary. The default value is "storage/configurations".
177#
178# This variable can be set from a file if you append it with _FILE
179#
180JSON_CONFIGURATION_DIR=
181
182#
183# Time out when connecting with Firefly III.
184# π*10 seconds is usually fine.
185#
186CONNECTION_TIMEOUT=31.41
187
188# The following variables can be useful when debugging the application
189APP_ENV=local
190APP_DEBUG=false
191LOG_CHANNEL=stack
192
193#
194# If you turn this on, expect massive logs with lots of privacy sensitive data
195#
196LOG_RETURN_JSON=false
197
198# Log level. You can set this from least severe to most severe:
199# debug, info, notice, warning, error, critical, alert, emergency
200# If you set it to debug your logs will grow large, and fast. If you set it to emergency probably
201# nothing will get logged, ever.
202LOG_LEVEL=debug
203
204# TRUSTED_PROXIES is a useful variable when using Docker and/or a reverse proxy.
205# Set it to ** and reverse proxies work just fine.
206TRUSTED_PROXIES=
207
208#
209# Time zone
210#
211TZ=Asia/Tokyo
212
213#
214# Email settings.
215# The data importer can send you a message with all errors, warnings and messages
216# after a successful import. This is disabled by default
217#
218ENABLE_MAIL_REPORT=false
219
220#
221# Force Firefly III URL to be secure?
222#
223#
224EXPECT_SECURE_URL=false
225
226# If enabled, define which mailer you want to use.
227# Options include: smtp, mailgun, postmark, sendmail, log, array
228# Amazon SES is not supported.
229# log = drop mails in the logs instead of sending them
230# array = debug mailer that does nothing.
231MAIL_MAILER=
232
233# where to send the report?
234MAIL_DESTINATION=noreply@example.com
235
236# other mail settings
237# These variables can be set from a file if you append it with _FILE
238MAIL_FROM_ADDRESS=noreply@example.com
239MAIL_HOST=smtp.mailtrap.io
240MAIL_PORT=2525
241MAIL_USERNAME=username
242MAIL_PASSWORD=password
243MAIL_ENCRYPTION=null
244
245# Extra settings depending on your mail configuration above.
246# These variables can be set from a file if you append it with _FILE
247MAILGUN_DOMAIN=
248MAILGUN_SECRET=
249MAILGUN_ENDPOINT=
250POSTMARK_TOKEN=
251
252#
253# You probably won't need to change these settings.
254#
255BROADCAST_DRIVER=log
256CACHE_DRIVER=file
257QUEUE_CONNECTION=sync
258SESSION_DRIVER=file
259SESSION_LIFETIME=120
260IS_EXTERNAL=false
261
262REDIS_HOST=127.0.0.1
263REDIS_PASSWORD=null
264REDIS_PORT=6379
265
266# always use quotes
267REDIS_DB="0"
268REDIS_CACHE_DB="1"
269
270#
271# Use ASSET_URL when your data importer webpages are served from a URL with a subfolder path
272# This pre-appends the subfolder path in front of URLs for browser-side assets such as CSS Files.
273# Example: If your webserver (i.e. NGINX) is configured to serve the data importer webpages from
274#    http://localhost/ff3di, set ASSET_URL = /ff3di
275#    and it will pre-append that value to any requests for browser-side assets
276# 1) Make sure you REMOVE any trailing slash from the end of the URL.
277#
278ASSET_URL=
279
280# The only tracker supported is Matomo.
281# This is used on the public instance over at https://data-importer.firefly-iii.org
282TRACKER_SITE_ID=
283TRACKER_URL=
284
285APP_NAME=DataImporter
286
287#
288# The APP_URL environment variable is NOT used anywhere.
289# Don't bother setting it to fix your reverse proxy problems. It won't help.
290# Don't open issues telling me it doesn't help because it's not supposed to.
291# Laravel uses this to generate links on the command line, which is a feature the data importer does not use.
292#
293APP_URL=http://localhost
294