# How to install using Docker {#how-to-install-using-docker} Firefly III and the Data Importer can be installed using Docker. There are ready-made Docker containers for almost all platforms. If you've never used Docker before, please first read into it yourself. The easiest way to install them is using "Docker compose", which is a Docker tool that allows you to define and run multi-container Docker applications. With Docker compose, you use a YAML file to configure your application's services. Then, with a single command, you create and start all the services from your configuration. This guide will assume you'll want to install both Firefly III and the Data Importer. If you already have a Firefly III installation, and you wish to expand it with the data importer, do not worry. You can follow this guide again and reinstall Firefly III. You will point to the same data volumes and the same databases, so nothing will be lost. The YAML file and all necessary configuration are provided online for your convenience. If you happen to include any existing data from Firefly III, please [back this data up first](https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/backup/index.md). If you have questions, please refer to [the Docker FAQ](https://sourcey-firefly.pages.dev/references/faq/docker/index.md) or contact me using the instructions from the [support page](https://sourcey-firefly.pages.dev/explanation/support/index.md). ## Docker Compose {#docker-compose} ### Download files {#download-files} Grab the **[docker-compose-importer.yml](https://raw.githubusercontent.com/firefly-iii/docker/main/docker-compose-importer.yml)** from GitHub. Download the raw file and store it in a directory of your choice as `docker-compose.yml`. Then, download the configuration files: - Download the `.env.example` file for Firefly III [from the Firefly III repository](https://raw.githubusercontent.com/firefly-iii/firefly-iii/main/.env.example). Save the raw file as `.env` next to the docker compose file. - Download the `.env.example` file from the [Data Importer repository](https://raw.githubusercontent.com/firefly-iii/data-importer/main/.env.example) and save it as `.importer.env` next to the other files. - The final file (`database.env`) contains the database variables and can be downloaded from [the Docker repository](https://raw.githubusercontent.com/firefly-iii/docker/main/database.env). Save it as a new file called `.db.env`. ### Edit files {#edit-files} If you save all example files and change nothing, it will NOT YET work. You must do a few things: 1. Change `DB_PASSWORD` in `.env` to something else. Pick a nice password (some special characters such as $ may need to be escaped e.g. $$). 2. Also change `MYSQL_PASSWORD` in `.db.env` to the SAME value 3. Change `FIREFLY_III_URL` in `.importer.env` to `http://app:8080` 4. Change `VANITY_URL` in `.importer.env` to the URL you use to reach Firefly III. For example: `http://localhost` (this is probably different in your case). 5. Set `TRUSTED_PROXIES=*` (yes, with an asterisk) when you have a reverse proxy like nginx or Traefik > [!NOTE] > Change the password FIRST. If you change the password *after* you started Docker, it will complain about having no access. ### Run the compose file {#run-the-compose-file} Run the following command in the directory where all files are present. ```text docker compose -f docker-compose.yml up -d --pull=always ``` You can follow the progress of the installation by running this command: ```text docker compose -f docker-compose.yml logs -f ``` When the installation is done, Firefly III will thank you for installing it. Once you see this message, you can visit Firefly III. It will be running at [http://localhost](http://localhost). ### Set up Firefly III {#set-up-firefly-iii} Follow these how-to's and tutorials to set up Firefly III: - [Tutorial: Create accounts and transactions](https://sourcey-firefly.pages.dev/tutorials/finances/first-steps/index.md) - [Tutorial: My first accounts](https://sourcey-firefly.pages.dev/tutorials/finances/first-accounts/index.md) - [How-to: organize transactions](https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/transactions/index.md) ### Create an access token {#create-an-access-token} Follow [how-to get a token](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/api/index.md). Use the custom instructions below: 1. The callback URL will be `http://localhost:81/callback` 2. UNCHECK the box that says "Confidential" ### Browse to the data importer {#browse-to-the-data-importer} Now, browse to the Data Importer. It will be running at [http://localhost:81/](http://localhost:81/). Enter the Client ID from the previous step. In my example, it is "3": ![Enter the client ID](/_media/5501d5379d99feef356b.png) Press the button to Authenticate. You should give permission on the next screen. Note how the name of your client is reflected in the question: ![Give permission](/_media/85438c8aa92de1ad91fa.png) You should get back on the Data Importer index: ![Ready to go!](/_media/95ab0fb8a496e9343918.png) You are now ready to go! - [Tutorial: Import from a third party data provider](https://sourcey-firefly.pages.dev/tutorials/data-importer/data-providers/index.md) - [How-to: import a data file](https://sourcey-firefly.pages.dev/how-to/data-importer/import/file/index.md) ## Plain Docker {#plain-docker} You can also use Docker itself, skipping Docker Compose. This allows you to set up a single container, with just the data importer inside of it. To run the Data Importer as a singular container using the following `run` command. You will start a web server on port 8081 that will allow you to use the data importer. Follow [how-to get a token](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/api/index.md). Use the custom instructions below: 1. The callback URL will be your Firefly III installation 2. UNCHECK the box that says "Confidential" Note that most people don't use GoCardless *and* Spectre values at the same time. All environment variables are optional, but convenient. Please note that the `NORDIGEN` environment variables refer to GoCardless. ```bash docker run \ -e FIREFLY_III_ACCESS_TOKEN=(here) \ -e FIREFLY_III_URL=(here) \ -e NORDIGEN_ID=(here) \ -e NORDIGEN_KEY=(here) \ -e SPECTRE_APP_ID=(here) \ -e SPECTRE_SECRET=(here) \ -p 8081:8080 \ fireflyiii/data-importer:latest ``` > [!NOTE] > **Run in the background** > > Change `docker run` to `docker run -d` so the image runs in the background. If you have questions, please refer to [the Docker FAQ](https://sourcey-firefly.pages.dev/references/faq/docker/index.md) or contact me using the instructions from the [support page](https://sourcey-firefly.pages.dev/explanation/support/index.md).