Container images for the Tangled Knot and Spindle servers
psychedeli.ca
1# Tangled Containers
2
3Container images for the [Tangled][] knot and spindle servers. All tagged
4versions of `@tangled.org/core` are supported, as well as directly from the
5`master` branch.
6
7## Usage
8
9Start a Knot Server:
10
11```sh
12docker run --name knot -e KNOT_SERVER_HOSTNAME=example.com -e KNOT_SERVER_OWNER=did:plc:yourdidgoeshere tubbo/knot
13```
14
15Start a Spindle Server:
16
17```sh
18docker run --name spindle -e SPINDLE_SERVER_HOSTNAME=example.com -e SPINDLE_SERVER_OWNER=did:plc:yourdidgoeshere tubbo/spindle
19```
20
21### Supported tags
22
23- `latest` for the most recently tagged version
24- `v1.x.x-alpha` to specify the tag
25- `edge` to use the most recent Git commit to `master`
26
27## Development
28
29Images are built with [Docker Bake][], using [mise][] as a task runner and
30toolchain installer.
31
32To contribute to this repository, clone it from Tangled:
33
34```sh
35git clone https://tangled.org/@psychedeli.ca/tangled-containers
36cd tangled-containers
37```
38
39Install dependencies with [mise][]:
40
41```sh
42mise install
43```
44
45Then, build the most recent images by running:
46
47```sh
48mise build
49```
50
51[Tangled]: https://tangled.org
52[Docker Bake]: https://docs.docker.com/build/bake/
53[mise]: https://mise.jdx.dev