Skip to main content

Installation

gokakashi has the following software components:

  • Postgres Database : For all the data storage.
  • gokakashi Server : Serves the API and dashboard UI.
  • gokakashi CLI : Used for automations.

Using Docker

The following software are required for this installation method:

Download the docker-compose configuration using curl:

curl -o docker-compose.yml https://raw.githubusercontent.com/shinobistack/gokakashi/refs/heads/main/docker/compose/releases/latest.yaml

or using wget:

wget -O docker-compose.yml https://raw.githubusercontent.com/shinobistack/gokakashi/refs/heads/main/docker/compose/releases/latest.yaml

The above instruction will install the latest stable version of gokakashi. You can replace latest.yaml in the URL with edge.yaml to use the latest main branch build, where active development is happening.

Change the POSTGRES_PASSWORD and DB_PASSWORD environment variable values in the docker-compose.yml file to secure values of your choice.

Bring up the containers using docker-compose.

docker compose up -d