From 97b684b5af702c14faad9e57c3544faf66ff012c Mon Sep 17 00:00:00 2001
From: Anirudh Oppiliappan <x@icyphox.sh>
Date: Tue, 8 Apr 2025 16:23:39 +0300
Subject: [PATCH] readme: add links to documentation

---
 readme.md | 110 ++----------------------------------------------------
 1 file changed, 3 insertions(+), 107 deletions(-)

diff --git a/readme.md b/readme.md
index 2f2fd607..6fda9769 100644
--- a/readme.md
+++ b/readme.md
@@ -6,111 +6,7 @@ on the [AT Protocol](https://atproto.com).
 
 Read the introduction to Tangled [here](https://blog.tangled.sh/intro).
 
-## knot self-hosting guide
+Documentation:
 
-So you want to run your own knot server? Great! Here are a few prerequisites:
-
-1. A server of some kind (a VPS, a Raspberry Pi, etc.). Preferably running a Linux of some kind.
-2. A (sub)domain name. People generally use `knot.example.com`.
-3. A valid SSL certificate for your domain.
-
-There's a couple of ways to get started:
-* NixOS: refer to [flake.nix](https://tangled.sh/@tangled.sh/core/blob/master/flake.nix)
-* Docker: Documented below.
-* Manual: Documented below.
-
-## docker setup
-
-Clone this repository:
-
-```
-git clone https://tangled.sh/@tangled.sh/core
-```
-
-Modify the `docker/docker-compose.yml`, specifically the
-`KNOT_SERVER_SECRET` and `KNOT_SERVER_HOSTNAME` env vars. Then run:
-
-```
-docker compose -f docker/docker-compose.yml up
-```
-
-### manual setup
-
-First, clone this repository:
-
-```
-git clone https://tangled.sh/@tangled.sh/core
-```
-
-Then, build our binaries (you need to have Go installed):
-* `knotserver`: the main server program
-* `keyfetch`: utility to fetch ssh pubkeys
-* `repoguard`: enforces repository access control
-
-```
-cd core
-export CGO_ENABLED=1
-go build -o knot ./cmd/knotserver
-go build -o keyfetch ./cmd/keyfetch
-go build -o repoguard ./cmd/repoguard
-```
-
-Next, move the `keyfetch` binary to a location owned by `root` --
-`/usr/local/libexec/tangled-keyfetch` is a good choice:
-
-```
-sudo mv keyfetch /usr/local/libexec/tangled-keyfetch
-sudo chown root:root /usr/local/libexec/tangled-keyfetch
-sudo chmod 755 /usr/local/libexec/tangled-keyfetch
-```
-
-This is necessary because SSH `AuthorizedKeysCommand` requires [really specific
-permissions](https://stackoverflow.com/a/27638306). Let's set that up:
-
-```
-sudo tee /etc/ssh/sshd_config.d/authorized_keys_command.conf <<EOF
-Match User git
-  AuthorizedKeysCommand /usr/local/libexec/tangled-keyfetch
-  AuthorizedKeysCommandUser nobody
-EOF
-```
-
-Next, create the `git` user:
-
-```
-sudo adduser git
-```
-
-Copy the `repoguard` binary to the `git` user's home directory:
-
-```
-sudo cp repoguard /home/git
-sudo chown git:git /home/git/repoguard
-```
-
-Now, let's set up the server. Copy the `knot` binary to
-`/usr/local/bin/knotserver`. Then, create `/home/git/.knot.env` with the
-following, updating the values as necessary. The `KNOT_SERVER_SECRET` can be
-obtaind from the [/knots](/knots) page on Tangled.
-
-```
-KNOT_REPO_SCAN_PATH=/home/git
-KNOT_SERVER_HOSTNAME=knot.example.com
-APPVIEW_ENDPOINT=https://tangled.sh
-KNOT_SERVER_SECRET=secret
-KNOT_SERVER_INTERNAL_LISTEN_ADDR=127.0.0.1:5444
-KNOT_SERVER_LISTEN_ADDR=127.0.0.1:5555
-```
-
-If you run a Linux distribution that uses systemd, you can use the provided
-service file to run the server. Copy
-[`knotserver.service`](https://tangled.sh/did:plc:wshs7t2adsemcrrd4snkeqli/core/blob/master/systemd/knotserver.service)
-to `/etc/systemd/system/`. Then, run:
-
-```
-systemctl enable knotserver
-systemctl start knotserver
-```
-
-You should now have a running knot server! You can finalize your registration by hitting the
-`initialize` button on the [/knots](/knots) page.
+* [knot hosting guide](https://tangled.sh/@tangled.sh/core/tree/master/docs/knot-hosting.md)
+* [contributing guide](https://tangled.sh/@tangled.sh/core/tree/master/docs/contributing.md)
-- 
2.51.2