commit 9d7e51d2d7c1de54ac2747daccd93e81783d8cb2 · keea.dog/knot-spindle

+31 -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.sh) knot and host your own data.

     

       7
       7
       +
       

     

       8
       8
       +
       ## Simple Setup

     

       9
       9
       +
       

     

       10
       10
       +
       If you want an easy way to spin up a knot, you can simply run the following

     

       11
       11
       +
       with docker installed:

     

       2
       12
        
       

     

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

     

       4
       4
       -
       server.

     

       13
       13
       +
       ```console

     

       14
       14
       +
       $ docker compose up -d

     

       15
       15
       +
       ```

     

       16
       16
       +
       

     

       17
       17
       +
       This will setup the knot server, as well as caddy to expose the front-end.

     

       18
       18
       +
       

     

       19
       19
       +
       ## Bring Your Own Setup

     

       20
       20
       +
       

     

       21
       21
       +
       If you have your own compose setup already, you will just need point your web

     

       22
       22
       +
       server to the knot's HTTP port (namely `5555`), you can do this with docker by

     

       23
       23
       +
       setting another container to `depends_on` it and then pointing it to the name

     

       24
       24
       +
       of the container with the port. For example, with a very basic caddy webserver

     

       25
       25
       +
       container:

     

       26
       26
       +
       

     

       27
       27
       +
       ```

     

       28
       28
       +
       caddy reverse-proxy --from ${KNOT_SERVER_HOSTNAME} --to knot:5555

     

       29
       29
       +
       ```

     

       30
       30
       +
       

     

       31
       31
       +
       This will for example point caddy to the port on the knot container.

     

       32
       32
       +