Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 7 additions & 3 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ <h1 id="hero-title">Your agent asks about the file. <span class="key">It never r
<div class="install">
<div class="install-head"><span>Install with Homebrew</span></div>
<pre tabindex="0" aria-label="Install commands"><code><span class="cmd">brew trust davidgodefroid/tap</span>
<span class="cmd">brew install davidgodefroid/tap/lox davidgodefroid/tap/lockfile</span></code></pre>
<p class="install-note">Linux only (the plugin sandbox needs Landlock and seccomp), with Docker. Then <code>lox add lockfile</code> and <code>lox run</code>. The whole family: <code>brew install davidgodefroid/tap/lockfamily</code>.</p>
<span class="cmd">brew install davidgodefroid/tap/lockfile davidgodefroid/tap/lox cosign</span></code></pre>
<p class="install-note">Linux only (the plugin sandbox needs Landlock and seccomp), with Docker. Needs lox v0.12.0+ and cosign v2.5.0+. Then <code>lox add lockfile</code> and <code>lox run</code>. The whole family: <code>brew install davidgodefroid/tap/lockfamily</code>.</p>
</div>
<div class="actions">
<a class="button primary" href="install/">Install guide</a>
Expand Down Expand Up @@ -183,7 +183,7 @@ <h2 id="highlights">Highlights</h2>
<section aria-labelledby="quick-start">
<h2 id="quick-start">Quick start</h2>
<ol class="steps prose">
<li><p>Install with Homebrew (the box above), on Linux. Docker must be running.</p></li>
<li><p>Install with Homebrew (the box above), on Linux: lockfile, lox v0.12.0+ and cosign v2.5.0+. Docker must be running.</p></li>
<li><p>In your project, <code>lox add lockfile</code> asks where your files are (S3, SFTP or a local directory), sets up the lock and starts its console.</p>
<pre tabindex="0"><code>cd your-project
lox add lockfile</code></pre></li>
Expand Down
7 changes: 4 additions & 3 deletions site/install/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@ <h2 id="homebrew">With Homebrew</h2>
<div class="install">
<div class="install-head"><span>Install with Homebrew</span></div>
<pre tabindex="0" aria-label="Install commands"><code><span class="cmd">brew trust davidgodefroid/tap</span>
<span class="cmd">brew install davidgodefroid/tap/lox davidgodefroid/tap/lockfile</span></code></pre>
<span class="cmd">brew install davidgodefroid/tap/lockfile davidgodefroid/tap/lox cosign</span></code></pre>
<p class="install-note">Homebrew asks you to trust a third-party tap once. The whole family instead: <code>brew install davidgodefroid/tap/lockfamily</code>.</p>
</div>
<div class="prose">
<p>The <code>lockfile</code> formula is Linux only. It installs the same launcher and seccomp profile as the install script, pinned to the same image digests. <code>lox</code> is <a href="https://github.com/DavidGodefroid/lockhub">lockhub</a>’s CLI.</p>
<p>The <code>lockfile</code> formula is Linux only. It installs the same launcher and seccomp profile as the install script, pinned to the same image digests. <code>lox</code> is <a href="https://github.com/DavidGodefroid/lockhub">lockhub</a>’s CLI; this release needs lox v0.12.0 or later. The formula does not pull in cosign, which <code>lox add</code> and <code>lox run</code> need.</p>
<p>Then, in your project (with lea: in its projects directory), let <a href="https://github.com/DavidGodefroid/lockhub/blob/main/docs/lox-add.md"><code>lox add lockfile</code></a> ask for your file store, set up the lock and start its console:</p>
</div>
<pre tabindex="0"><code>lox add lockfile <span class="cmt"># S3, SFTP or a local directory; the lock is named files by default</span>
Expand All @@ -83,7 +83,8 @@ <h2 id="requirements">Requirements</h2>
<ul class="prose">
<li><strong>Docker on Linux</strong>, on a kernel with Landlock and seccomp, which sandbox the plugins (Landlock also denies TCP from kernel ABI 4). <code>lockfile doctor</code> reports what the kernel offers. Without them, plans are refused with <code>E_SANDBOX_UNAVAILABLE</code>.</li>
<li><strong>On Windows</strong>, WSL 2 with Docker Desktop.</li>
<li><strong><a href="https://docs.sigstore.dev/cosign/system_config/installation/">cosign</a></strong> on <code>PATH</code>, for the install script and <code>lockfile update</code>. Without it nothing is installed: there is no unsigned mode. The image has its own cosign for the plugins.</li>
<li><strong><a href="https://github.com/DavidGodefroid/lockhub">lox</a> v0.12.0 or later</strong>, which sets up the lock and runs its console.</li>
<li><strong><a href="https://docs.sigstore.dev/cosign/system_config/installation/">cosign</a> v2.5.0 or later</strong> on <code>PATH</code>, for <code>lox add</code> and <code>lox run</code> (they verify every image), the install script and <code>lockfile update</code>. Without it nothing is installed: there is no unsigned mode. The image has its own cosign for the plugins.</li>
</ul>
</section>

Expand Down
Loading