From 62c5a8a4083cafa2c8f260091252830a582d8d15 Mon Sep 17 00:00:00 2001 From: Lemon-miaow Date: Thu, 24 Sep 2026 01:24:27 +0800 Subject: [PATCH] docs(readme): port the private-repo install path and upgrade notes to the English README (#66) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit README.md grew a required workaround — the repository is private, so the plain raw.githubusercontent one-liner returns 404. The credentialed form (token handed to curl via --config - so it never touches argv, sudo -E so the installer inherits it) and the rerun/upgrade notes (the rerun upgrades felis-api; the channel is not inherited, so main-followers need FELIS_VERSION_BOOTSTRAP=dev) never made it into README_EN.md, which is linked as the English entry point. An English reader following that page could not install at all. Bring it back in sync with the Chinese one. --- README_EN.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README_EN.md b/README_EN.md index dc42da2..bea978b 100644 --- a/README_EN.md +++ b/README_EN.md @@ -34,6 +34,27 @@ curl -fsSL https://raw.githubusercontent.com/FelisMC/Felis/main/deploy/bootstrap The script installs K3s, deploys the control plane, and launches a setup wizard. Once done, open your browser at the configured domain. +> **This repository is currently private**, so the command above returns 404. Use the +> credentialed form instead; the installer itself needs the same token to resolve and +> download the release, so pass it through with `sudo -E`: +> +> ```bash +> export FELIS_GITHUB_TOKEN= +> printf 'header = "Authorization: Bearer %s"\n' "$FELIS_GITHUB_TOKEN" \ +> | curl -fsSL --config - -H "Accept: application/vnd.github.raw" \ +> https://api.github.com/repos/FelisMC/Felis/contents/deploy/bootstrap.sh \ +> | sudo -E bash +> ``` +> +> The token reaches `curl --config -` over stdin instead of the command line: argv is +> readable by any local user via `/proc`, and that is exactly why the installer's +> internal `github_api` uses the same form. + +Rerunning this command is also how you upgrade felis-api to a newer version (`felis setup` +cannot — it uses the binary already installed on the host). The rerun keeps the installed +root domain but **not** the channel: if this host follows main, also +`export FELIS_VERSION_BOOTSTRAP=dev`. + ## Build from Source Felis is built with Go and Node.js: