diff --git a/readme.md b/readme.md index b357d8c..e6ca3c4 100644 --- a/readme.md +++ b/readme.md @@ -1,40 +1,56 @@ -# RecapTime.dev Knot Server on Nest +# RecapTime.dev Knot Server on `proxyparty.recaptime.dev` -[![pipeline status](https://gitlab.com/recaptime-dev/infra/knot-server-docker/badges/recaptime-dev/main/pipeline.svg)](https://gitlab.com/recaptime-dev/infra/knot-server-docker/-/commits/recaptime-dev/main) +[![pipeline status](https://gitlab.com/recaptime-dev/infra/docker/tangled-knotserver/badges/recaptime-dev/main/pipeline.svg)](https://gitlab.com/recaptime-dev/infra/docker/tangled-knotserver-/commits/recaptime-dev/main) [![Hack Club](https://badges.api.lorebooks.wiki/badges/hackclub/hackclub)](https://hackclub.com) -Sources for the container images of Tangled Knot server, used to run `knot.hackclub.community` at an Azure VM (previously on [Nest tilde server before going with Promox VM-based containers](https://hackclub.app)). +Sources for our Tangled knotserver Docker image builds as well as our setup over at the same Azure VM as +our [Caddy-based proxyparty server](https://proxyparty.recaptime.dev). + +For the previous setup at Hack Club Nest, see the `archived/knot.hackclub.community` git branch and +visit for more details. ## Usage -On the repository creation page, select `knot.hackclub.community` as the Knot server. +On the repository creation page on Tangled, select `knot.recaptime.dev` as the knotserver. When cloning or adding/updating remote URLs, use the following SSH Git URLs below as documented: ```bash -# on its custom domain -git remote add origin ssh://git@knot.hackclub.community:33939/handle.host.tld/repo +git remote add tngl git@knot.recaptime.dev:did:plc: -# directly with our proxyparty server's hostname (since it's just a CNAME DNS record) -git remote add origin ssh://git@proxyparty.recaptime.dev:33939/handle.host.tld/repo +# ssh:// URL formats +git remote add tngl ssh://git@knot.recaptime.dev/did:plc: ``` +Note for GitLab users who going to set up pull mirroring, use the `https://{knot}/{repoDid}` URL format +as the repository URL to avoid issues relating to redirects. ([source in Tangled Discord](https://discord.com/channels/1361963801993285692/1361963802848919676/1507944197913579530)) + ### Infrastructure Operations -* Image CI builds happen via GitLab CI: +* Image CI builds happen via GitLab CI: * [View our GitLab CI config](./.gitlab-ci.yaml) - * [View tags on GitLab Container Registry](https://gitlab.com/recaptime-dev/infra/knot-server-docker/container_registry/9481789) -* Run using built images after `ssh recaptime-dev@hackclub.app`: ` compose up --no-build --force-recreate` -* Get build information: ` compose exec knot knotserver-version` + * [View tags on GitLab Container Registry](https://gitlab.com/recaptime-dev/infra/docker/tangled-knotserver/container_registry/9481789) +* Run on Lairland HQ homelab server: `docker compose --project-directory=/var/lib/infraops/recaptime-dev/docker/knotserver up --pull=always` +* Get build information: `docker compose [--project-directory=/var/lib/infraops/recaptime-dev/docker/knotserver] compose exec knot knotserver-version` ## Requesting access -> You'll be asked for your AT Proto handle/DID PLC to provision access. Don't have one? +> You'll be asked for your Atmosphere account handle/DID to provision access for repo creation. Don't have one? > You can sign up via [Bluesky Social](https://bsky.app) or in [Tangled](https://tangled.org/signup) -> directly. +> directly. If you use alternative Tangled AppViews (like [Blacksky Algorithms Forge][blacksky-forge]), you +> might need to sign into Tangled proper first. -Hack Clubbers can request access for `knot.hackclub.community` by contacting Andrei Jiroh in the Slack, either -[via DMs](https://hackclub.slack.com/team/U07CAPBB9B5) or at the -[main `#recaptime-dev` Slack channel](https://hackclub.slack.com/archives/C07H1R2PW9W). +Community members, not just Hack Clubbers can request access for `knot.recaptime.dev` by contacting Andrei Jiroh +via Recap Time Squad's Zulip Cloud organization at [this thread][request-access-thread], Discord +([via DMs (not preferred)][discord-profile] or tagging `@ajhalili2006` in either [Tangled][tangled-discord], +[AT Proto Touchers][atprotocoldev] or at [Recap Time Squad][recaptime-dev-discord]) or through email at +`ajhalili2006 [at] crew [dot] recaptime [dot] dev`. + +[request-access-thread]: https://recaptime-dev.zulipchat.com/#narrow/channel/603867-projects.2Ftangled/topic/request.20access.20to.20knot.2Erecaptime.2Edev.20instance/with/597367557 +[blacksky-forge]: https://forge.blacksky.community +[discord-profile]: https://discord.com/users/437044173825114113 +[tangled-discord]: https://discord.gg/W7SRR4xHhd +[atprotocoldev]: https://discord.gg/9YkBQRDPFY +[recaptime-dev-discord]: https://discord.gg/CsYMM4Rnr ## Docs @@ -45,4 +61,6 @@ Hack Clubbers can request access for `knot.hackclub.community` by contacting And ## License -MIT +* MIT for both the Docker image sources and Tangled core monorepo +* CC-BY-SA-4.0 for [the docs](./docs) +