commit 0eb4fb0c1cb2bf03a166b87f9b339e4040a5f7c9 · dunkirk.sh/core

+74

docs/contributing.md

···

       1
       1
       +
       # tangled contributing guide

     

       2
       2
       +
       

     

       3
       3
       +
       ## commit guidelines

     

       4
       4
       +
       

     

       5
       5
       +
       We follow a commit style similar to the Go project. Please keep commits:

     

       6
       6
       +
       

     

       7
       7
       +
       * **atomic**: each commit should represent one logical change  

     

       8
       8
       +
       * **descriptive**: the commit message should clearly describe what the

     

       9
       9
       +
       change does and why it's needed

     

       10
       10
       +
       

     

       11
       11
       +
       ### message format

     

       12
       12
       +
       

     

       13
       13
       +
       ``` 

     

       14
       14
       +
       <service/top-level directory>: <package/path>: <short summary of change>

     

       15
       15
       +
       

     

       16
       16
       +
       

     

       17
       17
       +
       Optional longer description, if needed. Explain what the change does and

     

       18
       18
       +
       why, especially if not obvious. Reference relevant issues or PRs when

     

       19
       19
       +
       applicable. These can be links for now since we don't auto-link

     

       20
       20
       +
       issues/PRs yet. 

     

       21
       21
       +
       ```

     

       22
       22
       +
       

     

       23
       23
       +
       Here are some examples:

     

       24
       24
       +
       

     

       25
       25
       +
       ```

     

       26
       26
       +
       appview: state: fix token expiry check in middleware

     

       27
       27
       +
       

     

       28
       28
       +
       The previous check did not account for clock drift, leading to premature

     

       29
       29
       +
       token invalidation. 

     

       30
       30
       +
       ```

     

       31
       31
       +
       

     

       32
       32
       +
       ```

     

       33
       33
       +
       knotserver: git/service: improve error checking in upload-pack

     

       34
       34
       +
       ```

     

       35
       35
       +
       

     

       36
       36
       +
       ### general notes

     

       37
       37
       +
       

     

       38
       38
       +
       - PRs get merged as a single commit, so keep PRs small and focused. Use

     

       39
       39
       +
       the above guidelines for the PR title and description.

     

       40
       40
       +
       - Use the imperative mood in the summary line (e.g., "fix bug" not

     

       41
       41
       +
       "fixed bug" or "fixes bug").

     

       42
       42
       +
       - Try to keep the summary line under 72 characters, but we aren't too

     

       43
       43
       +
       fussed about this.

     

       44
       44
       +
       - Don't include unrelated changes in the same commit.

     

       45
       45
       +
       - Avoid noisy commit messages like "wip" or "final fix"—rewrite history

     

       46
       46
       +
       before submitting if necessary.

     

       47
       47
       +
       

     

       48
       48
       +
       ## proposals for bigger changes

     

       49
       49
       +
       

     

       50
       50
       +
       Small fixes like typos, minor bugs, or trivial refactors can be

     

       51
       51
       +
       submitted directly as PRs.

     

       52
       52
       +
       

     

       53
       53
       +
       For larger changes—especially those introducing new features,

     

       54
       54
       +
       significant refactoring, or altering system behavior—please open a

     

       55
       55
       +
       proposal first. This helps us evaluate the scope, design, and potential

     

       56
       56
       +
       impact before implementation.

     

       57
       57
       +
       

     

       58
       58
       +
       ### proposal format

     

       59
       59
       +
       

     

       60
       60
       +
       Create a new issue titled:

     

       61
       61
       +
       

     

       62
       62
       +
       ``` 

     

       63
       63
       +
       proposal: <affected scope>: <summary of change> 

     

       64
       64
       +
       ```

     

       65
       65
       +
       

     

       66
       66
       +
       In the description, explain:

     

       67
       67
       +
       

     

       68
       68
       +
       - What the change is

     

       69
       69
       +
       - Why it's needed

     

       70
       70
       +
       - How you plan to implement it (roughly)

     

       71
       71
       +
       - Any open questions or tradeoffs

     

       72
       72
       +
       

     

       73
       73
       +
       We'll use the issue thread to discuss and refine the idea before moving

     

       74
       74
       +
       forward.

+108

docs/knot-hosting.md

