Once everything is configured in the Dockerfile, the next step is to build the container. SCALEWAY_SECRET_ACCESS_KEY: The API secret key from Scaleway's Credentials page (corresponding to access key ID).SCALEWAY_ACCESS_KEY_ID: The API access key ID from Scaleway's Credentials page.SCALEWAY_S3_BUCKET: The name of the Scaleway Object Storage S3 bucket you created.NUM_TRANSACTIONS: The number of most recent transactions to display on the Transactions page.This is the name of the directory your GnuCash GitHub repository will be cloned to in the docker container. GNUCASH_DIR: You can leave this set to its default value.GNUCASH_FILE: This is the file name of your GnuCash file as it exists on your server.There are several variables to configure: You can download the latest docker image of GnuCash Helper by running the following command from your *nix terminal:ĭocker pull bxbrenden/gnucash-helper:latest Configuration See the official GnuCash page on formatting for instructions on saving your GnuCash file as sqlite3. This project can only work with GnuCash files saved in sqlite3 format. GnuCash has several file formats available, including sqlite3, postgresql, and xml. Installation instructions for nginx and docker are beyond the scope of this readme.
#GNUCASH SOURCE CODE INSTALL#
Therefore, you should install nginx and docker. It is recommended you run this program as a Docker container on port 8000 on a GNU/Linux-based distro behind an nginx reverse proxy with TLS. gnucash file creates a new version within the bucket.
Note: please make sure to set up your bucket in the nl-ams region, as this value is currently hard-coded in gnucash-helper.Īdditional Note: Make sure to enable Object Versioning in the S3 bucket so each new write to your. Start the program, specifying arguments that may affect the general. GDB basically helps us to do four main things to catch flaws in the source code.
#GNUCASH SOURCE CODE CODE#
In order to configure Scaleway, follow their Object Storage quickstart guide. GNU Debugger, also known as gdb, allows us to sneak through the code while it executes or what a program was trying to do at the moment before it crashed. I realize it's not ideal for a FLOSS project to depend on a cloud provider, but managing Syncthing was proving too tiresome. Using an S3 backend simplifies deployment because S3 serves as a single source of truth for the latest version of the file. Starting in version 0.5.0, gnucash-helper uses Scaleway Object Storage (S3-compatible) to store its. In order to use gnucash-helper as-is, you will need to have a Scaleway account. Scaleway is a cloud provider that offers services in France, Netherlands, and Poland. Once your GnuCash file is configured in the real GnuCash, GnuCash Helper can be run as a standalone tool for simple budgeting.
Gnucash-helper is a small Flask app for entering and viewing GnuCash transactions and account balances from a web browser.