The instructions below will get Clutch up and running in a Docker container.
If building the binary outside of a container is preferred, see the Local Build docs.
Docker is required to use the examples below, see Get Docker for information on installing Docker itself.
Using the Docker Container
Running the Image
On every commit to the main branch, a Docker image is built and published to Docker Hub tagged with
latest and the commit SHA in the form of
The default configuration in
backend/clutch-config.yaml is used.
If desired, use a custom configuration with the Docker image by mapping it into the container.
- Default Configuration
- Custom Configuration
- With Environment Variables
To update the image on subsequent uses of the container:
For more information on configuring Clutch, see the Configuration Reference.
🎉 Clutch should now be accessible from
localhost:8080 in the browser.
Building the Container From Scratch
Cloning the Repository
Start by cloning the Clutch repository and entering into the source directory.
Building the Image
Build the Docker image locally. The frontend will build followed by the backend. The frontend is copied into the backend and compiled into a single binary.
Running the Local Image
Use the commands from the earlier step Running the Image, replacing
docker run --rm -p 8080:8080 -it clutch and access Clutch in the browser.