Sanaei
f727d04f65
CI / go-test (push) Canceled after 0s
CI / postgres-durable-first (push) Canceled after 0s
CI / codegen (push) Canceled after 0s
CI / govulncheck (push) Canceled after 0s
CI / race (push) Canceled after 0s
CI / fuzz-smoke (push) Canceled after 0s
CI / golangci (push) Canceled after 0s
CI / frontend (push) Canceled after 0s
CodeQL Advanced / Analyze (go) (push) Canceled after 0s
CodeQL Advanced / Analyze (actions) (push) Canceled after 0s
CodeQL Advanced / Analyze (javascript-typescript) (push) Canceled after 0s
Docs CI / build (push) Canceled after 0s
Docs Deploy (GitHub Pages) / build (push) Canceled after 0s
Release 3X-UI / build (386) (push) Canceled after 0s
Release 3X-UI / build (amd64) (push) Canceled after 0s
Release 3X-UI / build (arm64) (push) Canceled after 0s
Release 3X-UI / build (armv5) (push) Canceled after 0s
Release 3X-UI / build (armv6) (push) Canceled after 0s
Release 3X-UI / build (armv7) (push) Canceled after 0s
Release 3X-UI / build (s390x) (push) Canceled after 0s
Release 3X-UI / Build for Windows (amd64) (push) Canceled after 0s
Deploy Smoke Tests / noninteractive-install (ubuntu-24.04-arm) (push) Canceled after 0s
Deploy Smoke Tests / noninteractive-install (ubuntu-latest) (push) Canceled after 0s
Deploy Smoke Tests / release-tag-install (ubuntu-24.04-arm) (push) Canceled after 0s
Deploy Smoke Tests / release-tag-install (ubuntu-latest) (push) Canceled after 0s
Docs Deploy (GitHub Pages) / deploy (push) Canceled after 0s
Release 3X-UI / Publish rolling dev release (push) Canceled after 0s
32 lines
1.4 KiB
Markdown
32 lines
1.4 KiB
Markdown
# Cloud deployment (unattended install)
|
|
|
|
Tooling to ship the 3x-ui panel via unattended install, with **per-instance
|
|
credentials generated on first boot** (never `admin/admin`, never a shared
|
|
session secret). Works on amd64 and arm64.
|
|
|
|
| Path | What it is | Use when |
|
|
| --- | --- | --- |
|
|
| [`cloud-init/`](cloud-init/) | Generic cloud-init user-data (unattended `install.sh`) | Any cloud, no image build |
|
|
| [`marketplace/hetzner/`](marketplace/hetzner/) | Hetzner Cloud notes | Hetzner deployments |
|
|
| [`test/`](test/) | Container smoke test | Verifying the install path |
|
|
|
|
## How it works
|
|
|
|
`install.sh` runs unattended when `XUI_NONINTERACTIVE=1` or stdin is not a TTY.
|
|
Each instance installs and configures itself with random credentials. See
|
|
[`cloud-init/README.md`](cloud-init/README.md).
|
|
|
|
## Unattended install knobs
|
|
|
|
`install.sh` reads these env vars in non-interactive mode (all optional; unset ⇒
|
|
secure random / default):
|
|
|
|
`XUI_USERNAME`, `XUI_PASSWORD`, `XUI_PANEL_PORT`, `XUI_WEB_BASE_PATH`,
|
|
`XUI_SSL_MODE` (`none`|`ip`|`domain`, default `none`), `XUI_DOMAIN`,
|
|
`XUI_ACME_EMAIL`, `XUI_ACME_HTTP_PORT` (ACME HTTP-01 listener port, default `80`),
|
|
`XUI_SSL_IPV6` (optional IPv6 address to add to an `ip`-mode cert),
|
|
`XUI_SERVER_IP` (fallback IP for the displayed access URL when auto-detection fails),
|
|
`XUI_DB_TYPE` (`sqlite`|`postgres`), `XUI_DB_DSN`.
|
|
|
|
The resulting credentials are written to `/etc/x-ui/install-result.env` (mode 600).
|