···

       1
       1
       +
       # knot self-hosting guide

     

       2
       2
       +
       

     

       3
       3
       +
       So you want to run your own knot server? Great! Here are a few prerequisites:

     

       4
       4
       +
       

     

       5
       5
       +
       1. A server of some kind (a VPS, a Raspberry Pi, etc.). Preferably running a Linux of some kind.

     

       6
       6
       +
       2. A (sub)domain name. People generally use `knot.example.com`.

     

       7
       7
       +
       3. A valid SSL certificate for your domain.

     

       8
       8
       +
       

     

       9
       9
       +
       There's a couple of ways to get started:

     

       10
       10
       +
       * NixOS: refer to [flake.nix](https://tangled.sh/@tangled.sh/core/blob/master/flake.nix)

     

       11
       11
       +
       * Docker: Documented below.

     

       12
       12
       +
       * Manual: Documented below.

     

       13
       13
       +
       

     

       14
       14
       +
       ## docker setup

     

       15
       15
       +
       

     

       16
       16
       +
       Clone this repository:

     

       17
       17
       +
       

     

       18
       18
       +
       ```

     

       19
       19
       +
       git clone https://tangled.sh/@tangled.sh/core

     

       20
       20
       +
       ```

     

       21
       21
       +
       

     

       22
       22
       +
       Modify the `docker/docker-compose.yml`, specifically the

     

       23
       23
       +
       `KNOT_SERVER_SECRET` and `KNOT_SERVER_HOSTNAME` env vars. Then run:

     

       24
       24
       +
       

     

       25
       25
       +
       ```

     

       26
       26
       +
       docker compose -f docker/docker-compose.yml up

     

       27
       27
       +
       ```

     

       28
       28
       +
       

     

       29
       29
       +
       ### manual setup

     

       30
       30
       +
       

     

       31
       31
       +
       First, clone this repository:

     

       32
       32
       +
       

     

       33
       33
       +
       ```

     

       34
       34
       +
       git clone https://tangled.sh/@tangled.sh/core

     

       35
       35
       +
       ```

     

       36
       36
       +
       

     

       37
       37
       +
       Then, build our binaries (you need to have Go installed):

     

       38
       38
       +
       * `knotserver`: the main server program

     

       39
       39
       +
       * `keyfetch`: utility to fetch ssh pubkeys

     

       40
       40
       +
       * `repoguard`: enforces repository access control

     

       41
       41
       +
       

     

       42
       42
       +
       ```

     

       43
       43
       +
       cd core

     

       44
       44
       +
       export CGO_ENABLED=1

     

       45
       45
       +
       go build -o knot ./cmd/knotserver

     

       46
       46
       +
       go build -o keyfetch ./cmd/keyfetch

     

       47
       47
       +
       go build -o repoguard ./cmd/repoguard

     

       48
       48
       +
       ```

     

       49
       49
       +
       

     

       50
       50
       +
       Next, move the `keyfetch` binary to a location owned by `root` --

     

       51
       51
       +
       `/usr/local/libexec/tangled-keyfetch` is a good choice:

     

       52
       52
       +
       

     

       53
       53
       +
       ```

     

       54
       54
       +
       sudo mv keyfetch /usr/local/libexec/tangled-keyfetch

     

       55
       55
       +
       sudo chown root:root /usr/local/libexec/tangled-keyfetch

     

       56
       56
       +
       sudo chmod 755 /usr/local/libexec/tangled-keyfetch

     

       57
       57
       +
       ```

     

       58
       58
       +
       

     

       59
       59
       +
       This is necessary because SSH `AuthorizedKeysCommand` requires [really specific

     

       60
       60
       +
       permissions](https://stackoverflow.com/a/27638306). Let's set that up:

     

       61
       61
       +
       

     

       62
       62
       +
       ```

     

       63
       63
       +
       sudo tee /etc/ssh/sshd_config.d/authorized_keys_command.conf <<EOF

     

       64
       64
       +
       Match User git

     

       65
       65
       +
         AuthorizedKeysCommand /usr/local/libexec/tangled-keyfetch

     

       66
       66
       +
         AuthorizedKeysCommandUser nobody

     

       67
       67
       +
       EOF

     

       68
       68
       +
       ```

     

       69
       69
       +
       

     

       70
       70
       +
       Next, create the `git` user:

     

       71
       71
       +
       

     

       72
       72
       +
       ```

     

       73
       73
       +
       sudo adduser git

     

       74
       74
       +
       ```

     

       75
       75
       +
       

     

       76
       76
       +
       Copy the `repoguard` binary to the `git` user's home directory:

     

       77
       77
       +
       

     

       78
       78
       +
       ```

     

       79
       79
       +
       sudo cp repoguard /home/git

     

       80
       80
       +
       sudo chown git:git /home/git/repoguard

     

       81
       81
       +
       ```

     

       82
       82
       +
       

     

       83
       83
       +
       Now, let's set up the server. Copy the `knot` binary to

     

       84
       84
       +
       `/usr/local/bin/knotserver`. Then, create `/home/git/.knot.env` with the

     

       85
       85
       +
       following, updating the values as necessary. The `KNOT_SERVER_SECRET` can be

     

       86
       86
       +
       obtaind from the [/knots](/knots) page on Tangled.

     

       87
       87
       +
       

     

       88
       88
       +
       ```

     

       89
       89
       +
       KNOT_REPO_SCAN_PATH=/home/git

     

       90
       90
       +
       KNOT_SERVER_HOSTNAME=knot.example.com

     

       91
       91
       +
       APPVIEW_ENDPOINT=https://tangled.sh

     

       92
       92
       +
       KNOT_SERVER_SECRET=secret

     

       93
       93
       +
       KNOT_SERVER_INTERNAL_LISTEN_ADDR=127.0.0.1:5444

     

       94
       94
       +
       KNOT_SERVER_LISTEN_ADDR=127.0.0.1:5555

     

       95
       95
       +
       ```

     

       96
       96
       +
       

     

       97
       97
       +
       If you run a Linux distribution that uses systemd, you can use the provided

     

       98
       98
       +
       service file to run the server. Copy

     

       99
       99
       +
       [`knotserver.service`](https://tangled.sh/did:plc:wshs7t2adsemcrrd4snkeqli/core/blob/master/systemd/knotserver.service)

     

       100
       100
       +
       to `/etc/systemd/system/`. Then, run:

     

       101
       101
       +
       

     

       102
       102
       +
       ```

     

       103
       103
       +
       systemctl enable knotserver

     

       104
       104
       +
       systemctl start knotserver

     

       105
       105
       +
       ```

     

       106
       106
       +
       

     

       107
       107
       +
       You should now have a running knot server! You can finalize your registration by hitting the

     

       108
       108
       +
       `initialize` button on the [/knots](/knots) page.