Sync README and installer header with the auto-open flow
This commit is contained in:
@@ -49,19 +49,22 @@ checksums), the installer scripts, and the `coordinator` image on GHCR:
|
|||||||
docker pull ghcr.io/emil28092005/SciMesh/coordinator:latest
|
docker pull ghcr.io/emil28092005/SciMesh/coordinator:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
For scientists: one command downloads the right binary and prints the start
|
For scientists: one command downloads the right binary, starts it, and opens
|
||||||
instructions:
|
the UI in the browser:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Linux / macOS
|
# Linux / macOS — installs, starts and opens the admin console automatically
|
||||||
curl -fsSL https://raw.githubusercontent.com/emil28092005/SciMesh/main/install.sh | bash
|
curl -fsSL https://raw.githubusercontent.com/emil28092005/SciMesh/main/install.sh | bash
|
||||||
coordinator serve --open
|
|
||||||
|
|
||||||
# Windows (PowerShell)
|
# Windows (PowerShell)
|
||||||
powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/emil28092005/SciMesh/main/install.ps1 | iex"
|
powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/emil28092005/SciMesh/main/install.ps1 | iex"
|
||||||
coordinator serve --open
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Set `SCIMESH_AUTO_START=0` to install without starting anything. A standalone
|
||||||
|
worker is installed the same way (`bash -s worker`, or
|
||||||
|
`SCIMESH_COMPONENT=worker` on Windows); its installer opens the local setup
|
||||||
|
wizard (`worker-agent setup`) in the browser automatically.
|
||||||
|
|
||||||
`coordinator serve` is the single-binary mode: it embeds SQLite (coordinator +
|
`coordinator serve` is the single-binary mode: it embeds SQLite (coordinator +
|
||||||
userservice databases), the userservice itself, and local worker agents
|
userservice databases), the userservice itself, and local worker agents
|
||||||
(`--workers N`, default 1). On first start it generates secrets and the admin
|
(`--workers N`, default 1). On first start it generates secrets and the admin
|
||||||
@@ -73,12 +76,14 @@ wheel to install it automatically.
|
|||||||
The coordinator serves two operator surfaces: the **control room** (jobs,
|
The coordinator serves two operator surfaces: the **control room** (jobs,
|
||||||
workloads, docs) and the **admin console** at `/ui/admin` — cluster health
|
workloads, docs) and the **admin console** at `/ui/admin` — cluster health
|
||||||
and storage, paginated job table, worker fleet with trust controls, users and
|
and storage, paginated job table, worker fleet with trust controls, users and
|
||||||
worker keys, workload enable/disable, metrics and the worker token. The
|
worker keys, workload enable/disable, metrics and the worker token
|
||||||
**worker** binary (`worker-agent`) carries its own local setup wizard for
|
(`serve --open` lands on the admin console; login returns you to the page you
|
||||||
machines that run only a worker: `worker-agent setup` opens a browser wizard
|
asked for). The **worker** binary (`worker-agent`) carries its own local setup
|
||||||
at `127.0.0.1` that collects the coordinator URL and credential, runs a
|
wizard for machines that run only a worker: `worker-agent setup` opens a
|
||||||
preflight check, saves `~/.scimesh-worker/config.json` and starts/stops the
|
browser wizard at `127.0.0.1` that collects the coordinator URL and
|
||||||
worker with a live log (see the [standalone docs](mkdocs/standalone.md)).
|
credential, runs a preflight check, saves `~/.scimesh-worker/config.json` and
|
||||||
|
starts/stops the worker with a live log (see the
|
||||||
|
[standalone docs](mkdocs/standalone.md)).
|
||||||
|
|
||||||
Manual download and run of a release binary:
|
Manual download and run of a release binary:
|
||||||
|
|
||||||
|
|||||||
+5
-4
@@ -1,14 +1,15 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
# SciMesh installer: downloads a binary for this OS/architecture from the
|
# SciMesh installer: downloads a binary for this OS/architecture from the
|
||||||
# newest GitHub release and installs it locally. One command, no picking from
|
# newest GitHub release, installs it locally, then starts it and opens its UI
|
||||||
# a list of files:
|
# in the browser (SCIMESH_AUTO_START=0 installs only). One command:
|
||||||
#
|
#
|
||||||
# curl -fsSL https://raw.githubusercontent.com/emil28092005/SciMesh/main/install.sh | bash
|
# curl -fsSL https://raw.githubusercontent.com/emil28092005/SciMesh/main/install.sh | bash
|
||||||
# curl -fsSL https://raw.githubusercontent.com/emil28092005/SciMesh/main/install.sh | bash -s worker
|
# curl -fsSL https://raw.githubusercontent.com/emil28092005/SciMesh/main/install.sh | bash -s worker
|
||||||
#
|
#
|
||||||
# The first form installs the coordinator (the whole platform in one binary:
|
# The first form installs the coordinator (the whole platform in one binary:
|
||||||
# databases, userservice, local workers). The second installs a standalone
|
# databases, userservice, local workers) and opens the admin console. The
|
||||||
# worker agent that joins an existing coordinator. Installed to ~/.local/bin
|
# second installs a standalone worker agent that joins an existing
|
||||||
|
# coordinator, and opens its local setup wizard. Installed to ~/.local/bin
|
||||||
# (Linux/macOS) or %LOCALAPPDATA%\SciMesh (Windows).
|
# (Linux/macOS) or %LOCALAPPDATA%\SciMesh (Windows).
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user