You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

236 lines
6.7 KiB

3 years ago
  1. #
  2. # Where is Firefly III?
  3. #
  4. # 1) Make sure you ADD http:// or https://
  5. # 2) Make sure you REMOVE any trailing slash from the end of the URL.
  6. # 3) In case of Docker, refer to the internal IP of your Firefly III installation.
  7. #
  8. # This value is not mandatory. But it is very useful.
  9. #
  10. # This variable can be set from a file if you append it with _FILE
  11. #
  12. FIREFLY_III_URL=
  13. #
  14. # Imagine Firefly III can be reached at "http://172.16.0.2:8082" (internal Docker network or something).
  15. # But you have a fancy URL: "https://personal-finances.bill.microsoft.com/"
  16. #
  17. # In those cases, you can overrule the URL so when the data importer links back to Firefly III, it uses the correct URL.
  18. #
  19. # 1) Make sure you ADD http:// or https://
  20. # 2) Make sure you REMOVE any trailing slash from the end of the URL.
  21. #
  22. # IF YOU SET THIS VALUE, YOU MUST ALSO SET THE FIREFLY_III_URL
  23. #
  24. # This variable can be set from a file if you append it with _FILE
  25. #
  26. VANITY_URL=
  27. #
  28. # Set your Firefly III Personal Access Token
  29. # You can find create a Personal Access Token on the /profile page (at the bottom)
  30. #
  31. # - Do not use the "command line token". That's the WRONG one.
  32. # - Do not use "APP_KEY". That's the WRONG one.
  33. #
  34. # This value is not mandatory to set. Instructions will follow if you omit this field.
  35. #
  36. # This variable can be set from a file if you append it with _FILE
  37. #
  38. FIREFLY_III_ACCESS_TOKEN=
  39. #
  40. # You can also use a public client ID. This is available in Firefly III 5.4.0-alpha.3 and higher.
  41. # This is a number (1, 2, 3). If you use the client ID, you can leave the access token empty and vice versa.
  42. #
  43. # This value is not mandatory to set. Instructions will follow if you omit this field.
  44. #
  45. # This variable can be set from a file if you append it with _FILE
  46. #
  47. FIREFLY_III_CLIENT_ID=
  48. #
  49. # Nordigen information.
  50. # The key and ID can be set from a file if you append it with _FILE
  51. #
  52. NORDIGEN_ID=
  53. NORDIGEN_KEY=
  54. NORDIGEN_SANDBOX=false
  55. #
  56. # Spectre information
  57. #
  58. # The ID and secret can be set from a file if you append it with _FILE
  59. SPECTRE_APP_ID=
  60. SPECTRE_SECRET=
  61. #
  62. # Use cache. No need to do this.
  63. #
  64. USE_CACHE=false
  65. #
  66. # If set to true, the data import will not complain about running into duplicates.
  67. # This will give you cleaner import mails if you run regular imports.
  68. #
  69. # Of course, if something goes wrong *because* the transaction is a duplicate you will
  70. # NEVER know unless you start digging in your log files. So be careful with this.
  71. #
  72. IGNORE_DUPLICATE_ERRORS=false
  73. #
  74. # Auto import settings. Due to security constraints, you MUST enable each feature individually.
  75. # You must also set a secret. The secret is used for the web routes.
  76. #
  77. # The auto-import secret must be a string of at least 16 characters.
  78. # Visit this page for inspiration: https://www.random.org/passwords/?num=1&len=16&format=html&rnd=new
  79. #
  80. # Submit it using ?secret=X
  81. #
  82. # This variable can be set from a file if you append it with _FILE
  83. #
  84. AUTO_IMPORT_SECRET=
  85. #
  86. # Is the /autoimport even endpoint enabled?
  87. # By default it's disabled, and the secret alone will not enable it.
  88. #
  89. CAN_POST_AUTOIMPORT=false
  90. #
  91. # Is the /autoupload endpoint enabled?
  92. # By default it's disabled, and the secret alone will not enable it.
  93. #
  94. CAN_POST_FILES=false
  95. #
  96. # Import directory white list. You need to set this before the auto importer will accept a directory to import from.
  97. #
  98. # This variable can be set from a file if you append it with _FILE
  99. #
  100. IMPORT_DIR_ALLOWLIST=
  101. #
  102. # When you're running Firefly III under a (self-signed) certificate,
  103. # the data importer may have trouble verifying the TLS connection.
  104. #
  105. # You have a few options to make sure the data importer can connect
  106. # to Firefly III:
  107. # - 'true': will verify all certificates. The most secure option and the default.
  108. # - 'file.pem': refer to a file (you must provide it) to your custom root or intermediate certificates.
  109. # - 'false': will verify NO certificates. Not very secure.
  110. VERIFY_TLS_SECURITY=true
  111. #
  112. # If you want, you can set a directory here where the data importer will look for import configurations.
  113. # This is a separate setting from the /import directory that the auto-import uses.
  114. # Setting this variable isn't necessary. The default value is "storage/configurations".
  115. #
  116. # This variable can be set from a file if you append it with _FILE
  117. #
  118. JSON_CONFIGURATION_DIR=
  119. #
  120. # Time out when connecting with Firefly III.
  121. # π*10 seconds is usually fine.
  122. #
  123. CONNECTION_TIMEOUT=31.41
  124. # The following variables can be useful when debugging the application
  125. APP_ENV=local
  126. APP_DEBUG=false
  127. LOG_CHANNEL=stack
  128. # Log level. You can set this from least severe to most severe:
  129. # debug, info, notice, warning, error, critical, alert, emergency
  130. # If you set it to debug your logs will grow large, and fast. If you set it to emergency probably
  131. # nothing will get logged, ever.
  132. LOG_LEVEL=debug
  133. # TRUSTED_PROXIES is a useful variable when using Docker and/or a reverse proxy.
  134. # Set it to ** and reverse proxies work just fine.
  135. TRUSTED_PROXIES=
  136. #
  137. # Time zone
  138. #
  139. TZ=Europe/Amsterdam
  140. #
  141. # Use ASSET_URL when you're running the data importer in a sub-directory.
  142. #
  143. ASSET_URL=
  144. #
  145. # Email settings.
  146. # The data importer can send you a message with all errors, warnings and messages
  147. # after a successful import. This is disabled by default
  148. #
  149. ENABLE_MAIL_REPORT=false
  150. #
  151. # Force Firefly III URL to be secure?
  152. #
  153. #
  154. EXPECT_SECURE_URL=false
  155. # If enabled, define which mailer you want to use.
  156. # Options include: smtp, mailgun, postmark, sendmail, log, array
  157. # Amazon SES is not supported.
  158. # log = drop mails in the logs instead of sending them
  159. # array = debug mailer that does nothing.
  160. MAIL_MAILER=
  161. # where to send the report?
  162. MAIL_DESTINATION=noreply@example.com
  163. # other mail settings
  164. # These variables can be set from a file if you append it with _FILE
  165. MAIL_FROM_ADDRESS=noreply@example.com
  166. MAIL_HOST=smtp.mailtrap.io
  167. MAIL_PORT=2525
  168. MAIL_USERNAME=username
  169. MAIL_PASSWORD=password
  170. MAIL_ENCRYPTION=null
  171. # Extra settings depending on your mail configuration above.
  172. # These variables can be set from a file if you append it with _FILE
  173. MAILGUN_DOMAIN=
  174. MAILGUN_SECRET=
  175. MAILGUN_ENDPOINT=
  176. POSTMARK_TOKEN=
  177. #
  178. # You probably won't need to change these settings.
  179. #
  180. BROADCAST_DRIVER=log
  181. CACHE_DRIVER=file
  182. QUEUE_CONNECTION=sync
  183. SESSION_DRIVER=file
  184. SESSION_LIFETIME=120
  185. IS_EXTERNAL=false
  186. REDIS_HOST=127.0.0.1
  187. REDIS_PASSWORD=null
  188. REDIS_PORT=6379
  189. # always use quotes
  190. REDIS_DB="0"
  191. REDIS_CACHE_DB="1"
  192. # The only tracker supported is Matomo.
  193. # This is used on the public instance over at https://data-importer.firefly-iii.org
  194. TRACKER_SITE_ID=
  195. TRACKER_URL=
  196. APP_NAME=DataImporter
  197. #
  198. # The APP_URL environment variable is NOT used anywhere.
  199. # Don't bother setting it to fix your reverse proxy problems. It won't help.
  200. # Don't open issues telling me it doesn't help because it's not supposed to.
  201. # Laravel uses this to generate links on the command line, which is a feature the CVS importer does not use.
  202. #
  203. APP_URL=http://localhost