Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
116 commits
Select commit Hold shift + click to select a range
cce363d
feat(serve)!: remove the browser page
helightdev Nov 14, 2026
2ff37e1
ci: drop the wasm build and the berth-web release archive
helightdev Nov 14, 2026
afe1eca
docs: point to berth-remote where the browser page was
helightdev Nov 14, 2026
a075396
feat(serve): read roles from the keys of an object claim
helightdev Nov 14, 2026
a721b9b
feat(serve): tell a follower how many events it missed
helightdev Nov 14, 2026
c67c0a7
feat(serve): tell changes to hosts and resources on events.follow
helightdev Nov 14, 2026
45903b9
feat(api): ports.connect, a stream to a port on a host's loopback
helightdev Nov 14, 2026
f3140bc
feat(api): raise the API number to 2
helightdev Nov 14, 2026
d286b9b
refactor!: a host has a type, not a level
helightdev Nov 14, 2026
7f0015b
refactor!: a profile says its target, not its profile
helightdev Nov 14, 2026
8ebd61c
feat(core): read profiles of berth 0.5 with the names of now
helightdev Nov 14, 2026
b9e670a
refactor!: a host's tasks are actions on the wire
helightdev Nov 14, 2026
fdec79e
Merge pull request #44 from helightdev/rework-remove-web
helightdev Nov 14, 2026
98f0777
Merge pull request #45 from helightdev/rework-api
helightdev Nov 14, 2026
2d6dc82
feat: berth ui, the screens of berth serve with a server in the process
helightdev Nov 14, 2026
94d0560
refactor(page)!: the screens' terminal, network and settings are bert…
helightdev Nov 15, 2026
ff3a49d
feat(serve): the USB installer and every setting for the server's own…
helightdev Nov 15, 2026
adc7cbd
feat!: berth's screens are berth-page's, and the old terminal UI is gone
helightdev Nov 15, 2026
a70ffa9
feat!: berth for macOS and Windows, and no berth-remote
helightdev Nov 15, 2026
6377308
Merge pull request #46 from helightdev/rework-names
helightdev Nov 15, 2026
8f4d553
fix(page): ask for hosts' sudo passwords before the screens, and say …
helightdev Nov 15, 2026
61635a3
docs: one berth with its screens on every system
helightdev Nov 15, 2026
55c6da7
feat(serve): endpoints of resources, resources.connect and exec
helightdev Nov 15, 2026
b31d8b0
feat(plugins): docker and incus report endpoints and run commands
helightdev Nov 15, 2026
f5ce39f
test(e2e): endpoints, tunnels and commands of resources
helightdev Nov 15, 2026
b4aa9bd
docs: endpoints, resources.connect and exec of resources
helightdev Nov 15, 2026
e5ffab0
feat(core): the host type node, applied without a desktop, whose feat…
helightdev Nov 15, 2026
a4f1005
feat(role): a path for a node, with its firewall, SSH for its own use…
helightdev Nov 15, 2026
c4fea68
feat(plugins): the features incus/server and docker/engine for a node
helightdev Nov 15, 2026
80cc306
Merge pull request #47 from helightdev/rework-one-ui
helightdev Nov 15, 2026
8b4efb0
test: a node's type, apply record and server upgrade action
helightdev Nov 15, 2026
9fe326f
Merge remote-tracking branch 'origin/rework' into rework-resources
helightdev Nov 15, 2026
0ec060a
fix(api): an error's code is in a header too
helightdev Nov 15, 2026
44b02b1
docs: nodes, and the recipes without incus-host
helightdev Nov 15, 2026
29d0e22
feat!: hosts join the tailnet only with keys berth makes
helightdev Nov 15, 2026
3a3c724
feat(role)!: no joining the tailnet by hand
helightdev Nov 15, 2026
c9e96c2
docs: joining the tailnet with keys berth makes
helightdev Nov 15, 2026
00686bd
test: the node's role path, firewall, server upgrade and features
helightdev Nov 15, 2026
788d0de
feat(tui): the set-up flow as questions, with each problem on its field
helightdev Nov 15, 2026
035b6d1
Merge remote-tracking branch 'origin/rework' into rework-tailnet
helightdev Nov 15, 2026
d6078ba
feat!: one grammar for the command line, each command a call of the API
helightdev Nov 15, 2026
2275832
test(e2e): a node on dock, whose feature offers a provisioner
helightdev Nov 15, 2026
a43d637
test(e2e): the refusal of an apply names both types that are applied
helightdev Nov 15, 2026
7c0dfb3
feat(cli): a provisioner's page names the node it is on
helightdev Nov 15, 2026
a54cd9a
fix(api): an error's code is in a header too
helightdev Nov 15, 2026
5aa387b
refactor!: no mirror of a server's hosts, and messages that name the …
helightdev Nov 15, 2026
09cdcbe
Merge pull request #48 from helightdev/rework-resources
helightdev Nov 15, 2026
0035a47
Merge remote-tracking branch 'origin/rework' into rework-tailnet
helightdev Nov 15, 2026
d3feaf0
fix(role): a node's berthd runs sessions without the workstation's ag…
helightdev Nov 15, 2026
35e13a9
Merge remote-tracking branch 'origin/rework' into rework-nodes
helightdev Nov 15, 2026
525c63f
test(e2e): the seeded host of the serve tests stays off the tailnet
helightdev Nov 15, 2026
c876017
Merge pull request #49 from helightdev/rework-tailnet
helightdev Nov 15, 2026
f289666
Merge remote-tracking branch 'origin/rework' into rework-nodes
helightdev Nov 15, 2026
1fc7b38
feat(cli): pages for plugins, provisioners and resources, and refusal…
helightdev Nov 15, 2026
ef1869d
test(e2e): the new command grammar and its output
helightdev Nov 15, 2026
2730425
docs: the command line by task, and every quoted command in its new form
helightdev Nov 15, 2026
91f9ca3
Merge pull request #50 from helightdev/rework-nodes
helightdev Nov 15, 2026
d8dbf7d
fix(cli): an action's output on standard output, a roll-out's line fo…
helightdev Nov 15, 2026
198096d
test(e2e): registry options as flags, and a refused check that exits 1
helightdev Nov 15, 2026
ec062bc
Merge branch 'rework' into rework-cli
helightdev Nov 15, 2026
20ffb62
feat(berthd): endpoints.connect, a stream to an address on the host's…
helightdev Nov 15, 2026
07f1ef8
feat(serve): reach a resource of a node's provisioner through the nod…
helightdev Nov 15, 2026
0c15b16
feat(plugins): report endpoints as the node sees them when berth name…
helightdev Nov 15, 2026
baecaf5
test(e2e): reach a deployment's endpoints on a node through its contr…
helightdev Nov 15, 2026
12ee936
docs: who dials a resource's endpoint, and endpoints.connect
helightdev Nov 15, 2026
f0e26dd
feat(cli): nodes in the set-up flow, resource exec and endpoints, and…
helightdev Nov 15, 2026
62bf345
feat(serve): jobs.stop, berth job stop, and Ctrl+C that asks whether …
helightdev Nov 15, 2026
c80fc07
feat(cli): berth config covers the client's own settings
helightdev Nov 15, 2026
2d04c56
docs: nodes, features and the API commands in the command line's grammar
helightdev Nov 15, 2026
23f709e
test(e2e): nodes, endpoints, resource exec and the tailnet settings i…
helightdev Nov 15, 2026
736b768
fix(page): a node's type keeps a workstation's accounts aside, and a …
helightdev Nov 15, 2026
8190eda
fix(cli): a host of the type ssh is refused an apply with the node am…
helightdev Nov 15, 2026
602135a
Merge pull request #52 from helightdev/rework-node-dial
helightdev Nov 15, 2026
b8ee3af
Merge remote-tracking branch 'origin/rework' into rework-cli
helightdev Nov 15, 2026
cc83b6e
Merge pull request #51 from helightdev/rework-cli
helightdev Nov 15, 2026
03a4ab5
feat(cli): take the screens' colours for prompts, progress, tables an…
helightdev Nov 15, 2026
308cb70
fix(setup): offer the install methods a host's type allows
helightdev Nov 15, 2026
5783c43
test(cli): a chosen row is marked as in the screens
helightdev Nov 15, 2026
bbdf78c
feat(serve): keep what a job was started with, such as the command of…
helightdev Nov 15, 2026
dd48e76
refactor(tui): keep the quoting of a job's words with the job's panel
helightdev Nov 15, 2026
c1094e8
fix(page): wrap problems, refusals and long status lines instead of c…
helightdev Nov 15, 2026
68763fe
fix(serve): take a host's key from the server user's known_hosts for …
helightdev Nov 15, 2026
a7dcd16
fix(cli): ask for a host's sudo password once for the server in the p…
helightdev Nov 15, 2026
0356acb
fix(cli): host show -o json is the API's document, adopt takes --deta…
helightdev Nov 15, 2026
902606c
refactor(tui): name the cells of a wrapped line
helightdev Nov 15, 2026
d71c64f
fix(serve): a request's role does not depend on what it says of itself
helightdev Nov 15, 2026
41a8188
docs: say host, resource and action where berth means them, and fill …
helightdev Nov 15, 2026
5a9c9e8
docs: make AGENTS.md true to the tree, and give the API reference's g…
helightdev Nov 15, 2026
60636b1
fix(page): berth ui NAME starts the set-up of a host the server does …
helightdev Nov 15, 2026
4b9d98b
docs: a quick start that works with the commands of now, and a contai…
helightdev Nov 15, 2026
e99dcd5
fix(cli): say why an action cannot run under its table, not in a column
helightdev Nov 15, 2026
a6833e2
docs: take the screenshots again
helightdev Nov 15, 2026
e868703
Merge pull request #55 from helightdev/rework-guard
helightdev Nov 15, 2026
eb2b595
fix(serve): a stop asked as a job ends finds it ended
helightdev Nov 15, 2026
6950584
style(tui): format the logo's line
helightdev Nov 15, 2026
e9cd1f9
fix(core): a node's report changes only the node's own provisioners
helightdev Nov 15, 2026
a01b338
fix(portal): bound what one caller can make a portal hold
helightdev Nov 15, 2026
88fa6d1
fix(serve): a profile holds settings of the role, never of Ansible it…
helightdev Nov 15, 2026
0918c4b
fix(role): carry a server container's log options when it is upgraded
helightdev Nov 15, 2026
7f243e2
fix(recipes): update the berth server's container in place with its o…
helightdev Nov 15, 2026
9fdc771
fix(role): a node taken in keeps its SSH limits and root's key login
helightdev Nov 15, 2026
ab6ccdf
fix(api): a refused stream says why from its head alone
helightdev Nov 15, 2026
4e0ba1a
Merge pull request #57 from helightdev/rework-polish
helightdev Nov 15, 2026
d7641cc
Merge remote-tracking branch 'origin/rework' into rework-harden
helightdev Nov 15, 2026
ac11d62
fix(page): never lose a kept token, and take in berth-remote's settin…
helightdev Nov 15, 2026
21187ea
fix(cli): say which side is older when the client, the server or a co…
helightdev Nov 15, 2026
82ace4a
fix(serve): answer what berth 0.5 left behind, and refuse with exit 3…
helightdev Nov 15, 2026
dbed17d
fix(core): hosts of berth 0.5 that it never joined to the tailnet kee…
helightdev Nov 15, 2026
da748d3
feat(store): copy a store of an older berth before converting it
helightdev Nov 15, 2026
4dee91a
Merge pull request #58 from helightdev/rework-harden
helightdev Nov 15, 2026
f246e0a
docs: upgrading from 0.5
helightdev Nov 15, 2026
5eb5ef0
test(e2e): open a store of berth 0.5.2
helightdev Nov 15, 2026
96d32b3
style: format
helightdev Nov 15, 2026
cf29662
Merge remote-tracking branch 'origin/rework' into rework-upgrade
helightdev Nov 15, 2026
794aad1
test(e2e): the lock of a store's conversion is no change to it
helightdev Nov 15, 2026
ef934c1
Merge pull request #59 from helightdev/rework-upgrade
helightdev Nov 15, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .agents/skills/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ has the instructions in Markdown.

