forked from
tangled.org/knot-docker
Docker config for @recaptime.dev's Knot server on Hack Club Nest.
knot.hackclub.community
docs: update readme with access request docs and usage
Signed-off-by: Andrei Jiroh Halili <ajhalili2006@andreijiroh.dev>
+21
-61
+21
-61
readme.md
+21
-61
readme.md
···
1
-
# Knot Docker
1
+
# RecapTime.dev Knot Server on Nest
2
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.org) knot
7
-
and host your own repository data.
8
-
9
-
## Pre-built Images
10
-
11
-
There is a [repository](https://hub.docker.com/r/tngl/knot) of pre-built images
12
-
for tags starting at `v1.8.0-alpha` if you prefer.
13
-
14
-
```
15
-
docker pull tngl/knot:v1.10.0-alpha
16
-
```
17
-
18
-
Note that these are *not* official images, you use them at your own risk.
3
+
This is a knot server that Recap Time Squad uses to host our Git repositories on
4
+
[Tangled](https://tangled.org), hosted on [Nest](https://hackclub.app) for the
5
+
Hack Club community.
19
6
20
-
## Building The Image
21
-
22
-
By default the `Dockerfile` will build the latest tag, but you can change it
23
-
with the `TAG` build argument.
24
-
25
-
```sh
26
-
docker build -t knot:latest --build-arg TAG=master .
27
-
```
28
-
29
-
The command above for example will build the latest commit on the `master`
30
-
branch.
31
-
32
-
By default it will also create a `git` user with user and group ID 1000:1000,
33
-
but you can change it with the `UID` and `GID` build arguments.
34
-
35
-
```sh
36
-
docker build -t knot:latest --build-arg UID=$(id -u) GID=$(id -g)
37
-
```
38
-
39
-
The command above for example will create a user with the host user's UID and GID.
40
-
This is useful if you are bind mounting the repositories and app folder on the host,
41
-
as in the provided `docker-compose.yml` file.
7
+
## Usage
42
8
43
-
<hr style="margin-bottom: 20px; margin-top: 10px" />
9
+
On the repository creation page, select `knot.hackclub.community` as the Knot server.
10
+
When cloning or adding/updating remote URLs, use the following SSH Git URLs below as documented:
44
11
45
-
When using compose, these can be specified as build arguments which will be
46
-
passed to the builder.
12
+
```bash
13
+
git remote add origin ssh://git@knot.hackclub.community:33939/handle.host.tld/repo
47
14
48
-
```yaml
49
-
build:
50
-
context: .
51
-
args:
52
-
TAG: master
53
-
UID: 1000
54
-
GID: 1000
15
+
# directly with Nest's hostname (since it's just a CNAME DNS record)
16
+
git remote add origin ssh://git@hackclub.app:33939/handle.host.tld/repo
55
17
```
56
18
57
-
This will for example tell docker to build it using the `master` branch like
58
-
the command.
19
+
## Requesting access
59
20
60
-
## Setting Up The Image
21
+
> You'll be asked for your AT Proto handle/DID PLC to provision access. Don't have one?
22
+
> You can sign up via [Bluesky Social](https://bsky.app) or in [Tangled](https://tangled.org/signup)
23
+
> directly.
61
24
62
-
The simplest way to set up your own knot is to use the provided compose file
63
-
and run the following:
25
+
Hack Clubbers can request access by contacting Andrei Jiroh in the Slack, either
26
+
[via DMs](https://hackclub.slack.com/team/U07CAPBB9B5) or at the
27
+
[main `#recaptime-dev` Slack channel](https://hackclub.slack.com/archives/C07H1R2PW9W).
64
28
65
-
```sh
66
-
export KNOT_SERVER_HOSTNAME=example.com
67
-
export KNOT_SERVER_OWNER=did:plc:yourdidgoeshere
68
-
export KNOT_SERVER_PORT=443
69
-
docker compose up -d
70
-
```
29
+
## Upstream docs
71
30
72
-
This will setup everything for you including a reverse proxy.
31
+
* Knot hosting guide: https://tangled.org/tangled.org/core/blob/main/docs/knot-hosting.md
32
+
* Docker-based setup: https://tangled.org/tangled.org/knot-docker/blob/main/readme.md