comparing a27bd8f0125f0c19d1059c9e0865f4971ca9f991 and spindle on keea.dog/knot-spindle

+1

.gitignore

···

       1
       1
       +
       .DS_Store

+33 -26

Dockerfile

···

       1
       1
       -
       from golang:1.24-alpine as builder

     

       2
       2
       -
       env KNOT_REPO_SCAN_PATH=/home/git/repositories

     

       3
       3
       -
       env CGO_ENABLED=1

     

       1
       1
       +
       FROM golang:1.24-alpine AS builder

     

       2
       2
       +
       ENV CGO_ENABLED=1

     

       4
       3
        
       

     

       5
       5
       -
       workdir /app

     

       6
       6
       -
       run apk add git gcc musl-dev

     

       7
       7
       -
       run git clone https://tangled.sh/@tangled.sh/core .

     

       8
       8
       -
       run go build -o /usr/bin/knot -ldflags '-s -w -extldflags "-static"' ./cmd/knot

     

       4
       4
       +
       ARG TAG='v1.10.0-alpha'

     

       9
       5
        
       

     

       10
       10
       -
       from alpine:edge

     

       11
       11
       -
       expose 5555

     

       12
       12
       -
       expose 22

     

       6
       6
       +
       WORKDIR /app

     

       7
       7
       +
       RUN apk add git gcc musl-dev

     

       8
       8
       +
       RUN git clone -b ${TAG} https://tangled.org/@tangled.org/core .

     

       9
       9
       +
       RUN go build -o /usr/bin/spindle -ldflags '-s -w -extldflags "-static"' ./cmd/spindle

     

       13
       10
        
       

     

       14
       14
       -
       label org.opencontainers.image.title='knot'

     

       15
       15
       -
       label org.opencontainers.image.description='data server for tangled'

     

       16
       16
       -
       label org.opencontainers.image.source='https://tangled.sh/@tangled.sh/knot-docker'

     

       17
       17
       -
       label org.opencontainers.image.url='https://tangled.sh'

     

       18
       18
       -
       label org.opencontainers.image.vendor='tangled.sh'

     

       19
       19
       -
       label org.opencontainers.image.licenses='MIT'

     

       11
       11
       +
       FROM alpine:edge

     

       12
       12
       +
       

     

       13
       13
       +
       ARG PORT=6555

     

       14
       14
       +
       EXPOSE $PORT

     

       15
       15
       +
       

     

       16
       16
       +
       LABEL org.opencontainers.image.title='spindle'

     

       17
       17
       +
       LABEL org.opencontainers.image.description='CI runner for tangled'

     

       18
       18
       +
       LABEL org.opencontainers.image.source='https://tangled.org/@keea.dog/spindle-docker'

     

       19
       19
       +
       LABEL org.opencontainers.image.url='https://tangled.org'

     

       20
       20
       +
       LABEL org.opencontainers.image.vendor='tangled.org'

     

       21
       21
       +
       LABEL org.opencontainers.image.licenses='MIT'

     

       20
       22
        
       

     

       21
       21
       -
       copy rootfs .

     

       22
       22
       -
       run chmod -R 755 /etc/s6-overlay

     

       23
       23
       -
       run apk add shadow s6-overlay execline openssl openssh git curl

     

       24
       24
       -
       run useradd -s /bin/nologin -d /home/git git && openssl rand -hex 16 | passwd --stdin git

     

       25
       25
       -
       run mkdir -p /home/git/repositories && chown -R git:git /home/git/repositories

     

       26
       26
       -
       copy --from=builder /usr/bin/knot /usr/bin

     

       27
       27
       -
       run mkdir /app && chown -R git:git /app

     

       23
       23
       +
       ARG UID=1000

     

       24
       24
       +
       ARG GID=1000

     

       28
       25
        
       

     

       29
       29
       -
       healthcheck --interval=60s --timeout=30s --start-period=5s --retries=3 \

     

       30
       30
       -
         cmd curl -f http://localhost:5555 || exit 1

     

       26
       26
       +
       COPY rootfs .

     

       27
       27
       +
       RUN chmod 755 /etc

     

       28
       28
       +
       RUN chmod -R 755 /etc/s6-overlay

     

       29
       29
       +
       RUN apk add shadow s6-overlay execline openssl curl

     

       30
       30
       +
       RUN groupadd -g $GID -f spindle

     

       31
       31
       +
       RUN useradd -u $UID -g $GID -d /home/spindle spindle

     

       32
       32
       +
       RUN openssl rand -hex 16 | passwd --stdin spindle

     

       33
       33
       +
       RUN mkdir -p /home/spindle/repositories && chown -R spindle:spindle /home/spindle

     

       34
       34
       +
       COPY --from=builder /usr/bin/spindle /usr/bin

     

       35
       35
       +
       RUN mkdir /app && chown -R spindle:spindle /app

     

       31
       36
        
       

     

       32
       32
       -
       entrypoint ["/init"]

     

       37
       37
       +
       HEALTHCHECK --interval=60s --timeout=30s --start-period=5s --retries=3 \

     

       38
       38
       +
           CMD curl -f http://localhost:${PORT} || exit 1

     

       33
       39
        
       

     

       40
       40
       +
       ENTRYPOINT ["/init"]

