Configure full Docker setup and confirm consequential actions
This commit is contained in:
+30
-5
@@ -1,22 +1,46 @@
|
||||
# Installation
|
||||
|
||||
Installation requires **Go only**. OpenCode is needed when authoring or executing
|
||||
model stages. Docker/ntfy is optional and is configured separately.
|
||||
The interactive installer offers **Docker server + ntfy** (default) or **native
|
||||
binaries only**. Native installation requires Go; Docker setup requires Docker
|
||||
Compose and Python 3, and includes OpenCode in the persistent server container.
|
||||
|
||||
```sh
|
||||
git clone https://git.a-wan.net/alan/pipelines.git
|
||||
cd pipelines
|
||||
./install.sh
|
||||
# Equivalent: go install ./cmd/... && pipelines skill install
|
||||
# Explicit choices:
|
||||
./install.sh --docker # complete server/ntfy setup, including provider login
|
||||
./install.sh --native # binaries/skill only; honors GOBIN/GOPATH
|
||||
```
|
||||
|
||||
This installs `pipelines`, `pipelines-server`, and `pipelines-tui`. Go chooses the
|
||||
Native mode installs `pipelines`, `pipelines-server`, and `pipelines-tui`. Go chooses the
|
||||
destination using `GOBIN`, or the usual `GOPATH/bin` default. Put that directory
|
||||
on PATH. No privileged operations, private dependency installation, login prompts,
|
||||
Docker provisioning, service registration, or background processes are involved.
|
||||
Re-running installation updates the binaries and bundled OpenCode skill without
|
||||
changing databases, login, or OpenCode configuration files.
|
||||
|
||||
Docker mode prompts for the phone-facing ntfy base URL, explicit bind IP, and
|
||||
timezone if it cannot be detected. It preserves an existing `.env`, bootstraps
|
||||
the publishing/phone accounts and publishing token, builds the server, installs
|
||||
the skill inside the container, and opens **container OpenCode provider login**
|
||||
on first setup. Choose any supported provider; signup is handled by that provider.
|
||||
Provider credentials remain in the `opencode-home` volume. Reinstalls skip login
|
||||
after completed setup; `./install.sh --docker --relogin` opens it again without
|
||||
deleting accounts. The installer then starts/recreates the Compose services,
|
||||
checks ntfy health through Pipelines, and sends an authenticated test notification.
|
||||
It does not register an OS service, delete volumes, or seed pipeline definitions.
|
||||
Phone reception/model inference are not verified by installation.
|
||||
|
||||
For fresh configuration you can supply `--ntfy-url https://ntfy.example.com
|
||||
--bind-address 127.0.0.1 --timezone Europe/London --port 8081` after `--docker`.
|
||||
Use a LAN/VPN interface IP instead of loopback for direct phone access; only use
|
||||
plain HTTP on a trusted network. Existing `.env` settings are never silently
|
||||
replaced. Without a terminal, no-argument installation remains binary-only and
|
||||
prints that limitation; use an interactive terminal for first Docker/provider setup.
|
||||
Install native mode as well if you want host CLI/TUI binaries; Docker mode installs
|
||||
the server and CLI in its image. See [Docker setup](docker.md).
|
||||
|
||||
For a private repository, use your normal Git credentials and `GOPRIVATE`:
|
||||
|
||||
```sh
|
||||
@@ -112,7 +136,8 @@ No login or provider credentials are copied or exported by Pipelines.
|
||||
|
||||
## Optional notifications
|
||||
|
||||
Use an existing ntfy server or the optional Docker setup in [docs/ntfy.md](ntfy.md).
|
||||
Full Docker installation configures this automatically via `./install.sh --docker`.
|
||||
For native mode, use an existing ntfy server or the Docker setup in [docs/ntfy.md](ntfy.md).
|
||||
Configure `PIPELINES_NTFY_URL`, `PIPELINES_NTFY_PUBLIC_URL`, and a publishing token
|
||||
via `PIPELINES_NTFY_TOKEN_FILE` in the server's environment. Keep secrets out of
|
||||
pipeline definitions. Use HTTPS or an encrypted VPN for phone access; do not
|
||||
|
||||
Reference in New Issue
Block a user