| Skill | Use it to |
| --- | --- |
| [`install-berth`](install-berth/SKILL.md) | Install the berth client, a berth server, an Incus and Docker host, or Ubuntu on a server from a rescue system |
| [`install-berth`](install-berth/SKILL.md) | Install the berth client, a berth server, a node for Incus and Docker machines, or Ubuntu on a server from a rescue system |

`.claude/skills` is a link to this folder, so Claude Code finds the same skills.
122 changes: 64 additions & 58 deletions .agents/skills/install-berth/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: install-berth
description: "Use when installing or setting up berth. That covers the client, a berth server and an Incus and Docker host for machines. It also covers a server installed from a provider's rescue system. Covers which recipe to pick, the exact commands, what is destructive, and how to hand the server over to the user."
description: "Use when installing or setting up berth. That covers the client, a berth server and a node, a server that hosts Incus and Docker machines. It also covers a server installed from a provider's rescue system. Covers which recipe to pick, the exact commands, what is destructive, and how to hand the server over to the user."
---

# Install berth
Expand All @@ -14,8 +14,9 @@ terminal. A set-up has these pieces:
| --- | --- |
| `berth` client | The program on the user's machine. It has a terminal UI and commands. |
| berth server | Optional. `berth serve`, usually in a Docker container, reached over a tailnet with TLS. It keeps the hosts, profiles and secrets. |
| Host | A machine berth works with, at one of three levels. `reachable` means berth only logs in, `controller` adds berthd and box, and `workstation` is set up from a profile. A machine that exists is added with `berth host add NAME ADDRESS --user USER`. |
| Provisioner | Creates the machine for a host, such as on Docker or Incus. Plugins bring the types `docker/container`, `incus/vm` and `incus/container`, and berth runs each provisioner under a name of its own, registered with `berth provisioner add NAME TYPE`. The `incus-host` recipe registers `incus-vm`, `incus-container` and `docker`. `berth provisioner` lists them, and the Provisioners tab of the terminal UI (key `2`) shows each one's page. |
| Host | A machine berth logs in to over SSH. Its type is one of four: `ssh` means berth only logs in, `managed` adds berthd and box, `node` is a server berth applies without a desktop, and `workstation` is set up from a profile. A machine that exists is added with `berth host add NAME ADDRESS --user USER`. |
| Node | A server for machines. Its features `incus/server` and `docker/engine` install Incus and Docker, and after the apply berth registers their provisioners, such as `big-incus-vm`, `big-incus-container` and `big-docker-container`. |
| Provisioner | Creates the machine for a host, such as on Docker or Incus. Plugins bring the types `docker/container`, `incus/vm` and `incus/container`, and berth runs each provisioner under a name of its own, registered with `berth provisioner add NAME TYPE` or by a node. `berth provisioner list` lists them, and the Provisioners tab of the terminal UI (key `2`) shows each one's page. |

