Docker

There are several ways of installing Firefly III using Docker, which will be detailed below. If you’re new to Docker or are not sure how to use Docker please thread carefully.

Straight from Docker Hub

With these commands you create one container: the container for Firefly III itself. If you do this, you should already have a MySQL or a Postgres database running somewhere. For example, when you have one central database container for all of your docker containers. Without such a database container, Firefly III will not work.

Docker containers should only do one thing, which is why you need a separata database container.

Create some volumes

These are used to persistently store uploaded files and exported data.

docker volume create firefly_iii_export
docker volume create firefly_iii_upload

Start the container

Run this Docker command to start the Firefly III container. Make sure that you edit the environment variables to match your own database. You should really change the FF_APP_KEY as well. It should be a random string of exactly 32 characters.

docker run -d \
-v firefly_iii_export:/var/www/firefly-iii/storage/export \
-v firefly_iii_upload:/var/www/firefly-iii/storage/upload \
-p 80:80 \
-e FF_APP_ENV=local \
-e FF_APP_KEY=S0m3R@nd0mString0f32Ch@rsEx@ct1y \
-e FF_DB_HOST=CHANGEME \
-e FF_DB_NAME=CHANGEME \
-e FF_DB_USER=CHANGEME \
-e FF_DB_PASSWORD=CHANGEME \
jc5x/firefly-iii:latest

Firefly III assumes MySQL. If you use Postgres, add the following environment variable to the command: DB_CONNECTION=pgsql.

When executed this command will fire up a Docker container with Firefly III inside of it. If you visit it, it will say “Be right back”. Continue below.

Initialize your database

Find out what the container ID is by running:

docker container ls

Then, to get it going, initialize the database like so:

docker exec -it <container> php artisan migrate --seed
docker exec -it <container> php artisan firefly:upgrade-database
docker exec -it <container> php artisan firefly:verify
docker exec -it <container> php artisan passport:install
docker exec -it <container> php artisan cache:clear

You can then visit http://localhost and register a new account.

If you’re having trouble with (parts of) this step, please check out the Docker FAQ

Upgrade

To upgrade, stop your container using

docker stop <container>

Then run:

docker pull jc5x/firefly-iii:latest

Upgrade the database with these commands:

docker exec -it <container> php artisan migrate
docker exec -it <container> php artisan firefly:upgrade-database
docker exec -it <container> php artisan firefly:verify
docker exec -it <container> php artisan passport:install
docker exec -it <container> php artisan cache:clear

Then you can visit the container again.

If you’re having trouble with (parts of) this step, please check out the Docker FAQ

Docker Hub with automatic updates via docker compose

“Docker compose” is a tool that can automatically set up and link several docker containers using just one command and a YAML configuration file. This is easier than building the containers manually.

Download compose file

Download the compose file located in the Github repository and place it somewhere convenient.

Edit the file

Modify the following variables in the docker compose file. This is not mandatory but highly recommended for security purposes.

  • POSTGRES_PASSWORD
  • FF_DB_PASSWORD
  • FF_APP_KEY

Keep in mind that POSTGRES_PASSWORD and FF_DB_PASSWORD have to be identical. POSTGRES_PASSWORD is used to initialise the database, and FF_DB_PASSWORD is used to connect to the database. So if these variables are different, it won’t run.

Also keep in mind that FF_APP_KEY must be exactly 32 characters long.

Start the container

Run the following command:

docker-compose -f docker-compose.yml up -d

Initialize the database

If this is the first time you’re running Firefly III then you must initialize the database. Use the following commands to do so:

docker-compose exec firefly_iii_app php artisan migrate --seed
docker-compose exec firefly_iii_app php artisan firefly:upgrade-database
docker-compose exec firefly_iii_app php artisan firefly:verify
docker-compose exec firefly_iii_app php artisan passport:install
docker-compose exec firefly_iii_app php artisan cache:clear

Surf to Firefly III

You can now visit Firefly III at http://localhost or http://docker-ip:port if it is running on a custom port.

If you’re having trouble with (parts of) this step, please check out the Docker FAQ

Upgrade

To update the container just run docker-compose pull firefly_iii_app && docker-compose restart firefly_iii_app. You can even add this command to a chrontab. Before you visit it again, upgrade the database:

docker-compose exec -T firefly_iii_app php artisan migrate
docker-compose exec -T firefly_iii_app php artisan firefly:upgrade-database
docker-compose exec -T firefly_iii_app php artisan firefly:verify
docker-compose exec -T firefly_iii_app php artisan passport:install
docker-compose exec -T firefly_iii_app php artisan cache:clear

