diff --git a/README.md b/README.md index 3cbf95f..f6f5a59 100644 --- a/README.md +++ b/README.md @@ -61,15 +61,17 @@ brew install davidgodefroid/tap/lockfamily ``` That installs the Lock Family, locklog included. For locklog alone: -`brew install davidgodefroid/tap/locklog` (with `lox` for `lox add locklog` -and `lox run`), or the signed install script, which installs the launcher: +`brew install davidgodefroid/tap/locklog davidgodefroid/tap/lox cosign` +(`lox add locklog` and `lox run` need lox v0.12.0 or later), or the signed +install script, which installs the launcher: ```sh curl -fsSL https://locklog.dev/install.sh | sh ``` A Linux host with the logs, Docker ≥ 19.03 and -[cosign](https://docs.sigstore.dev/cosign/system_config/installation/). +[cosign](https://docs.sigstore.dev/cosign/system_config/installation/) +v2.5.0 or later (`lox add` and `lox run` verify every image with it). Status, the script read first, and production placement: [docs/install.md](docs/install.md). diff --git a/docs/install.md b/docs/install.md index 30f26bb..7fc4ec7 100644 --- a/docs/install.md +++ b/docs/install.md @@ -8,8 +8,11 @@ shows every ticket and decides it, by its rules or by you. ## Status - locklog is pre-release: the latest release is in the [CHANGELOG](../CHANGELOG.md). -- `lox add locklog` and the locklog console in `lox run` need lockhub - v0.10.0 or later ([lockhub#84](https://github.com/DavidGodefroid/lockhub/issues/84), +- `lox add locklog` and the locklog console in `lox run` need lox + (lockhub) v0.12.0 or later, the first release that runs locklog v0.4.0's + confined consoles ([lockhub#212](https://github.com/DavidGodefroid/lockhub/issues/212)); + lockhub v0.10.0 was the first to know the locklog type + ([lockhub#84](https://github.com/DavidGodefroid/lockhub/issues/84), [#86](https://github.com/DavidGodefroid/lockhub/issues/86), [#87](https://github.com/DavidGodefroid/lockhub/issues/87)). - The tap's `locklog` formula installs the latest release (the launcher @@ -30,8 +33,11 @@ gates (they stay a preview until then) and a masked export. - A Linux host with the logs. - Docker ≥ 19.03. -- [cosign](https://docs.sigstore.dev/cosign/system_config/installation/), - to verify the release and the image. +- [cosign](https://docs.sigstore.dev/cosign/system_config/installation/) + v2.5.0 or later, to verify the release and the image: `lox add` and + `lox run` refuse an older one up front + ([lockhub#197](https://github.com/DavidGodefroid/lockhub/issues/197)). +- lox v0.12.0 or later, for `lox add locklog` and `lox run`. - Homebrew, or (for `install.sh`) sudo for `/usr/local/bin`. ## With Homebrew @@ -46,7 +52,7 @@ lox run # in a terminal of its own, kept op `brew install davidgodefroid/tap/locklog` installs locklog's launcher alone: `lox add` and `lox run` also need -`brew install davidgodefroid/tap/lox`. +`brew install davidgodefroid/tap/lox cosign` (lox v0.12.0+, cosign v2.5.0+). `lox add locklog`, the guided form (it asks for the lock's name, or takes `--name NAME`), runs locklog's three launcher verbs from the project diff --git a/docs/setup.md b/docs/setup.md index f5b4880..09ebba0 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -29,11 +29,14 @@ lox add locklog # guided; or: lox init lox run # in a terminal of its own, outside the agent ``` -`lox add locklog` and the locklog console in `lox run` need lockhub -v0.10.0 or later, the first release that knows the locklog type (lockhub#84, -#86, #87). The tap's `lockfamily` formula installs it; -`brew install davidgodefroid/tap/locklog` installs the launcher alone, and -then also needs `brew install davidgodefroid/tap/lox`. +`lox add locklog` and the locklog console in `lox run` need lox (lockhub) +v0.12.0 or later, the first release that runs locklog v0.4.0's confined +consoles (lockhub#212; v0.10.0 was the first to know the locklog type, +lockhub#84, #86, #87), and cosign v2.5.0 or later, with which `lox add` and +`lox run` verify every image (lockhub#197). The tap's `lockfamily` formula +installs both; `brew install davidgodefroid/tap/locklog` installs the +launcher alone, and then also needs +`brew install davidgodefroid/tap/lox cosign`. The alternative, without Homebrew, installs the launcher alone, cosign-verified: diff --git a/site/index.html b/site/index.html index 6d0e186..fa5881a 100644 --- a/site/index.html +++ b/site/index.html @@ -63,7 +63,7 @@
brew trust davidgodefroid/tap
brew install davidgodefroid/tap/lockfamily
- The family includes locklog. For locklog alone: brew install davidgodefroid/tap/locklog or its install script.
The family includes locklog. For locklog alone, with lox and cosign: brew install davidgodefroid/tap/locklog davidgodefroid/tap/lox cosign or its install script.
locklog is pre-release: the latest release is in the CHANGELOG below. Its console is started by lox run (lockhub) only.
lox add locklog and the locklog console in lox run need lockhub v0.10.0 or later (lockhub#84, #86, #87).lox add locklog and the locklog console in lox run need lox (lockhub) v0.12.0 or later, the first release that runs locklog v0.4.0’s confined consoles (lockhub#212); lockhub v0.10.0 was the first to know the locklog type (lockhub#84, #86, #87).locklog formula installs the latest release (the launcher alone), and the lockfamily formula includes locklog and lox.install.sh installs the latest published release of the launcher, whose verbs you can run yourself.lox add and lox run refuse an older one up front.lox add locklog and lox run.install.sh) sudo for /usr/local/bin.lox run stays open.brew trust davidgodefroid/tap
brew install davidgodefroid/tap/lockfamily
- Homebrew asks you to trust a third-party tap once. brew install davidgodefroid/tap/locklog installs this Lock alone; lox add and lox run also need davidgodefroid/tap/lox.
Homebrew asks you to trust a third-party tap once. brew install davidgodefroid/tap/locklog installs this Lock alone; lox add and lox run also need lox v0.12.0+ and cosign v2.5.0+: brew install davidgodefroid/tap/locklog davidgodefroid/tap/lox cosign.
From the project whose logs the agent investigates, lox add locklog (the guided form: it asks for the lock’s name) sets up the lock (or lox init). With a name, lox add locklog <name> only declares a lock whose profile exists.