## Where to look things up

Expand All @@ -24,21 +25,23 @@ terminal. A set-up has these pieces:
| `README.md` | Installing the client |
| `docs/content/docs/(guide)/start/quick-start.mdx` | A first host from the terminal UI |
| `docs/content/docs/(guide)/use/server.mdx` | Running a server and connecting to it |
| `docs/content/docs/(guide)/use/levels.mdx` | Host levels, and adding a machine by its address |
| `docs/content/docs/(guide)/use/types.mdx` | Host types, and adding a machine by its address |
| `docs/content/docs/(guide)/use/nodes.mdx` | Nodes, which are servers for Incus and Docker machines, and taking in one that exists |
| `docs/content/docs/(guide)/use/store.mdx` | Where a server keeps its state, and restoring it |
| `docs/content/docs/(guide)/deploy/index.mdx` | The install methods |
| `docs/content/docs/(guide)/deploy/provisioners.mdx` | Creating a host's machine with a provisioner |
| `recipes/README.md` | The list of recipes |
| `recipes/*/README.md` | One recipe, with what it needs, its command and its settings |
| `plugins/incus/guide.md`, `plugins/docker/guide.md` | The provisioners and their arguments |
| `plugins/incus/guide.md`, `plugins/docker/guide.md` | The provisioners and their arguments, and the settings of the features `incus/server` and `docker/engine` |
| `AGENTS.md` | Working in this repository |