If you’re having trouble with (parts of) this step, please check out the Docker FAQ

Docker Hub with automatic updates via run/pull

This will let you manually start the two docker containers you need to run Firefly III. One is for the database, the second is for the app itself.

Create some volumes

These are used to persistently store uploaded files and exported data.

docker volume create firefly_iii_export
docker volume create firefly_iii_upload
docker volume create firefly_iii_db

Run command

Use the following run commands as a template.

Change the following variables in the commands you see in the block below. This is not mandatory but highly recommended.

  • POSTGRES_PASSWORD must be changed to a suitable database password of your choice.
  • FF_DB_PASSWORD must be equal to this password.
  • FF_APP_KEY

Keep in mind that POSTGRES_PASSWORD and FF_DB_PASSWORD have to be identical. POSTGRES_PASSWORD is used to initialise the database, and FF_DB_PASSWORD is used to connect to the database. So if these variables are different, it won’t run.

Also keep in mind that FF_APP_KEY must be exactly 32 characters long.

Then run the commands you see here.

To start the database:

docker run -d \
--name=firefly_iii_db \
-e POSTGRES_PASSWORD=firefly \
-e POSTGRES_USER=firefly \
-v firefly_iii_db:/var/lib/postgresql/data \
postgres:10

Then, to start Firefly III itself:

docker run -d \
--name=firefly_iii_app \
--link=firefly_iii_db \
-e FF_DB_HOST=firefly_iii_db \
-e FF_DB_CONNECTION=pgsql \
-e FF_DB_NAME=firefly \
-e FF_DB_USER=firefly \
-e FF_DB_PASSWORD=firefly \
-e FF_APP_KEY=S0meRandomStr1ngOf32CharsExactly \
-e FF_APP_ENV=local \
-p 80:80 \
-v firefly_iii_export:/var/www/firefly-iii/storage/export \
-v firefly_iii_upload:/var/www/firefly-iii/storage/upload \
jc5x/firefly-iii

Initialize the database

If this is the first time you’re running Firefly III then you must initialize the database. Use the following commands to do so:

docker exec firefly_iii_app php artisan migrate --seed
docker exec firefly_iii_app php artisan firefly:upgrade-database
docker exec firefly_iii_app php artisan firefly:verify
docker exec firefly_iii_app php artisan passport:install
docker exec firefly_iii_app php artisan cache:clear

Surf to Firefly III

You can now visit Firefly III at http://localhost or http://docker-ip:port if it is running on a custom port.

Upgrade

To update the container just run docker stop firefly_iii_app && docker pull jc5x/firefly-iii && docker start firefly_iii_app. You can even add this command to a chrontab. Before you visit it again, upgrade the database:

docker exec -it <container> php artisan migrate
docker exec -it <container> php artisan firefly:upgrade-database
docker exec -it <container> php artisan firefly:verify
docker exec -it <container> php artisan passport:install
docker-compose exec firefly_iii_app php artisan cache:clear

If you’re having trouble with (parts of) this step, please check out the Docker FAQ

Docker and reverse proxies

In the .env file you will find a variable called TRUSTED_PROXIES which must be set to either the reverse proxy machine or simply **. Set APP_URL to the URL you wish Firefly III to be on (ie. the proxy). For example:

# ...
APP_URL=https://firefly.example.com
TRUSTED_PROXIES=**
# ...

On the command line, this would be:

-e FF_DB_HOST=mysql \
-e FF_DB_NAME=firefly \
-e FF_DB_USER=firefly \
-e FF_DB_PASSWORD=somepw \
-e FF_APP_KEY=some-secret-string \
-e FF_APP_ENV=local \
-e APP_URL=https://firefly.example.com \
-e TRUSTED_PROXIES=** \

If you wish to enable SSL as well, Firefly III (or rather Laravel) respects the HTTP header X-Forwarded-Proto. Add this to your vhost file:

RequestHeader set X-Forwarded-Proto "https"

If you are using Nginx add the following to your location block:

proxy_set_header X-Forwarded-Proto $scheme;

If you’re having trouble with (parts of) this step, please check out the Docker FAQ

Supported Docker environment variables

There are many environment variables that you can set in Firefly III. Just check out the default docker env file that lists them all. Each value within ${BRACKETS} can be replaced on the command line.