this repo has no description

readme: add more documentation about usage

hanna 9d7e51d2 cadb3086

Changed files
+31 -3
+31 -3
readme.md
··· 1 - # knot-docker 1 + # Knot Docker 2 + 3 + > **IMPORTANT** 4 + > This is a community maintained repository, support is not guaranteed. 5 + 6 + Docker container and compose setup to run a [Tangled](https://tangled.sh) knot and host your own data. 7 + 8 + ## Simple Setup 9 + 10 + If you want an easy way to spin up a knot, you can simply run the following 11 + with docker installed: 2 12 3 - This is a community maintained Docker setup for hosting your own knot 4 - server. 13 + ```console 14 + $ docker compose up -d 15 + ``` 16 + 17 + This will setup the knot server, as well as caddy to expose the front-end. 18 + 19 + ## Bring Your Own Setup 20 + 21 + If you have your own compose setup already, you will just need point your web 22 + server to the knot's HTTP port (namely `5555`), you can do this with docker by 23 + setting another container to `depends_on` it and then pointing it to the name 24 + of the container with the port. For example, with a very basic caddy webserver 25 + container: 26 + 27 + ``` 28 + caddy reverse-proxy --from ${KNOT_SERVER_HOSTNAME} --to knot:5555 29 + ``` 30 + 31 + This will for example point caddy to the port on the knot container. 32 +