#Getting started

Docker is the shortest path. Once it runs, come back to Installation for database and reverse-proxy options.

#Requirements

PostgreSQL is the database Geekit is deployed and operated on, and that will not change. SQLite and MySQL remain supported by the ORM, mainly for local runs and tests.

#With Docker Compose

git clone https://github.com/yirenyiqi/geekit.git
cd geekit

# Adjust database, ports, and timezone
nano docker-compose.yml

docker compose up -d

#With docker run

docker pull yirenyiqi/geekit:latest

docker run --name geekit -d --restart always \
  -p 8801:8801 \
  -e TZ=Asia/Shanghai \
  -v ${HOME}/.docker-volumn/geekit/geekit:/data \
  -v ${HOME}/.docker-volumn/geekit/sqlite:/sqlite \
  yirenyiqi/geekit:latest

Add SQL_DSN to point at a remote database:

  -e SQL_DSN="postgres://geekit:PASSWORD@db-host:5432/geekit"

/data holds runtime data and /sqlite holds the SQLite database file; each is mounted to its own host directory.

#Verify

Open http://<host>:8801. The health endpoint is /api/status; JSON back means the service is up:

curl -s http://localhost:8801/api/status

Sign in with the initial administrator account, change the password immediately, then configure upstream channels in the dashboard.

#Upgrading

Pull the new image and recreate the container. Schema and data changes live in the repository's migration/ directory and replay automatically at startup; no manual SQL is required.

docker pull yirenyiqi/geekit:latest
docker compose up -d