yhyzgn/tikeo-server repository overview

⁠Tikeo Server

Tikeo Server is the control-plane runtime for scheduled jobs, workflow dispatch, Worker Tunnel coordination, execution logs, notification delivery, audit evidence, and management APIs.

⁠Image tags

• latest — latest stable release.
• v${TIKEO_VERSION} — exact Git release tag placeholder. Replace ${TIKEO_VERSION} with the release badge version.
• ${TIKEO_VERSION} — semantic-version alias when published.

Pin an exact version in production; use latest for quick evaluation.

⁠Ports

⁠Configuration, mounts, and runtime files

Use structured database config in config/tikeo.yml instead of a single URL. Passwords with @, /, :, or # do not need manual escaping.

⁠Quick start with docker run

docker network create tikeo 2>/dev/null || true
docker volume create tikeo-data
docker volume create tikeo-logs
mkdir -p ./tikeo/config/tls
cp config/tikeo.yml ./tikeo/config/tikeo.yml

docker run -d \
  --name tikeo-server \
  --network tikeo \
  -p 9090:9090 \
  -p 9998:9998 \
  -v "$PWD/tikeo/config/tikeo.yml:/config/tikeo.yml:ro" \
  -v "$PWD/tikeo/config/tls:/config/tls:ro" \
  -v tikeo-data:/data \
  -v tikeo-logs:/logs \
  --restart unless-stopped \
  yhyzgn/tikeo-server:latest \
  serve --config /config/tikeo.yml

curl -fsS http://127.0.0.1:9090/readyz

⁠Docker Compose

Use the repository Compose files:

cp deploy/compose/tikeo.env.example .env
# Edit .env for Docker parameters; edit config/tikeo.yml for Tikeo service settings.
docker compose --env-file .env pull
docker compose --env-file .env up -d

For PostgreSQL/MySQL stacks, set storage.database.type, host, port, username, password, and database in config/tikeo.yml, then use docker-compose.postgres.yml or docker-compose.mysql.yml.

⁠Health checks

curl -fsS http://127.0.0.1:9090/healthz
curl -fsS http://127.0.0.1:9090/readyz
curl -fsS http://127.0.0.1:9090/api-docs/openapi.json >/tmp/tikeo-openapi.json

⁠Related images

• Web console: yhyzgn/tikeo-web
• Documentation site: yhyzgn/tikeo-docs