Running in Docker

Running in Kubernetes

To run Cayley in K8S check this docs section.

Running in a container

A container exposing the HTTP API of Cayley is available.

Running with default configuration

Container is configured to use BoltDB as a backend by default.

docker run -p 64210:64210 -d ghcr.io/cayleygraph/cayley

New database will be available at http://localhost:64210.

Custom configuration

To run the container one must first setup a data directory that contains the configuration file and optionally contains persistent files (i.e. a boltdb database file).

mkdir data
cp cayley_example.yml data/cayley.yml
cp data/testdata.nq data/my_data.nq
# initialize and serve database
docker run -v $PWD/data:/data -p 64210:64210 -d ghcr.io/cayleygraph/cayley -c /data/cayley.yml --init -i /data/my_data.nq
# serve existing database
docker run -v $PWD/data:/data -p 64210:64210 -d ghcr.io/cayleygraph/cayley -c /data/cayley.yml

Other commands

Container runs cayley http command by default. To run any other Cayley command reset the entry point for container:

docker run -v $PWD/data:/data ghcr.io/cayleygraph/cayley --entrypoint=cayley version