diff --git a/README.md b/README.md index 7d50ea9..9909956 100644 --- a/README.md +++ b/README.md @@ -62,16 +62,19 @@ lockfile answers the one question an agent needs about them, and nothing else. ```sh brew trust davidgodefroid/tap -brew install davidgodefroid/tap/lox davidgodefroid/tap/lockfile +brew install davidgodefroid/tap/lockfile davidgodefroid/tap/lox cosign ``` lockfile runs in Docker, on Linux (the formula is Linux only; on Windows, WSL 2 with Docker Desktop). Homebrew installs the `lockfile` launcher, which runs -every command in the release's image. `lox` is lockhub's CLI. The whole -family instead: `brew install davidgodefroid/tap/lockfamily`. - -Without Homebrew, the signed install script of a release (needs -[cosign](https://docs.sigstore.dev/cosign/system_config/installation/)): +every command in the release's image. `lox` is lockhub's CLI: this release +needs lox v0.12.0 or later. `lox add` and `lox run` verify every image with +[cosign](https://docs.sigstore.dev/cosign/system_config/installation/) v2.5.0 +or later, which the `lockfile` formula does not pull in. The whole family +instead: `brew install davidgodefroid/tap/lockfamily`. + +Without Homebrew, the signed install script of a release (needs cosign +v2.5.0+; install lox v0.12.0+ beside the launcher): ```sh V=vX.Y.Z diff --git a/docs/install.md b/docs/install.md index fe49c2a..ffcfc50 100644 --- a/docs/install.md +++ b/docs/install.md @@ -11,14 +11,17 @@ each of them in the signed release image. Full guide: ```sh brew trust davidgodefroid/tap -brew install davidgodefroid/tap/lox davidgodefroid/tap/lockfile +brew install davidgodefroid/tap/lockfile davidgodefroid/tap/lox cosign ``` Homebrew asks you to trust a third-party tap once. The `lockfile` formula is Linux only; it installs the same launcher and seccomp profile as `scripts/install.sh`, pinned to the same image digests. Each release tag bumps that formula ([homebrew-tap](https://github.com/DavidGodefroid/homebrew-tap)). -`lox` is [lockhub](https://github.com/DavidGodefroid/lockhub)'s CLI. The whole +`lox` is [lockhub](https://github.com/DavidGodefroid/lockhub)'s CLI: this +release needs lox v0.12.0 or later. `lox add` and `lox run` verify every image +with [cosign](https://docs.sigstore.dev/cosign/system_config/installation/) +v2.5.0 or later, which the `lockfile` formula does not pull in. The whole Lock Family instead: `brew install davidgodefroid/tap/lockfamily`. Then let @@ -49,7 +52,8 @@ by digest, cosign and the Vault CLI by sha256; the image has no `sudo`. ## First plan, step by step -With lockfile's own installer and [cosign](https://docs.sigstore.dev/cosign/system_config/installation/): +With lockfile's own installer, [cosign](https://docs.sigstore.dev/cosign/system_config/installation/) +v2.5.0+ and lox v0.12.0+: ```sh # 1. The launcher and the seccomp profile the console runs under (cosign checks the diff --git a/site/index.html b/site/index.html index e3657fd..3a732ab 100644 --- a/site/index.html +++ b/site/index.html @@ -63,8 +63,8 @@
brew trust davidgodefroid/tap
-brew install davidgodefroid/tap/lox davidgodefroid/tap/lockfile
- Linux only (the plugin sandbox needs Landlock and seccomp), with Docker. Then lox add lockfile and lox run. The whole family: brew install davidgodefroid/tap/lockfamily.
Linux only (the plugin sandbox needs Landlock and seccomp), with Docker. Needs lox v0.12.0+ and cosign v2.5.0+. Then lox add lockfile and lox run. The whole family: brew install davidgodefroid/tap/lockfamily.
Install with Homebrew (the box above), on Linux. Docker must be running.
Install with Homebrew (the box above), on Linux: lockfile, lox v0.12.0+ and cosign v2.5.0+. Docker must be running.
In your project, lox add lockfile asks where your files are (S3, SFTP or a local directory), sets up the lock and starts its console.
cd your-project
lox add lockfilebrew trust davidgodefroid/tap
-brew install davidgodefroid/tap/lox davidgodefroid/tap/lockfile
+brew install davidgodefroid/tap/lockfile davidgodefroid/tap/lox cosign
Homebrew asks you to trust a third-party tap once. The whole family instead: brew install davidgodefroid/tap/lockfamily.
The lockfile formula is Linux only. It installs the same launcher and seccomp profile as the install script, pinned to the same image digests. lox is lockhub’s CLI.
The lockfile formula is Linux only. It installs the same launcher and seccomp profile as the install script, pinned to the same image digests. lox is lockhub’s CLI; this release needs lox v0.12.0 or later. The formula does not pull in cosign, which lox add and lox run need.
Then, in your project (with lea: in its projects directory), let lox add lockfile ask for your file store, set up the lock and start its console:
lox add lockfile # S3, SFTP or a local directory; the lock is named files by default
@@ -83,7 +83,8 @@ Requirements
- Docker on Linux, on a kernel with Landlock and seccomp, which sandbox the plugins (Landlock also denies TCP from kernel ABI 4).
lockfile doctor reports what the kernel offers. Without them, plans are refused with E_SANDBOX_UNAVAILABLE.
- On Windows, WSL 2 with Docker Desktop.
- - cosign on
PATH, for the install script and lockfile update. Without it nothing is installed: there is no unsigned mode. The image has its own cosign for the plugins.
+ - lox v0.12.0 or later, which sets up the lock and runs its console.
+ - cosign v2.5.0 or later on
PATH, for lox add and lox run (they verify every image), the install script and lockfile update. Without it nothing is installed: there is no unsigned mode. The image has its own cosign for the plugins.