## Choosing a set-up

| The user has or wants | Follow |
| --- | --- |
| A rented dedicated server whose installer fails | `rescue-install`, then `incus-host` |
| An empty server to host many machines | `incus-host`. Add `berth_server=true` to run the server there too. |
| A rented dedicated server whose installer fails | `rescue-install`, then add it as a node |
| An empty server to host many machines | Add it as a node with the features `incus/server` and `docker/engine`. To run the server there too, `berth-server` with `berth_server_node=true` first. |
| A server the old `incus-host` recipe set up | Add it as a node with the same features. They keep its pools, bridge, trust and guests. |
| A small VM just for the server | `berth-server` |
| Only a client | The install instructions in `README.md` and the quick start |

Expand Down Expand Up @@ -69,50 +72,37 @@ Find the disks with `lsblk` first. Afterwards the user sets the server to start
from its disk in the provider's panel, restarts it and logs in over SSH. A
second run would wipe the disks again, so there is no reason to repeat it.

### `incus-host`
### A node for machines

Turns an empty Ubuntu server into a host for machines. It installs Incus with QEMU and Docker,
and sets up a btrfs storage pool, the bridge `incusbr0` and a `ufw` firewall. berth creates
its hosts there as Incus guests. It needs Ubuntu 24.04 or later, run as root on
the server, from a fresh install. It does not wipe anything.
berth applies a node itself, with no recipe. It needs Ubuntu 24.04 or later on
x86_64 and a login as root or as an account with sudo. On the user's own
machine, or on a berth connected to their server, with the made-up name `big`:

```bash
curl -fsSL https://github.com/helightdev/berth/archive/refs/heads/main.tar.gz \
| tar xz --strip-components=1 --wildcards '*/recipes'
cd recipes/incus-host
sudo ./install.sh -e tailscale_auth_key=tskey-auth-EXAMPLE
```

To run a berth server on the same machine:

```bash
sudo ./install.sh -e berth_server=true -e tailscale_auth_key=tskey-auth-EXAMPLE
berth host add big 192.0.2.20 --user root --auth ssh --type node \
--feature docker/engine --feature incus/server
berth apply big
```

To also install Sysbox, so that berth's Docker provisioner can run containers
with `runtime=sysbox` instead of privileged, add `-e sysbox=true` on the first
run. It downloads a package and checks it against a sum in `vars.yml`.

A second run changes nothing in place. It leaves a server alone that has a
storage pool, so it never touches existing guests. Settings are in `vars.yml`,
and the README lists them.

### Add the server to berth

A server from `rescue-install` and `incus-host` takes the user's public key for
`root`. On the user's own machine, with the made-up name `big`:

```bash
berth host add big 192.0.2.20 --user root --auth ssh
berth host install big
```

`host add` saves a reachable host. The default `--auth berth` uses berth's own
key, which berth installs on first contact with a password or a private key that
logs in once. `--auth ssh` uses the user's own SSH configuration and agent, and
works with a local berth only. `host install` puts the controller alone on the
server, for status, updates, a reboot and commands. Sessions then run as `root`.
Such a server is never applied as a workstation.
`--auth ssh` uses the user's own SSH configuration and agent, and works with a
local berth only. The default `--auth berth` uses berth's own key, which berth
installs on first contact with a password or a private key that logs in once.
The apply gives the SSH user berth's key and allows only keys for SSH. Root
keeps a login with keys. Its `ufw` firewall keeps these open: SSH, the
tailnet, the guests' bridge `incusbr0` and the Incus API on port 8444. berth
then registers the provisioners. Check with `berth run big status` and
`berth provisioner list`.

