Upgrade

General upgrade instructions

Firefly III can upgrade itself from very old versions, even back from 4.7.x. In some cases the upgrade process is destructive. It will remove transactions, delete accounts or clean up data.

Docker

Docker Compose

To update the container run these commands:

docker compose stop
docker compose -f docker-compose.yml up -d --pull=always

If you re-download docker-compose.yml, keep in mind that the database version in the Docker composer may have been updated and that this version is not compatible with your current version (ie MariaDB 10 vs MariaDB 11).

Virtual or real server

Be sure to check out this script by GitHub user @pedrom34 in this Gist.

Upgrade straight from Docker Hub

To upgrade, stop and remove your container using these commands:

docker stop <container>
docker rm <container>

To find out which container is Firefly III, run docker container ls -a.

docker pull fireflyiii/core:latest

And then create it again by running the command from the installation guide. The container should upgrade itself, so it can take some time for it to start. You can save the command you've used to start the container for quicker upgrade.

If you want to run the Docker container as another user, add --user=. Possible values are user, user:group,uid, uid:gid, user:gid, uid:group.

Created using composer "create-project"

The best way to upgrade is to "reinstall" Firefly III using the following command:

composer create-project grumpydictator/firefly-iii --no-dev --prefer-dist firefly-iii-updated <next_version>

Where <next_version> is the latest version of Firefly III. This installs Firefly III in a new directory called firefly-iii-updated. Assuming your original Firefly III installation is in the directory firefly-iii you can upgrade by moving over your .env file and other stuff:

cp firefly-iii/.env firefly-iii-updated/.env
cp firefly-iii/storage/upload/* firefly-iii-updated/storage/upload/
cp firefly-iii/storage/export/* firefly-iii-updated/storage/export/

If you use SQLite as a database system (you will know if you do) copy your database as well. Otherwise, the .env-file is enough.

Then, run the following commands to finish the upgrade:

cd firefly-iii-updated
rm -rf bootstrap/cache/*
php artisan cache:clear
php artisan migrate --seed
php artisan firefly-iii:upgrade-database
php artisan passport:install
php artisan cache:clear
cd ..

To ensure your webserver serves you the new Firefly III:

mv firefly-iii firefly-iii-old
mv firefly-iii-updated firefly-iii

If you get 500 errors or other problems, you may have to set the correct access rights:

sudo chown -R www-data:www-data firefly-iii
sudo chmod -R 775 firefly-iii/storage

Remove any old PHP packages or at least, they must not be used by Apache and/or nginx. To disable old PHP versions in Apache, you can use:

# to disable
sudo a2dismod php7.x 
# to enable
sudo a2enmod php7.x
# restart apache 2
sudo service apache2 restart

This assumes you run Apache and your OS package manager can handle multiple PHP versions (not all of them do this). Other commands can be found using a search engine.

Straight from GitHub

Back up your entire installation directory, and database.

Go to the firefly-iii folder and run these commands.

git pull
# alternatively, use:
# git pull origin [version]
rm -rf bootstrap/cache/*
rm -rf vendor/
composer install --no-scripts --no-dev
composer install --no-dev
php artisan migrate --seed
php artisan firefly-iii:decrypt-all
php artisan cache:clear
php artisan firefly-iii:upgrade-database
php artisan passport:install
php artisan cache:clear

Heroku

Backup the PGS database from Heroku's dashboard, then create a new application (or destroy the database on your existing one). Instructions to do so are on this page. Spin up your new Firefly III Heroku installation, then import the backup by following these instructions on this page.

Firefly III will then set itself up, and you should be good to go from right where you left off on your previous installation.