From 0786638a98c0e22cebcef0800e10b09329515298 Mon Sep 17 00:00:00 2001 From: god Date: Sat, 4 Jul 2026 11:38:58 +0800 Subject: [PATCH] docs: update clone instructions for Gitea SSH and HTTPS --- GIT_CLONE_TUTORIAL.md | 65 ++++++++++++++++++++++--------------------- README.md | 29 +++++++++++++------ 2 files changed, 54 insertions(+), 40 deletions(-) diff --git a/GIT_CLONE_TUTORIAL.md b/GIT_CLONE_TUTORIAL.md index 6bc58ba..7f99f36 100644 --- a/GIT_CLONE_TUTORIAL.md +++ b/GIT_CLONE_TUTORIAL.md @@ -1,43 +1,46 @@ -# Cloning from any tailnet machine +# Clone Tekton from Gitea ## Prerequisites -- The remote machine must be on your tailnet (registered + can ping `100.85.x.x`) -- You must have an account on the Gitea instance (`http://git.klud.top`) -- You must have an SSH key on the remote machine (`ssh-keygen` if you don't) -## Step 1: Add your SSH key to Gitea -1. Open `http://git.klud.top/user/settings/keys` in browser -2. Paste the content of `~/.ssh/id_ed25519.pub` (or `id_rsa.pub`) -3. Click "Add Key" +- You have a Gitea account at `https://git.klud.top`. +- For SSH clone: your public SSH key is added at `https://git.klud.top/user/settings/keys`. + +## SSH clone (preferred) + +Test SSH: -## Step 2: Test SSH reachability ```bash -ssh -T git@thunderobot -p 222 -# Expected output: "Hello from Gitea!\n\nPlease come over!" -# If asked about fingerprint, type "yes" and press Enter +ssh -T git@ssh.git.klud.top ``` -## Step 3: Clone a repo -```bash -# Using tea CLI -tea repos clone --git-protocol ssh danchie/tekton +Expected output: -# Or plain git -git clone git@thunderobot:222/danchie/tekton.git +```text +Hi there, ! You've successfully authenticated with the key named , but Gitea does not provide shell access. +``` + +Clone: + +```bash +git clone git@ssh.git.klud.top:danchie/tekton.git +``` + +## HTTPS clone + +```bash +git clone https://git.klud.top/danchie/tekton.git +``` + +Use HTTPS when SSH keys are not available, e.g. CI scripts or temporary machines. + +## Tea CLI + +```bash +tea repos clone --git-protocol ssh danchie/tekton ``` ## Troubleshooting -- `ssh: connect to host thunderobot port 222: Connection refused` - → Ensure the remote machine has `tailscale ping thunderobot` resolving to `100.93.226.13` - → Ensure the host's port `222` is reachable from the remote (it's bound to `0.0.0.0:222` in Docker) -- `Permission denied (publickey)` - → Your SSH key wasn't added via Gitea web UI - → Run `ssh-add ~/.ssh/id_ed25519` if you use an agent - -- `Host key verification failed` - → Run `ssh -T git@thunderobot -p 222` interactively once to accept the fingerprint - -## HTTPS is disabled -`DISABLE_HTTP_GIT = true` is set on the server. All clones MUST use SSH. -If you need to fetch via HTTPS for CI or other non-ssh environments, this must be remapped. \ No newline at end of file +- **`Permission denied (publickey)`** — Your key was not added in Gitea, or your SSH agent has not loaded it. Run `ssh-add ~/.ssh/id_ed25519`. +- **`Host key verification failed`** — Run `ssh -T git@ssh.git.klud.top` interactively once and accept the fingerprint. +- **`Could not resolve hostname ssh.git.klud.top`** — DNS cache stale. Wait a few minutes or flush DNS. diff --git a/README.md b/README.md index cbebf9d..149a6ef 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,34 @@ > > See in particular: [Skin Creation Workflow](https://git.klud.top/danchie/tekton/wiki/Skin-Creation-Workflow), [Nakama Deployment](https://git.klud.top/danchie/tekton/wiki/Nakama-Deployment), and [Patch Release Workflow](https://git.klud.top/danchie/tekton/wiki/Patch-Release-Workflow). -## SSH setup for cloning +## Clone -All clones **must use SSH** over Tailscale. HTTPS is disabled on this instance. +SSH is preferred: -Guides by operating system: +```bash +git clone git@ssh.git.klud.top:danchie/tekton.git +``` + +HTTPS also works: + +```bash +git clone https://git.klud.top/danchie/tekton.git +``` + +First-time SSH setup: - [Linux](https://git.klud.top/danchie/tekton/wiki/SSH-Setup-Linux) - [macOS](https://git.klud.top/danchie/tekton/wiki/SSH-Setup-macOS) - [Windows](https://git.klud.top/danchie/tekton/wiki/SSH-Setup-Windows) -Quick verification after setup: +SSH test: + ```bash -ssh -T git@thunderobot -p 222 +ssh -T git@ssh.git.klud.top ``` -Once verified, clone: -```bash -git clone git@thunderobot:222/danchie/tekton.git +Expected output: + +```text +Hi there, ! You've successfully authenticated with the key named , but Gitea does not provide shell access. ``` -# god test commit