Installation Tutorial

GNUKhata consists of a Pyramid back-end, Vue front-end and PostgreSQL as database.

GNUKhata primarily supports docker based installation. GNUKhata front-end and back-end can be individually installed too.

Docker Installation

To install GNUKhata, following packages must be installed, - docker - docker-compose

Download the installation script - install.sh
Change permission for the script chmod u+x install.sh
Run sh install.sh [path_to_configuration_file]
Configuration file is optional, the available configurations are here.
If you are making a custom configuration file, it should have VITE_GKCORE_URL mentioned in it. In most cases, for local install, the value for VITE_GKCORE_URL would be http://localhost:6543

Note: Since GNUKhata is currently under development, you will have to use following configurations to install the development version.

GKCORE_IMAGE=digitalfreedom/gkcore:devel
GKAPP_IMAGE=digitalfreedom/gkapp:devel

Create and move to project directory - mkdir gnukhata && cd gnukhata
Download the build compose file, curl -O https://gitlab.com/gnukhata/build/-/raw/master/docker-compose.yml 1- Load the docker container - docker-compose --profile frontend up -d
To add configurations, add --env_file path_to_configuration_file to above command. Available configurations are listed here.
To stop running GNUKhata, run - docker-compose down

Create docker group. sudo groupadd docker
Add user to docker group. sudo usermod -aG docker $USER
Switch session to docker group. newgrp - docker
Run script/docker commands in the same terminal.
If you still get any errors, make sure the docker service is up and running. systemctl status docker.service
If docker is not running, start it using tthe following command: sudo systemctl start docker.service
If you want to avoid starting docker every time manually, enable the service to autostart on every login: sudo systemctl enable docker.service