The features never erase a disk. They make an Incus storage pool in a folder,
or use one the user names in `devbox_incus_pool`. A server with Incus or Docker
already keeps its pools, networks, trusted clients, containers and guests, and
a provisioner registered for it by hand becomes the node's when it names the
node's address. The apply names any it left alone, with the command that makes
it the node's: `berth provisioner run NAME adopt node=big`.

Virtual machines need KVM. On a rented virtual server without it, set
`devbox_incus_virtual_machines` to `false` in `ansible_vars`. For Sysbox beside
Docker, set `devbox_docker_sysbox` to `true` on the first apply.

### `berth-server`

Expand All @@ -123,27 +113,43 @@ port 7777 on this machine only, Tailscale, `tailscale serve` with TLS and a

```bash
curl -fsSL https://github.com/helightdev/berth/archive/refs/heads/main.tar.gz \
| tar xz --strip-components=1 --wildcards '*/recipes'
| tar xz --strip-components=1 --wildcards '*/recipes' \
'*/provision/ansible/roles/devbox/files/berth-server-upgrade.py'
cd recipes/berth-server
sudo ./install.sh -e tailscale_auth_key=tskey-auth-EXAMPLE
```

A second run changes nothing in place. It leaves the container `berth` as it
is and starts it when it was stopped. To update, run `sudo docker pull
ghcr.io/helightdev/berth`, `sudo docker rm -f berth`, then `sudo ./install.sh`.
The data in `/srv/berth` stays.
To let the server apply its own machine as a node, add
`-e berth_server_node=true`. The server's own key then logs in to it as
`root`. The container finds the machine at the name `node` and has the Docker
socket. Add the
node from the server with `berth host add big node --user root --type node`,
then as in the node's section above.

A second run changes nothing in place. The container `berth` keeps its image,
data and options. A stopped one is started. To update the
server, fetch the recipe of the new version and run
`sudo ./install.sh -e berth_server_update=true`. It makes the container again
from the new image with the options of the old one, and starts the old one
again if the new one fails. On a node, the node's action `upgrade-server` does
the same. Never update with `docker rm -f berth`: a new container loses the
options passed by hand, such as the name `incus-host` the provisioners of
berth 0.5 reach. A server of berth 0.5 is updated before its clients and hosts:
the page Upgrading from 0.5 in the docs has the order.

## Things that go wrong

| Symptom or risk | What to do |
| --- | --- |
| The tailnet address does not work | HTTPS certificates must be on for the tailnet. Or set `berth_server_tailscale_serve` to `false` to keep the server on the machine only. |
| The image does not pull | A private image needs `sudo docker login ghcr.io` before the run. |
| Virtual machines fail on a rented virtual server | They need KVM. Set `incus_virtual_machines` to `false` and use containers. |
| The bridge clashes with the server's network | Change `incus_bridge_address` if `10.77.0.0/24` is taken. |
| Locked out of SSH | With `ssh_from` set to one address, SSH from anywhere else is refused. The provider's console is the way back in. |
| Virtual machines fail on a rented virtual server | They need KVM. Set `devbox_incus_virtual_machines` to `false` and use containers. |
| The bridge clashes with the server's network | Change `devbox_incus_bridge_address` if `10.77.0.0/24` is taken. |
| Locked out of SSH | With `ssh_from` in `berth-server`, or `devbox_ssh_from` on a node, set to one address, SSH from anywhere else is refused. The provider's console is the way back in. |
| A storage pool on its own disk | The features never erase a disk. Create it with `incus storage create` and name it in `devbox_incus_pool`. |
| Docker ports are open to the world | Docker publishes past `ufw`. Publish on `127.0.0.1` or the tailnet address. |
| The enrollment key leaks | Pass `tailscale_auth_key` on the command line. Never save it in a file you commit. |
| Hosts berth sets up do not join the tailnet | berth makes their keys itself, with the secret `tailnet_api_key`: a Tailscale OAuth client as `CLIENT_ID:CLIENT_SECRET`, a Tailscale API access token or a Headscale API key. Ask the user to set it with `berth secret set tailnet_api_key`. Only the recipes' own machine takes a key by hand, because the recipe runs before berth does. |
| A rescue install refuses to run | It refuses a system that did not start with UEFI, and a disk the running system is on. |

