Tikeo Docs site for deployment, configuration, SDK, worker, and troubleshooting guides.
2.6K
Tikeo Docs is the versioned documentation site for deploying, configuring, integrating, and operating Tikeo.
This image is a static Docusaurus build served by nginx. It stores no product data and normally needs no persistent mount.
latest — latest stable release.v${TIKEO_VERSION} — exact Git release tag placeholder.${TIKEO_VERSION} — semantic-version alias when published.tikeo-docs has no database, upload directory, or runtime config. nginx logs go to stdout/stderr. If deployed with Server, persist Server runtime files instead:
| Component | Path | Mount guidance |
|---|---|---|
| Server config | /config/tikeo.yml | Mount read-only when config should live outside the image. |
| Server TLS files | /config/tls | Mount read-only for process-level TLS/mTLS. |
| Server SQLite data | /data/tikeo.db | Persist /data only for SQLite mode. |
| Server file logs | /logs/tikeo.log | Enable in config/tikeo.yml with observability.logging.log_dir: /logs. |
| Docs static image | none | No persistent mount required. |
When running the full stack, use the repository Compose files and keep Server settings in config/tikeo.yml:
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
open http://127.0.0.1:8081
| Port | Purpose |
|---|---|
80 | nginx static documentation site. |
docker run -d \
--name tikeo-docs \
-p 8081:80 \
--restart unless-stopped \
yhyzgn/tikeo-docs:latest
open http://127.0.0.1:8081
Content type
Image
Digest
sha256:ce2ac7736…
Size
31.4 MB
Last updated
3 months ago
docker pull yhyzgn/tikeo-docs