+21 -20

docker-compose.yml

···

       1
       1
        
       services:

     

       2
       2
       -
         knot:

     

       2
       2
       +
         spindle:

     

       3
       3
        
           build:

     

       4
       4
       -
             context: ..

     

       5
       5
       -
             dockerfile: docker/Dockerfile

     

       4
       4
       +
             context: .

     

       5
       5
       +
             args:

     

       6
       6
       +
               UID: 1000

     

       7
       7
       +
               GID: 1000

     

       8
       8
       +
               PORT: ${INTERNAL_PORT:-6555}

     

       6
       9
        
           environment:

     

       7
       7
       -
             KNOT_SERVER_HOSTNAME: ${KNOT_SERVER_HOSTNAME}

     

       8
       8
       -
             KNOT_SERVER_SECRET: ${KNOT_SERVER_SECRET}

     

       9
       9
       -
             KNOT_SERVER_DB_PATH: "/app/knotserver.db"

     

       10
       10
       -
             KNOT_REPO_SCAN_PATH: "/home/git/repositories"

     

       11
       11
       -
             KNOT_SERVER_INTERNAL_LISTEN_ADDR: "localhost:5444"

     

       10
       10
       +
             SPINDLE_SERVER_HOSTNAME: ${SPINDLE_SERVER_HOSTNAME}

     

       11
       11
       +
             SPINDLE_SERVER_OWNER: ${SPINDLE_SERVER_OWNER}

     

       12
       12
       +
             SPINDLE_SERVER_DB_PATH: /app/spindle.db

     

       13
       13
       +
             SPINDLE_SERVER_LISTEN_ADDR: localhost:6555

     

       14
       14
       +
             SPINDLE_PIPELINES_LOG_DIR: /var/log/spindle

     

       15
       15
       +
             PORT: ${INTERNAL_PORT:-6555}

     

       12
       16
        
           volumes:

     

       13
       13
       -
             - "./keys:/etc/ssh/keys"

     

       14
       14
       -
             - "./repositories:/home/git/repositories"

     

       15
       15
       -
             - "./server:/app"

     

       17
       17
       +
             - ./server:/app

     

       16
       18
        
           ports:

     

       17
       17
       -
             - "5555:5555"

     

       18
       18
       -
             - "2222:22"

     

       19
       19
       +
             - "${INTERNAL_PORT:-6555}:${INTERNAL_PORT:-6555}"

     

       19
       20
        
           restart: always

     

       20
       21
        
         frontend:

     

       21
       21
       -
           image: caddy:2-alpine

     

       22
       22
       +
           image: caddy:alpine

     

       22
       23
        
           command: >

     

       23
       24
        
             caddy

     

       24
       25
        
             reverse-proxy

     

       25
       25
       -
             --from ${KNOT_SERVER_HOSTNAME}

     

       26
       26
       -
             --to knot:5555

     

       26
       26
       +
             --from ${SPINDLE_SERVER_HOSTNAME}

     

       27
       27
       +
             --to spindle:6555

     

       27
       28
        
           depends_on:

     

       28
       28
       -
             - knot

     

       29
       29
       +
             - spindle

     

       29
       30
        
           ports:

     

       30
       30
       -
             - "${KNOT_SERVER_PORT:-443}:443"

     

       31
       31
       -
             - "${KNOT_SERVER_PORT:-443}:443/udp"

     

       31
       31
       +
             - ${SPINDLE_SERVER_PORT:-443}:443

     

       32
       32
       +
             - ${SPINDLE_SERVER_PORT:-443}:443/udp

     

       32
       33
        
           volumes:

     

       33
       33
       -
             - caddy_data:/data

     

       34
       34
       +
             - ./caddy_data:/data

     

       34
       35
        
           restart: always

     

       35
       36
        
           profiles: ["caddy"]

