Skip to content

docker

Manage a self-hosted Sibyl Docker deployment. docker generates a pinned compose stack under ~/.sibyl/docker, starts and stops it, tails its logs, and upgrades it to new image tags. It is the production-leaning path: explicit image tags, generated secrets, and optional worker and crawler services.

For the simpler, batteries-included local instance, use sibyl local (and its sibyl up / sibyl down aliases) instead.

Commands

CommandDescription
sibyl docker initGenerate pinned compose files under ~/.sibyl/docker
sibyl docker upStart the Docker deployment
sibyl docker logsShow Docker deployment logs
sibyl docker downStop the Docker deployment
sibyl docker upgradePull current images and recreate containers

docker init

Generate pinned compose and env files under ~/.sibyl/docker and create a matching context.

bash
sibyl docker init [options]
OptionShortDefaultDescription
--api-port3334Host API port
--web-port3337Host web port
--surreal-port8000Host SurrealDB port
--tag(CLI version)Sibyl image tag
--with-workerfalseAdd Valkey and a worker service
--with-crawlerfalseUse the crawler-enabled API image
--contextdockerContext name to create
--activate / --no-activateonSet the created context active
--force-ffalseOverwrite existing files

Examples

bash
# Generate the default stack and activate its context
sibyl docker init

# Pin a tag and add the worker + crawler services
sibyl docker init --tag 1.1.5 --with-worker --with-crawler

# Regenerate over an existing install
sibyl docker init --force

docker up

Start the deployment. Requires an initialized runtime and a working Docker install.

bash
sibyl docker up [options]
OptionDefaultDescription
--pullfalsePull images before starting

docker logs

Show deployment logs. Pass a service name to scope the output.

bash
sibyl docker logs [service] [options]
ArgumentRequiredDescription
serviceNoOptional service name
OptionShortDefaultDescription
--follow / --no-follow-fonFollow log output
--tail100Number of lines to show

docker down

Stop the deployment.

bash
sibyl docker down [options]
OptionShortDefaultDescription
--volumes-vfalseAlso remove volumes

docker upgrade

Pull current images and recreate containers, optionally writing a new image tag first.

bash
sibyl docker upgrade [options]
OptionDefaultDescription
--tag(none)Write a new image tag

Example

bash
sibyl docker upgrade --tag 1.1.5

Notes

  • Ports bind to 127.0.0.1 only. The API is published on the API port, the web UI on the web port, and SurrealDB on the SurrealDB port.
  • init generates a SurrealDB password and JWT secret into a 0600 env file; keep that file safe.
  • The worker service requires Valkey, which --with-worker adds and wires up automatically.
  • Most subcommands refuse to run until you have run docker init.

Released under the Apache-2.0 License.