···11-# tubbo/spindle
11+# Tangled Containers
2233-A container image for the Spindle CI server.
33+Container images for the [Tangled][] knot and spindle servers. All tagged
44+versions of `@tangled.org/core` are supported, as well as directly from the
55+`master` branch.
4657## Usage
6877-Set your configuration in a `.env` file:
99+Start a Knot Server:
81099-```env
1010-SPINDLE_SERVER_HOSTNAME="your.spindle.server.host"
1111-SPINDLE_SERVER_OWNER="did:web:your.handle"
1111+```sh
1212+docker run --name knot -e KNOT_SERVER_HOSTNAME=example.com -e KNOT_SERVER_OWNER=did:plc:yourdidgoeshere tubbo/knot
1213```
13141414-Create a `compose.yml` to configure the Spindle service, or add it to
1515-an existing Compose file:
1515+Start a Spindle Server:
16161717-```yaml
1818-name: tangled
1919-services:
2020- spindle:
2121- image: tubbo/spindle:latest
2222- environment:
2323- - SPINDLE_SERVER_HOSTNAME
2424- - SPINDLE_SERVER_OWNER
2525- volumes:
2626- - certs:/app
2727- - pipelines:/var/log/spindle
2828- caddy:
2929- image: caddy:alpine
3030- command: >
3131- caddy reverse-proxy --from ${SPINDLE_SERVER_HOSTNAME} --to spindle:6555
3232- depends_on:
3333- - spindle
3434- ports:
3535- - 443:443
3636- - 443:443/udp
3737- volumes:
3838- - caddy:/data
3939-volumes:
4040- certs:
4141- spindle:
4242- pipelines:
1717+```sh
1818+docker run --name spindle -e SPINDLE_SERVER_HOSTNAME=example.com -e SPINDLE_SERVER_OWNER=did:plc:yourdidgoeshere tubbo/spindle
4319```
44204545-Run the Spindle server and its Caddy frontend:
2121+### Supported tags
2222+2323+- `latest` for the most recently tagged version
2424+- `v1.x.x-alpha` to specify the tag
2525+- `edge` to use the most recent Git commit to `master`
2626+2727+## Development
2828+2929+Images are built with [Docker Bake][], using [mise][] as a task runner and
3030+toolchain installer.
3131+3232+To contribute to this repository, clone it from Tangled:
46334734```sh
4848-docker compose up --detach
3535+git clone https://tangled.org/@psychedeli.ca/tangled-containers
3636+cd tangled-containers
3737+```
3838+3939+Install dependencies with [mise][]:
4040+4141+```sh
4242+mise install
4343+```
4444+4545+Then, build the most recent images by running:
4646+4747+```sh
4848+mise build
4949```
5050+5151+[Tangled]: https://tangled.org
5252+[Docker Bake]: https://docs.docker.com/build/bake/
5353+[mise]: https://mise.jdx.dev