Using Docker

Where is the Dockerfile?

See this separate repository on Azure. The Firefly III image is built there as well.

Can I run it under a reverse proxy from a subdirectory?

• Can I host it under a sub-folder in a reverse-proxy?

Yes. For the standard Docker image, follow these instructions on GitHub

Installed a standalone Apache server, to act as an TLS-terminator.

<IfModule mod_ssl.c>
<VirtualHost *:443>
        ServerAdmin webmaster@localhost
        DocumentRoot /var/www/html

        ErrorLog ${APACHE_LOG_DIR}/error.log
        CustomLog ${APACHE_LOG_DIR}/access.log combined

        ServerName ...
        SSLCertificateFile /etc/letsencrypt/live/.../fullchain.pem
        SSLCertificateKeyFile /etc/letsencrypt/live/.../privkey.pem
        Include /etc/letsencrypt/options-ssl-apache.conf

        <Location /accounts>
            ProxyAddHeaders Off
            RequestHeader unset Accept-Encoding
            ProxyPass http://localhost:8087
            ProxyPassReverse http://localhost:8087
            AddOutputFilterByType SUBSTITUTE text/html
            Substitute "s|http://localhost:8087/|https://.../accounts/|i"
        </Location>
</VirtualHost>
</IfModule>

ProxyAddHeaders is off to prevent Apache sending the X-Forward headers to Firefly III, otherwise the URLs it populates in the response will include the correct website, but not the correct path.

Unsetting the Accept-Encoding header ensures that the response from Firefly III is not compressed, otherwise the Substitute directive won't work.

ProxyPass and ProxyPassReverse act as you would expect, so that Firefly III will appear under the "accounts" directory.

The AddOutputFilterByType and Substitute directives alter the pages returned from Firefly III, replacing the localhost URLs with the website's URL. Replace "..." with your website address.

Thanks to @cartbar!

I get 'permission denied' errors on the cache folder

This is caused by a permissions issue. Run the following command:

• docker exec -it <container> php artisan cache:clear

Or browse to the /flush page in your installation.

I see a lot of log entries from the "Firefly III Health Checker"

This is normal. The health checker is called by Docker to see if Firefly III is still up and running.

I get "Function not implemented: AH00141: Could not initialize random number generator"

This is an error that happens on Synology boxes with an old kernel. I'm sorry, there is nothing I can do for you.

The database password is wrong, but I'm 100% sure it's correct

If you start the database container with a MYSQL_PASSWORD that you change later, it won't change in the database. Destroy the volume + container and start over.

I get 'failed to open stream: Permission denied' on log files

This is caused by a permissions issue. Often, this is caused by cron jobs running under root, not www-data.

All your Docker commands must run as www-data, also in cron jobs:

• docker exec [container] --user www-data /usr/local/bin/php /var/www/html/artisan firefly-iii:cron

How do I debug a cron job on Docker?

Enable debug mode. Open a new terminal window, and tail the logs from your Firefly III docker container:

docker logs -f CONTAINERID

Fire the cron job again from another terminal window, with the following command.

docker exec --user www-data CONTAINERID /usr/local/bin/php /var/www/html/artisan firefly-iii:cron --date=2021-02-01

In the command you see a date. Change it to be the first day of the current month in the format YYYY-MM-DD.