🐳 Running a Calckey instance with Docker
Pre-built docker container
There is a
docker-compose.yml in the root of the project that you can use to build the container from source
- .config/docker.env (db config settings)
- .config/default.yml (calckey instance settings)
Rename the files:
cp .config/default_example.yml .config/default.yml
cp .config/example.env .config/docker.env
then edit them according to your environment.
You can configure
docker.env with anything you like, but you will have to pay attention to the
urlshould be set to the URL you will be hosting the web interface for the instance at.
passwill have to be configured in the
PostgreSQL configurationsection -
hostis the name of the postgres container (eg: calckey_db_1), and the others should match your
hostwill need to be configured in the Redis configuration section - it is the name of the redis container (eg: calckey_redis_1)
Everything else can be left as-is.
The prebuilt container for calckey is fairly large, and may take a few minutes to download and extract using docker.
docker-compose.yml and the
config/ to a directory, then run the docker-compose command:
docker-compose up -d.
NOTE: This will take some time to come fully online, even after download and extracting the container images, and it may emit some error messages before completing successfully. Specifically, the
db container needs to initialize and so isn't available to the
web container right away. Only once the
db container comes online does the
web container start building and initializing the calckey tables.
Once the instance is up you can use a web browser to access the web interface at
serverip is the IP of the server you are running the calckey instance on).
Docker for development
cd dev/ docker-compose build docker-compose run --rm web pnpm run init docker-compose up -d