Configure your installation
The Firefly III Data Importer (FIDI) communicates with Firefly III over the API. You can supply FIDI with a few pieces of information to make it easy to connect to your Firefly III installation.
On this page you will read how to:
- Configure FIDI to connect to Firefly III.
- Configure Nordigen (optional)
- Configure Spectre (optional)
- Where to set these variables.
You must tell FIDI where to reach Firefly III. This is set in the
FIREFLY_III_URL environment variable. Make sure you REMOVE any trailing slash from the end of the URL.
For Docker, you may be able to use the internal IP address of Firefly III, instead of its public address. But if normal users can't reach this URL, you must also set the
VANITY_URL. Here is an example:
FIREFLY_III_URL=http://172.16.2.2:8080(internal Docker URL)
VANITY_URL=https://money.bill-gates.com(public or local URL)
To authenticate with Firefly III you must set ONE the following variables:
- Set a Personal Access Token in the
- OR Set a Client ID in the
A Docker installation will never be able to connect a Firefly III installation located at
http://127.0.0.1 because this address refers to the Docker container itself, and not Firefly III.
To configure Nordigen, set the following variables. This is necessary if you wish to connect to your bank through Nordigen.
NORDIGEN_IDis your Nordigen Client ID
NORDIGEN_KEYis your Nordigen Client Secret
- If you set
trueFIDI will only connect to the Nordigen sandbox.
To configure Spectre, set the following variables. This is necessary if you wish to connect to your bank through Spectre.
SPECTRE_APP_IDis your Spectre / Salt Edge Client ID
SPECTRE_SECRETis your Spectre / Salt Edge Client secret
Where to set the configuration?
The configuration values are stored in environment variables:
You may need to clear your cookies, browse to
/flush or press [Reauthenticate] after changing these values.
How to get these variables?
You can generate your own Personal Access Token on the Profile page. Login to your Firefly III instance, go to "Options" > "Profile" > "OAuth" and find "Personal Access Tokens". Create a new Personal Access Token by clicking on "Create New Token". Give it a recognizable name and press "Create". The Personal Access Token is pretty long. Use a tool like Notepad++ or Visual Studio Code to copy-and-paste it.
Client ID + Firefly III URL
You can generate your own client ID on your Profile page (under OAuth). This is the ID you need when you want to share FIDI with multiple people, or when you want to allow others to use the same instance of FIDI.
Make sure you uncheck the "confidential" checkbox.
It is very important that the callback URL is correct. The callback is the following:
Some common examples include:
- http://172.16.0.2/callback (172.16 is a common IP range for Docker hosts)
- https://csv-importer.home/callback (Some users have fancy local addresses. Notice the TLS)
- http://10.0.0.15/callback (10.0.0.x is often used when using Vagrant)
But ALWAYS add
/callback or you'll run into weird errors later.