kdy.ch
1# Knot Docker
2
3> **IMPORTANT**
4> This is a community maintained repository, support is not guaranteed.
5
6Docker container and compose setup to run a [Tangled](https://tangled.sh) knot
7and host your own repository data.
8
9## Pre-built Images
10
11There is a [repository](https://hub.docker.com/r/hqnna/knot) of pre-built images
12for tags starting at `v1.4.0-alpha` if you prefer.
13
14```
15docker pull hqnna/knot:v1.4.0-alpha
16```
17
18Note that these are *not* official images, you use them at your own risk.
19
20## Building The Image
21
22By default the `Dockerfile` will build the latest tag, but you can change it
23with the `TAG` build argument.
24
25```sh
26docker build -t knot:latest --build-arg TAG=master .
27```
28
29The command above for example will build the latest commit on the `master`
30branch.
31
32<hr style="margin-bottom: 20px; margin-top: 10px" />
33
34When using compose, it can be specified as a build argument which will be
35passed to the builder.
36
37```yaml
38build:
39 context: .
40 args: { TAG: master }
41```
42
43This will for example tell docker to build it using the `master` branch like
44the command.
45
46## Setting Up The Image
47
48The simplest way to set up your own knot is to use the provided compose file
49and run the following:
50
51```sh
52export KNOT_SERVER_HOSTNAME=example.com
53export KNOT_SERVER_OWNER=did:plc:yourdidgoeshere
54export KNOT_SERVER_PORT=443
55docker compose up -d
56```
57
58This will setup everything for you including a reverse proxy.