Unverified Commit 62c5a8a4 authored by Lemon-miaow's avatar Lemon-miaow
Browse files

docs(readme): port the private-repo install path and upgrade notes to the English README (#66) 

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.
parent 5f9380df

README_EN.md

+21 −0
Changes for README_EN.md: 21 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -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=<a token with read access to this repository>

> 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: