Skip to content

docs/feat: relay self-host guide + multi-arch deploy, CLI install.sh - #1550

Merged
bobleer merged 2 commits into
GCWing:mainfrom
bobleer:docs/relay-selfhost-account-guide
Jul 14, 2026
Merged

docs/feat: relay self-host guide + multi-arch deploy, CLI install.sh#1550
bobleer merged 2 commits into
GCWing:mainfrom
bobleer:docs/relay-selfhost-account-guide

Conversation

@bobleer

@bobleer bobleer commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Expand relay-server README for open-source self-host account setup (deploy → relay-admin add-user → Desktop/CLI login).
  • Harden one-click relay scripts for common Linux amd64/arm64: shared common.sh, Compose V2/V1, native host builds, health probe via container curl, optional RELAY_CARGO_BUILD_JOBS, empty-DB add-user reminder.
  • Add BitFun CLI install.sh (+ README / pnpm run cli:install): release build, install to ~/.local/bin, idempotent ~/.bashrc / ~/.zshrc PATH blocks, source when interactive.

Test plan

  • Fresh relay deploy with empty DB prints exact add-user command
  • bash deploy.sh --help shows amd64/arm64 + env vars
  • On amd64 and/or arm64 Linux with Docker: bash deploy.sh (or RELAY_CARGO_BUILD_JOBS=1) succeeds and /health passes
  • bash src/apps/cli/install.sh --help works
  • bash src/apps/cli/install.sh installs bitfun-cli and PATH markers appear once in bashrc/zshrc (re-run stays idempotent)
  • New shell can run bitfun-cli

bobleer added 2 commits July 14, 2026 19:29
…sers

Expand the relay README with an account-enabled deploy checklist, and make
deploy.sh remind operators with the exact add-user command when no accounts exist.
Make relay one-click scripts portable across Compose V1/V2 and native
linux/amd64+arm64 hosts, and add a CLI install script that builds release,
installs to ~/.local/bin, and wires bashrc/zshrc PATH.
@bobleer bobleer changed the title docs(relay-server): clarify self-host account setup for open-source users docs/feat: relay self-host guide + multi-arch deploy, CLI install.sh Jul 14, 2026
@bobleer
bobleer merged commit d3c7df5 into GCWing:main Jul 14, 2026
1 check passed
@bobleer
bobleer deleted the docs/relay-selfhost-account-guide branch July 14, 2026 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant