Using Quilkin

There are two choices for running Quilkin:

  • Binary
  • Container image

For each version there is both a release version, which is optimised for production usage, and a debug version that has debug level logging enabled.

Binary

The release binary can be downloaded from the Github releases page.

Quilkin needs to be run with an accompanying configuration file, like so:

quilkin run --config="configuration.yaml"

To view debug output, run the same command with the quilkin-debug binary.

You can also use the shorthand of -c instead of --config if you so desire.

Container Image

For each release, there are both a release and debug container image built and hosted on Google Cloud Artifact Registry listed for each release.

The production release can be found under the tag:

us-docker.pkg.dev/quilkin/release/quilkin:{version}

Whereas, if you need debugging logging, use the following tag:

us-docker.pkg.dev/quilkin/release/quilkin:{version}-debug

Mount your configuration file at /etc/quilkin/quilkin.yaml to configure the Quilkin instance inside the container.

A default configuration is provided, such the container will start without a new configuration file, but it is configured to point to 127.0.0.1:0 as a no-op configuration.

What's next: