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
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
16 changes: 11 additions & 5 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
13 changes: 8 additions & 5 deletions docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ <h1 id="hero-title">Your agent reads the logs, <span class="key">not the people
<div class="install-head"><span>Install the Lock Family 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/lockfamily</span></code></pre>
<p class="install-note">The family includes locklog. For locklog alone: <code>brew install davidgodefroid/tap/locklog</code> or <a href="install/#install-sh">its install script</a>.</p>
<p class="install-note">The family includes locklog. For locklog alone, with lox and cosign: <code>brew install davidgodefroid/tap/locklog davidgodefroid/tap/lox cosign</code> or <a href="install/#install-sh">its install script</a>.</p>
</div>
<div class="actions">
<a class="button primary" href="install/">Install guide</a>
Expand Down
7 changes: 4 additions & 3 deletions site/install/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h2 id="status">Status</h2>
<div class="prose">
<p>locklog is pre-release: the latest release is in the CHANGELOG below. Its console is started by <code>lox run</code> (lockhub) only.</p>
<ul>
<li><code>lox add locklog</code> and the locklog console in <code>lox run</code> need lockhub v0.10.0 or later (<a href="https://github.com/DavidGodefroid/lockhub/issues/84">lockhub#84</a>, <a href="https://github.com/DavidGodefroid/lockhub/issues/86">#86</a>, <a href="https://github.com/DavidGodefroid/lockhub/issues/87">#87</a>).</li>
<li><code>lox add locklog</code> and the locklog console in <code>lox run</code> need lox (lockhub) v0.12.0 or later, the first release that runs locklog v0.4.0’s confined consoles (<a href="https://github.com/DavidGodefroid/lockhub/issues/212">lockhub#212</a>); lockhub v0.10.0 was the first to know the locklog type (<a href="https://github.com/DavidGodefroid/lockhub/issues/84">lockhub#84</a>, <a href="https://github.com/DavidGodefroid/lockhub/issues/86">#86</a>, <a href="https://github.com/DavidGodefroid/lockhub/issues/87">#87</a>).</li>
<li>The tap’s <code>locklog</code> formula installs the latest release (the launcher alone), and the <code>lockfamily</code> formula includes locklog and <code>lox</code>.</li>
<li>Without Homebrew, <code>install.sh</code> installs the latest <strong>published</strong> release of the launcher, whose verbs you can run yourself.</li>
</ul>
Expand All @@ -78,7 +78,8 @@ <h2 id="prerequisites">Prerequisites</h2>
<ul class="prose">
<li>A Linux host with the logs.</li>
<li>Docker 19.03 or later.</li>
<li><a href="https://docs.sigstore.dev/cosign/system_config/installation/">cosign</a>, to verify the release and the image.</li>
<li><a href="https://docs.sigstore.dev/cosign/system_config/installation/">cosign</a> v2.5.0 or later, to verify the release and the image: <code>lox add</code> and <code>lox run</code> refuse an older one up front.</li>
<li>lox v0.12.0 or later, for <code>lox add locklog</code> and <code>lox run</code>.</li>
<li>Homebrew, or (for <code>install.sh</code>) sudo for <code>/usr/local/bin</code>.</li>
<li>A terminal you keep in view, where <code>lox run</code> stays open.</li>
</ul>
Expand All @@ -90,7 +91,7 @@ <h2 id="install">With Homebrew</h2>
<div class="install-head"><span>Install the Lock Family 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/lockfamily</span></code></pre>
<p class="install-note">Homebrew asks you to trust a third-party tap once. <code>brew install davidgodefroid/tap/locklog</code> installs this Lock alone; <code>lox add</code> and <code>lox run</code> also need <code>davidgodefroid/tap/lox</code>.</p>
<p class="install-note">Homebrew asks you to trust a third-party tap once. <code>brew install davidgodefroid/tap/locklog</code> installs this Lock alone; <code>lox add</code> and <code>lox run</code> also need lox v0.12.0+ and cosign v2.5.0+: <code>brew install davidgodefroid/tap/locklog davidgodefroid/tap/lox cosign</code>.</p>
</div>
<ol class="steps prose">
<li><p>From the project whose logs the agent investigates, <code>lox add locklog</code> (the guided form: it asks for the lock’s name) sets up the lock (or <code>lox init</code>). With a name, <code>lox add locklog &lt;name&gt;</code> only declares a lock whose profile exists.</p>
Expand Down
Loading