## Hand the server over to the user
Expand All @@ -154,16 +160,16 @@ The server starts with a setup key. On the server machine this prints a
one-time key that is valid for 24 hours:

```bash
sudo docker exec berth berth setup-key
sudo docker exec berth berth server setup-key
```

The recipes make a key on the first run and print it at the end. Give the
user the key and the address, which `tailscale serve status` shows:

1. On their own machine they run `berth connect https://THIS-MACHINE.YOUR-TAILNET.ts.net` and enter the key.
2. Or they open `https://THIS-MACHINE.YOUR-TAILNET.ts.net/#setup-key=KEY` in a browser.
1. On their own machine they run `berth login https://THIS-MACHINE.YOUR-TAILNET.ts.net` and enter the key. It works on Windows and macOS too.
2. Then `berth ui` opens the screens, and the other commands use that server.

The key ends when they choose Done, or when `berth connect` has saved the token.
The key ends when they choose Done, or when `berth login` has saved the token.

**Return the setup key and the address to the user. Never read, store or print
the permanent token in `serve.token`.**
Expand Down
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,9 @@ A pull request is ready when:
vale --minAlertLevel=warning "docs/content/docs/(guide)" README.md AGENTS.md
```

- The terminal client and the page in a browser do the same things. A feature
added to one is added to the other, with the shared part in
`crates/berth-tui`.
- The screens do everything through the API of a server, whichever it is. A
feature of theirs is an operation or an action of the server first, and
then their part in `crates/berth-page` and `crates/berth-tui`.
- Commits follow [Conventional Commits](https://www.conventionalcommits.org/),
with a short subject that says what changed.
- The pull request links its issue and stays within it. Leave unrelated
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ Issue: #
- [ ] `ci/run.sh all` passes
- [ ] Tried on a real host as well as in the containers (say which kind above)
- [ ] Documentation is updated and Vale doesn't report warnings
- [ ] The terminal client and the page in a browser both have it, where it applies
- [ ] The screens do it through the API, and the client build for macOS and Windows still checks
- [ ] I read every line of this change myself
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ jobs:
key: e2e-${{ hashFiles('Cargo.lock', 'ci/dev.Dockerfile') }}-${{ github.sha }}
restore-keys: e2e-${{ hashFiles('Cargo.lock', 'ci/dev.Dockerfile') }}-
- name: Build berth
run: ci/run.sh run cargo build --locked -p berth --features web
run: ci/run.sh run cargo build --locked -p berth
# berth, and the berthd and box it puts into the role's files. A tar
# keeps their modes, which an artifact does not.
- name: Pack what the shards test
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,10 @@ jobs:
- uses: actions/setup-node@v4
with:
node-version: 24
# The site has the page of berth serve under /web, which building berth makes.
- uses: dtolnay/rust-toolchain@stable
with:
targets: x86_64-unknown-linux-musl, wasm32-unknown-unknown
- uses: Swatinem/rust-cache@v2
- run: npm install --no-audit --no-fund && npm run build
working-directory: docs
env:
DOCS_BASE_PATH: ${{ steps.pages.outputs.base_path }}
- run: test -f docs/out/web/berth-web_bg.wasm
- uses: actions/upload-pages-artifact@v5
with:
path: docs/out
Expand Down
Loading
Loading