+22

license.txt

···

       1
       1
       +
       MIT License

     

       2
       2
       +
       

     

       3
       3
       +
       Copyright (c) 2025 Tangled Team

     

       4
       4
       +
       

     

       5
       5
       +
       Permission is hereby granted, free of charge, to any person obtaining a copy

     

       6
       6
       +
       of this software and associated documentation files (the "Software"), to deal

     

       7
       7
       +
       in the Software without restriction, including without limitation the rights

     

       8
       8
       +
       to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

     

       9
       9
       +
       copies of the Software, and to permit persons to whom the Software is

     

       10
       10
       +
       furnished to do so, subject to the following conditions:

     

       11
       11
       +
       

     

       12
       12
       +
       The above copyright notice and this permission notice shall be included in all

     

       13
       13
       +
       copies or substantial portions of the Software.

     

       14
       14
       +
       

     

       15
       15
       +
       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

     

       16
       16
       +
       IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

     

       17
       17
       +
       FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

     

       18
       18
       +
       AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

     

       19
       19
       +
       LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

     

       20
       20
       +
       OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

     

       21
       21
       +
       SOFTWARE.

     

       22
       22
       +

+71 -3

readme.md

···

       1
       1
       -
       # knot-docker

     

       1
       1
       +
       # Knot Docker

     

       2
       2
       +
       

     

       3
       3
       +
       > **IMPORTANT**

     

       4
       4
       +
       > This is a community maintained repository, support is not guaranteed.

     

       5
       5
       +
       

     

       6
       6
       +
       Docker container and compose setup to run a [Tangled](https://tangled.org) knot

     

       7
       7
       +
       and host your own repository data.

     

       8
       8
       +
       

     

       9
       9
       +
       ## Pre-built Images

     

       10
       10
       +
       

     

       11
       11
       +
       There is a [repository](https://hub.docker.com/r/tngl/knot) of pre-built images

     

       12
       12
       +
       for tags starting at `v1.8.0-alpha` if you prefer.

     

       13
       13
       +
       

     

       14
       14
       +
       ```

     

       15
       15
       +
       docker pull tngl/knot:v1.10.0-alpha

     

       16
       16
       +
       ```

     

       17
       17
       +
       

     

       18
       18
       +
       Note that these are *not* official images, you use them at your own risk.

     

       19
       19
       +
       

     

       20
       20
       +
       ## Building The Image

     

       21
       21
       +
       

     

       22
       22
       +
       By default the `Dockerfile` will build the latest tag, but you can change it

     

       23
       23
       +
       with the `TAG` build argument.

     

       2
       24
        
       

     

       3
       3
       -
       This is a community maintained Docker setup for hosting your own knot

     

       4
       4
       -
       server.

     

       25
       25
       +
       ```sh

     

       26
       26
       +
       docker build -t knot:latest --build-arg TAG=master .

     

       27
       27
       +
       ```

     

       28
       28
       +
       

     

       29
       29
       +
       The command above for example will build the latest commit on the `master`

     

       30
       30
       +
       branch.

     

       31
       31
       +
       

     

       32
       32
       +
       By default it will also create a `git` user with user and group ID 1000:1000,

     

       33
       33
       +
       but you can change it with the `UID` and `GID` build arguments.

     

       34
       34
       +
       

     

       35
       35
       +
       ```sh

     

       36
       36
       +
       docker build -t knot:latest --build-arg UID=$(id -u) GID=$(id -g)

     

       37
       37
       +
       ```

     

       38
       38
       +
       

     

       39
       39
       +
       The command above for example will create a user with the host user's UID and GID.

     

       40
       40
       +
       This is useful if you are bind mounting the repositories and app folder on the host,

     

       41
       41
       +
       as in the provided `docker-compose.yml` file.

     

       42
       42
       +
       

     

       43
       43
       +
       <hr style="margin-bottom: 20px; margin-top: 10px" />

     

       44
       44
       +
       

     

       45
       45
       +
       When using compose, these can be specified as build arguments which will be

     

       46
       46
       +
       passed to the builder.

     

       47
       47
       +
       

     

       48
       48
       +
       ```yaml

     

       49
       49
       +
       build:

     

       50
       50
       +
         context: .

     

       51
       51
       +
         args:

     

       52
       52
       +
           TAG: master

     

       53
       53
       +
           UID: 1000

     

       54
       54
       +
           GID: 1000

     

       55
       55
       +
       ```

     

       56
       56
       +
       

     

       57
       57
       +
       This will for example tell docker to build it using the `master` branch like

     

       58
       58
       +
       the command.

     

       59
       59
       +
       

     

       60
       60
       +
       ## Setting Up The Image

     

       61
       61
       +
       

     

       62
       62
       +
       The simplest way to set up your own knot is to use the provided compose file

     

       63
       63
       +
       and run the following:

     

       64
       64
       +
       

     

       65
       65
       +
       ```sh

     

       66
       66
       +
       export KNOT_SERVER_HOSTNAME=example.com

     

       67
       67
       +
       export KNOT_SERVER_OWNER=did:plc:yourdidgoeshere

     

       68
       68
       +
       export KNOT_SERVER_PORT=443

     

       69
       69
       +
       docker compose up -d

     

       70
       70
       +
       ```

     

       71
       71
       +
       

     

       72
       72
       +
       This will setup everything for you including a reverse proxy.

-1

rootfs/etc/s6-overlay/s6-rc.d/create-sshd-host-keys/type

···

       1
       1
       -
       oneshot

-1

rootfs/etc/s6-overlay/s6-rc.d/create-sshd-host-keys/up

···

       1
       1
       -
       /etc/s6-overlay/scripts/create-sshd-host-keys

rootfs/etc/s6-overlay/s6-rc.d/knotserver/dependencies.d/base

This is a binary file and will not be displayed.

-3

rootfs/etc/s6-overlay/s6-rc.d/knotserver/run

···

       1
       1
       -
       #!/command/with-contenv ash

     

       2
       2
       -
       

     

       3
       3
       -
       exec s6-setuidgid git /usr/bin/knot server

-1

rootfs/etc/s6-overlay/s6-rc.d/knotserver/type

···

       1
       1
       -
       longrun

rootfs/etc/s6-overlay/s6-rc.d/spindleserver/dependencies.d/base

This is a binary file and will not be displayed.

+3

rootfs/etc/s6-overlay/s6-rc.d/spindleserver/run

···

       1
       1
       +
       #!/command/with-contenv ash

     

       2
       2
       +
       

     

       3
       3
       +
       exec s6-setuidgid spindle /usr/bin/spindle server

+1

rootfs/etc/s6-overlay/s6-rc.d/spindleserver/type

···

       1
       1
       +
       longrun

rootfs/etc/s6-overlay/s6-rc.d/sshd/dependencies.d/base

This is a binary file and will not be displayed.

rootfs/etc/s6-overlay/s6-rc.d/sshd/dependencies.d/create-sshd-host-keys

This is a binary file and will not be displayed.

-3

rootfs/etc/s6-overlay/s6-rc.d/sshd/run

···

       1
       1
       -
       #!/usr/bin/execlineb -P

     

       2
       2
       -
       

     

       3
       3
       -
       /usr/sbin/sshd -e -D

-1

rootfs/etc/s6-overlay/s6-rc.d/sshd/type

···

       1
       1
       -
       longrun

rootfs/etc/s6-overlay/s6-rc.d/user/contents.d/knotserver

This is a binary file and will not be displayed.

rootfs/etc/s6-overlay/s6-rc.d/user/contents.d/spindleserver

This is a binary file and will not be displayed.

rootfs/etc/s6-overlay/s6-rc.d/user/contents.d/sshd

This is a binary file and will not be displayed.

-21

rootfs/etc/s6-overlay/scripts/create-sshd-host-keys

···

       1
       1
       -
       #!/usr/bin/execlineb -P

     

       2
       2
       -
       

     

       3
       3
       -
       foreground {

     

       4
       4
       -
         if -n { test -d /etc/ssh/keys }

     

       5
       5
       -
         mkdir /etc/ssh/keys

     

       6
       6
       -
       }

     

       7
       7
       -
       

     

       8
       8
       -
       foreground {

     

       9
       9
       -
         if -n { test -f /etc/ssh/keys/ssh_host_rsa_key }

     

       10
       10
       -
         ssh-keygen -t rsa -f /etc/ssh/keys/ssh_host_rsa_key -q -N ""

     

       11
       11
       -
       }

     

       12
       12
       -
       

     

       13
       13
       -
       foreground {

     

       14
       14
       -
         if -n { test -f /etc/ssh/keys/ssh_host_ecdsa_key }

     

       15
       15
       -
         ssh-keygen -t rsa -f /etc/ssh/keys/ssh_host_ecdsa_key -q -N ""

     

       16
       16
       -
       }

     

       17
       17
       -
       

     

       18
       18
       -
       foreground {

     

       19
       19
       -
         if -n { test -f /etc/ssh/keys/ssh_host_ed25519_key }

     

       20
       20
       -
         ssh-keygen -t rsa -f /etc/ssh/keys/ssh_host_ed25519_key -q -N ""

     

       21
       21
       -
       }

-8

rootfs/etc/s6-overlay/scripts/keys-wrapper

···

       1
       1
       -
       #!/bin/sh

     

       2
       2
       -
       

     

       3
       3
       -
       # Execute the knot keys command with proper shell context

     

       4
       4
       -
       exec /bin/sh -c '/usr/bin/knot keys -output authorized-keys \

     

       5
       5
       -
           -internal-api "http://${KNOT_SERVER_INTERNAL_LISTEN_ADDR:-localhost:5444}" \

     

       6
       6
       -
           -git-dir "${KNOT_REPO_SCAN_PATH:-/home/git/repositories}" \

     

       7
       7
       -
           -log-path "/tmp/knotguard.log"'

     

       8
       8
       -

-9

rootfs/etc/ssh/sshd_config.d/tangled_sshd.conf

···

       1
       1
       -
       HostKey /etc/ssh/keys/ssh_host_rsa_key

     

       2
       2
       -
       HostKey /etc/ssh/keys/ssh_host_ecdsa_key

     

       3
       3
       -
       HostKey /etc/ssh/keys/ssh_host_ed25519_key

     

       4
       4
       -
       

     

       5
       5
       -
       PasswordAuthentication no

     

       6
       6
       -
       

     

       7
       7
       -
       Match User git

     

       8
       8
       -
         AuthorizedKeysCommand /etc/s6-overlay/scripts/keys-wrapper

     

       9
       9
       -
         AuthorizedKeysCommandUser nobody

Compare changes