Emil_Shanaty/SciMesh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync README and installer header with the auto-open flow

Browse Source
This commit is contained in:
Emil
2026-08-03 00:33:50 +03:00
parent 8b7094b0cb
commit c301499bef
2 changed files with 21 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -11
View File
@@ -49,19 +49,22 @@ checksums), the installer scripts, and the `coordinator` image on GHCR:
docker pull ghcr.io/emil28092005/SciMesh/coordinator:latest
```
For scientists: one command downloads the right binary and prints the start
instructions:
For scientists: one command downloads the right binary, starts it, and opens
the UI in the browser:
```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
coordinator serve --open
# Windows (PowerShell)
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 +
userservice databases), the userservice itself, and local worker agents
(`--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,
workloads, docs) and the **admin console** at `/ui/admin` — cluster health
and storage, paginated job table, worker fleet with trust controls, users and
worker keys, workload enable/disable, metrics and the worker token. The
**worker** binary (`worker-agent`) carries its own local setup wizard for
machines that run only a worker: `worker-agent setup` opens a browser wizard
at `127.0.0.1` that collects the coordinator URL and 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)).
worker keys, workload enable/disable, metrics and the worker token
(`serve --open` lands on the admin console; login returns you to the page you
asked for). The **worker** binary (`worker-agent`) carries its own local setup
wizard for machines that run only a worker: `worker-agent setup` opens a
browser wizard at `127.0.0.1` that collects the coordinator URL and
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:
install.sh
+5 -4
View File
@@ -1,14 +1,15 @@
#!/usr/bin/env bash
# SciMesh installer: downloads a binary for this OS/architecture from the
# newest GitHub release and installs it locally. One command, no picking from
# a list of files:
# newest GitHub release, installs it locally, then starts it and opens its UI
# 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 -s worker
#
# The first form installs the coordinator (the whole platform in one binary:
# databases, userservice, local workers). The second installs a standalone
# worker agent that joins an existing coordinator. Installed to ~/.local/bin
# databases, userservice, local workers) and opens the admin console. The
# 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).
set -eu