arturklauser/gnucash repository overview

⁠GnuCash

This image runs GnuCash with a web-based GUI, accessible via HTTPS.

⁠Usage

⁠Docker Compose

1. Create a docker-compose.yml file with the following content:

   services:
     gnucash:
       image: arturklauser/gnucash:v1.2.0
       container_name: gnucash
       restart: unless-stopped
       ports:
         - "5800:5800"
       volumes:
         - "${CONFIG_DIR:-./config}:/config:rw"
         - "${DATA_DIR:-./data}:/data:rw"
       environment:
         - TZ=${TZ:-America/Los_Angeles}
         - USER_ID=${USER_ID:?unset}
         - GROUP_ID=${GROUP_ID:?unset}
         - WEB_AUTHENTICATION
         - WEB_AUTHENTICATION_USERNAME
         - WEB_AUTHENTICATION_PASSWORD
         - OAUTH2_PROXY
   

   Copy

2. Create the volume directories:

   mkdir config data
   

   Copy

3. Run the container:

   USER_ID=$(id -u) GROUP_ID=$(id -g) docker compose up -d
   

   Copy
   • Note: You can optionally set the CONFIG_DIR and DATA_DIR environment variables to override the default host paths for the configuration and data directories.

4. Access the interface at https://localhost:5800⁠.

   • Note: A self-signed certificate is generated by default, causing browser warnings. To avoid this, install your own certificate in /config/certs.

5. Shut down the container:
   The container is designed to run continuously. To shut it down, first quit GnuCash in the GUI to release the lock on the data file. Then run:

   USER_ID=$(id -u) GROUP_ID=$(id -g) docker down
   

   Copy

⁠Docker CLI

docker run -d \
  --name=gnucash \
  -p 5800:5800 \
  -v ${CONFIG_DIR:-$(pwd)/config}:/config:rw \
  -v ${DATA_DIR:-$(pwd)/data}:/data:rw \
  -e USER_ID=$(id -u) \
  -e GROUP_ID=$(id -g) \
  arturklauser/gnucash:v1.2.0

⁠More Information

For more details, configuration options, and source code, please visit the GitHub repository⁠.