Skip to content
Mike Perham edited this page Dec 7, 2021 · 7 revisions

This page collects tips and tricks for deploying and using Faktory within Docker.

Setup

Read-only Configuration

Faktory expects configuration files in /etc/faktory/conf.d. Mount your config directory into the container at this location using -v /my/local/config/path:/etc/faktory/conf.d.

Mutable Storage

Faktory uses Redis under the covers and looks for its data in /var/lib/faktory/db. Mount a persistent volume here so that your data does not disappear if the container restarts: -v /redis/data/path:/var/lib/faktory/db.

Installation

Installation is very easy with the public Docker images. See the Installation wiki page for full details.

Commercial

If you are using Faktory Pro or Enterprise, these tips will help.

Development

Remember that each release contains a macOS binary for Pro/Ent which can be used without a license to trial functionality and develop your application.

License

Use Docker Secrets and mount the license at /etc/faktory/license or a FAKTORY_LICENSE environment variable.

Repository

Faktory Enterprise has a private repository with Docker images. See Ent-Installation wiki pages for how to use them.

Kubernetes

Lots of detail in Issue 19 and Kubernetes Deployment Example.

Probes

Probes allow Kubernetes to monitor the health of a container. Faktory has two ports: Command on 7419 and Web UI on 7420.

For the Web UI, you can probe http://localhost:7420/stats to fetch the current Faktory stats in JSON form. This is the lightest weight Web UI endpoint. In production you will need to configure HTTP Basic Auth via the httpHeaders option (example).

For the Command Port, you can use a TCP probe to port 7419.

See Configuring Probes for more detail.