Compare commits
34 commits
feat/logo-
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 0996262fee | |||
| c00a01e940 | |||
| cdc0c3c6fd | |||
| 7053ef290c | |||
| 24beffeaf4 | |||
| 5830f8887a | |||
| 9076b85304 | |||
| 2f6c31a26e | |||
| 2f7a02f1d1 | |||
| d9a10f76ea | |||
| e251eb831a | |||
| 0490f49f85 | |||
| f95bfcb56b | |||
| 91aa33b891 | |||
| 0cad2e05c8 | |||
| ff5fe6f1c6 | |||
| 2468cb3ded | |||
| 455150f97f | |||
| bfa7ee8cba | |||
| 4c5bfe3aef | |||
| b7b66fe136 | |||
| 7151d411c7 | |||
| 9f9e627678 | |||
| 22c2245ac4 | |||
| 20f6398abf | |||
| 8bcbaec621 | |||
| 87dcb369db | |||
| 905845187d | |||
| 30ee044657 | |||
| f88412d9e8 | |||
| 91f2d6304c | |||
| e88b57f74d | |||
| 557d410eca | |||
| 43bcf3c4e5 |
|
|
@ -57,3 +57,13 @@ jobs:
|
||||||
env:
|
env:
|
||||||
FORGEJO_TOKEN: ${{ secrets.FORGEJO_RELEASE_TOKEN }}
|
FORGEJO_TOKEN: ${{ secrets.FORGEJO_RELEASE_TOKEN }}
|
||||||
run: ./scripts/publish-release.sh "${GITHUB_REF_NAME}"
|
run: ./scripts/publish-release.sh "${GITHUB_REF_NAME}"
|
||||||
|
|
||||||
|
- name: Refresh furtka.org download page
|
||||||
|
# The download page reads the latest release (ISO, size, date,
|
||||||
|
# checksum) from the Forgejo API at build time, so rebuild the site
|
||||||
|
# now that the release exists. Same runner + bind mounts as
|
||||||
|
# deploy-site.yml. A failure here doesn't touch the release.
|
||||||
|
continue-on-error: true
|
||||||
|
run: |
|
||||||
|
apk add --no-cache hugo rsync
|
||||||
|
./website/deploy-ci.sh
|
||||||
|
|
|
||||||
89
CHANGELOG.md
|
|
@ -7,8 +7,80 @@ This project uses calendar versioning: `YY.N-stage` (e.g. `26.0-alpha` = 2026, r
|
||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [26.21-alpha] - 2026-10-23
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **Furtka Gateway: apps reachable from the internet** (behind NAT/CGNAT,
|
||||||
|
no port forwarding). Settings → *Furtka Gateway*: enter the gateway URL
|
||||||
|
and registration token, the box registers and keeps a WireGuard tunnel to
|
||||||
|
a [furtka-gateway](https://forgejo.sourcegate.online/robert/furtka-gateway)
|
||||||
|
server (Traefik + wg-easy + control plane). Apps → ⋯ → *Expose to
|
||||||
|
Internet* publishes an app under its own hostname with Let's Encrypt;
|
||||||
|
*Stop exposing* takes it down again. Only apps whose manifest declares
|
||||||
|
`internet.viable: true` can be exposed. Client in `furtka/gateway.py` +
|
||||||
|
`furtka/wireguard.py`, CLI `furtka gateway …`.
|
||||||
|
- **New logo: Mark M** (a lowercase *f* cut out of an arched gate), winner of
|
||||||
|
the furtka.org vote (29 of 42 votes). It is now in the website header,
|
||||||
|
favicon and share card, the installer header and tab icon, the on-box UI
|
||||||
|
(every page and the login), the console welcome screens of the live ISO
|
||||||
|
and the installed box, and the BIOS boot-menu splash. Brand files in
|
||||||
|
`docs/brand/`, generated by `website/tools/brand-assets.py`.
|
||||||
|
- **furtka.org/download/** (and `/de/download/`): ISO download with size,
|
||||||
|
date and checksum, requirements and step-by-step install guide. Releases
|
||||||
|
now publish `furtka-<ver>.iso.sha256` and refresh the site.
|
||||||
|
|
||||||
|
### Security
|
||||||
|
|
||||||
|
- **App names are validated everywhere.** `POST /api/apps/remove` with
|
||||||
|
`{"name": ".."}` or `"/"` sent `shutil.rmtree` at `/var/lib/furtka` or the
|
||||||
|
root filesystem (and wiping `users.json` reopened first-run admin setup to
|
||||||
|
the LAN). Names from URLs, JSON bodies and manifests must now match
|
||||||
|
`^[a-z][a-z0-9_-]*$`; `installer.remove`/`update_env` check it too.
|
||||||
|
- **Settings can't inject into `.env`.** Line breaks are refused; values
|
||||||
|
with `$` are single-quoted so compose doesn't expand them (`pa$word` used
|
||||||
|
to become `pa`). Validation runs before the write, so a rejected `/etc`
|
||||||
|
path is no longer saved anyway.
|
||||||
|
- **Damaged `users.json` fails closed.** An empty/corrupt file used to read
|
||||||
|
as "no admin yet" and turned `/login` into an open create-admin form.
|
||||||
|
`/login` now answers 503 with SSH recovery steps; `save_users` fsyncs.
|
||||||
|
- **API server hardening:** threaded (state changes still serialised), 1 MiB
|
||||||
|
body cap, 30 s socket timeout, cross-site POSTs refused via
|
||||||
|
`Sec-Fetch-Site`, JSON 500 instead of dropped connections.
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
|
- **Installer disk picker:** SATA SSDs were labelled "HDD" and lost the
|
||||||
|
recommendation to bigger spinning disks; type now comes from lsblk
|
||||||
|
`TRAN`/`ROTA`. zram, eMMC boot/RPMB areas, read-only and 0-byte disks are
|
||||||
|
hidden; disks under 16 GB are greyed out; USB disks rank last; >2 TB disks
|
||||||
|
on BIOS machines get an MBR warning; the boot stick is also found via the
|
||||||
|
archiso kernel args when `bootmnt` is gone. Step 2 only accepts a listed disk.
|
||||||
|
- **Installer runs one install at a time** (double-click / second browser
|
||||||
|
started a second archinstall on the same disk), and a crashed archinstall
|
||||||
|
(OOM kill, signal) now shows as an error instead of a progress bar stuck
|
||||||
|
forever. Disk-probe exceptions land in the log instead of a bare 500.
|
||||||
|
- **Failed installs can be retried** from the error page without re-entering
|
||||||
|
everything.
|
||||||
|
- **No 2-minute boot stall on boards with a second NIC:** the target gets a
|
||||||
|
`systemd-networkd-wait-online --any` drop-in.
|
||||||
|
- **Self-update:** symlink flip is atomic; any error after the flip rolls
|
||||||
|
back (and restores the previous Caddyfile); health check survives read
|
||||||
|
timeouts; every failure ends in an `error` stage the settings page shows.
|
||||||
|
- **Interrupted app installs no longer block all later installs** — a stale
|
||||||
|
state with no live runner is marked failed after 60 s.
|
||||||
|
- **Catalog sync / update checks** no longer strand on socket resets or disk
|
||||||
|
full.
|
||||||
|
- **Apps page after an API restart** redirects to `/login` instead of
|
||||||
|
showing an empty app list.
|
||||||
|
- **32-bit UEFI machines** (Atom Bay Trail / Cherry Trail) get Limine
|
||||||
|
instead of systemd-boot: Arch has no ia32 systemd-boot and archinstall's
|
||||||
|
GRUB path hardcodes `x86_64-efi`, so these boxes installed but didn't boot.
|
||||||
|
- **Force-HTTPS redirect** only covers `<hostname>.local` / `<hostname>` and
|
||||||
|
is a 302. The old 301 for every host sent devices that use the IP to a
|
||||||
|
TLS handshake that can't succeed, and stayed cached after HTTPS was
|
||||||
|
turned off. Self-update migrates the old snippet.
|
||||||
|
|
||||||
- **Self-update starts newly added timers immediately and links units
|
- **Self-update starts newly added timers immediately and links units
|
||||||
through `current`.** `_link_new_units()` enabled a timer a release
|
through `current`.** `_link_new_units()` enabled a timer a release
|
||||||
introduced but never started it, so after the 26.19 → 26.20 update the
|
introduced but never started it, so after the 26.19 → 26.20 update the
|
||||||
|
|
@ -19,6 +91,20 @@ This project uses calendar versioning: `YY.N-stage` (e.g. `26.0-alpha` = 2026, r
|
||||||
(installer-created links use `current`). Now: link via `current`, enable,
|
(installer-created links use `current`). Now: link via `current`, enable,
|
||||||
start.
|
start.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Wizard wording: "Server name" with a live `http://<name>.local` preview,
|
||||||
|
"Pick a disk" with an explicit erase warning, readable confirm table,
|
||||||
|
password hint explains it's also the SSH/console password, names are
|
||||||
|
lowercased instead of rejected, system account names are refused.
|
||||||
|
- Live console banner says a network cable with internet is required.
|
||||||
|
- ISO builds pin archinstall (4.4-1, sha256-checked from the Arch archive)
|
||||||
|
instead of taking whatever the repos ship that day; the build fails
|
||||||
|
clearly when Arch's Python moves on. Bump steps in `iso/README.md`.
|
||||||
|
- On-box UI polish: sticky top nav, bordered cards and status tiles, app
|
||||||
|
tile hover lift, brand-red section markers; animations respect
|
||||||
|
`prefers-reduced-motion`.
|
||||||
|
|
||||||
## [26.20-alpha] - 2026-08-25
|
## [26.20-alpha] - 2026-08-25
|
||||||
|
|
||||||
First release shaped by a real-hardware install (old laptop mainboard, BIOS boot,
|
First release shaped by a real-hardware install (old laptop mainboard, BIOS boot,
|
||||||
|
|
@ -573,7 +659,8 @@ First tagged snapshot. Pre-alpha — the installer does not yet boot, but the de
|
||||||
- **Containers:** Docker + Compose
|
- **Containers:** Docker + Compose
|
||||||
- **License:** AGPL-3.0
|
- **License:** AGPL-3.0
|
||||||
|
|
||||||
[Unreleased]: https://forgejo.sourcegate.online/daniel/furtka/compare/26.20-alpha...HEAD
|
[Unreleased]: https://forgejo.sourcegate.online/daniel/furtka/compare/26.21-alpha...HEAD
|
||||||
|
[26.21-alpha]: https://forgejo.sourcegate.online/daniel/furtka/releases/tag/26.21-alpha
|
||||||
[26.20-alpha]: https://forgejo.sourcegate.online/daniel/furtka/releases/tag/26.20-alpha
|
[26.20-alpha]: https://forgejo.sourcegate.online/daniel/furtka/releases/tag/26.20-alpha
|
||||||
[26.19-alpha]: https://forgejo.sourcegate.online/daniel/furtka/releases/tag/26.19-alpha
|
[26.19-alpha]: https://forgejo.sourcegate.online/daniel/furtka/releases/tag/26.19-alpha
|
||||||
[26.18-alpha]: https://forgejo.sourcegate.online/daniel/furtka/releases/tag/26.18-alpha
|
[26.18-alpha]: https://forgejo.sourcegate.online/daniel/furtka/releases/tag/26.18-alpha
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,5 @@
|
||||||
|
<p><img src="docs/brand/furtka-lockup.svg" alt="Furtka" height="56"></p>
|
||||||
|
|
||||||
# Furtka
|
# Furtka
|
||||||
|
|
||||||
**Open-source home server OS — simple enough for everyone.** · [furtka.org](https://furtka.org)
|
**Open-source home server OS — simple enough for everyone.** · [furtka.org](https://furtka.org)
|
||||||
|
|
@ -54,7 +56,7 @@ Furtka aims to be:
|
||||||
| Identity provider | Authentik | Bundled SSO from day one — every app template auto-wires to it at install |
|
| Identity provider | Authentik | Bundled SSO from day one — every app template auto-wires to it at install |
|
||||||
| Managed gateway DNS | NS delegation to `ns1.furtka.org` | User delegates once at registrar; we handle wildcard cert + subdomain creation |
|
| Managed gateway DNS | NS delegation to `ns1.furtka.org` | User delegates once at registrar; we handle wildcard cert + subdomain creation |
|
||||||
| Local HTTPS | Local CA | One-click CA install → green padlock on every service, no browser warnings |
|
| Local HTTPS | Local CA | One-click CA install → green padlock on every service, no browser warnings |
|
||||||
| Gateway | Flexible | Own reverse proxy OR managed through our infrastructure |
|
| Gateway | Traefik + wg-easy ([furtka-gateway](https://forgejo.sourcegate.online/robert/furtka-gateway)) | Decided 2026-10-23. Self-hosted on any VPS with a public IPv4 via `deploy.sh`, or managed through our infrastructure later. Boxes dial out over WireGuard, so no port forwarding at home. |
|
||||||
| UI approach | UI-first | Design the simplest possible UI, then build everything to match |
|
| UI approach | UI-first | Design the simplest possible UI, then build everything to match |
|
||||||
|
|
||||||
## Landscape (Existing Projects)
|
## Landscape (Existing Projects)
|
||||||
|
|
@ -120,10 +122,13 @@ None of these nail the "your dad can set this up" experience. The installer wiza
|
||||||
- [x] **Phase 2 Furtka self-update** — `/settings` → Check → Update now. Downloads signed tarball (SHA256), stages, atomic symlink flip, reloads Caddy, daemon-reload, restarts services, health-checks the new api with auto-rollback on failure. CLI: `furtka update [--check]` + `furtka rollback`. Validated end-to-end on VM 2026-04-16 (`26.0-alpha` → `26.3-alpha` → rollback → reboot).
|
- [x] **Phase 2 Furtka self-update** — `/settings` → Check → Update now. Downloads signed tarball (SHA256), stages, atomic symlink flip, reloads Caddy, daemon-reload, restarts services, health-checks the new api with auto-rollback on failure. CLI: `furtka update [--check]` + `furtka rollback`. Validated end-to-end on VM 2026-04-16 (`26.0-alpha` → `26.3-alpha` → rollback → reboot).
|
||||||
- [x] **Local HTTPS Phase 1** — Caddy `tls internal` on `:443` is fully opt-in via the `/settings` toggle (26.15-alpha); fresh installs stay HTTP-only so a half-trusted cert chain can't lock the user out. Per-box root CA generated on first enable, `rootCA.crt` downloadable from `/settings`, per-OS install guide at `/https-install/`. The "force HTTPS" sub-toggle still only appears once the current browser already trusts the cert.
|
- [x] **Local HTTPS Phase 1** — Caddy `tls internal` on `:443` is fully opt-in via the `/settings` toggle (26.15-alpha); fresh installs stay HTTP-only so a half-trusted cert chain can't lock the user out. Per-box root CA generated on first enable, `rootCA.crt` downloadable from `/settings`, per-OS install guide at `/https-install/`. The "force HTTPS" sub-toggle still only appears once the current browser already trusts the cert.
|
||||||
- [x] **Post-build smoke VM on Proxmox** — `.forgejo/workflows/build-iso.yml` hands the freshly built ISO to `scripts/smoke-vm.sh`, which boots it in a throwaway VM on `pollux` (192.168.178.165) and curls the webinstaller on `:5000`. VMID range 9000–9099, last 5 kept. Green end-to-end since 26.4-alpha.
|
- [x] **Post-build smoke VM on Proxmox** — `.forgejo/workflows/build-iso.yml` hands the freshly built ISO to `scripts/smoke-vm.sh`, which boots it in a throwaway VM on `pollux` (192.168.178.165) and curls the webinstaller on `:5000`. VMID range 9000–9099, last 5 kept. Green end-to-end since 26.4-alpha.
|
||||||
|
- [x] **Furtka Gateway (Access Gate)** — boxes behind NAT/CGNAT register with a [furtka-gateway](https://forgejo.sourcegate.online/robert/furtka-gateway) server (Traefik + wg-easy + control plane) over a WireGuard tunnel; Settings → *Furtka Gateway* connects, Apps → ⋯ → *Expose to Internet* publishes an app under its own hostname with Let's Encrypt. Only apps with `internet.viable: true` in the manifest can be exposed. Shipped in `26.21-alpha`; first gateway running at `gw.furtka.org` (Hetzner, 2026-10-23).
|
||||||
|
- [x] **`26.21-alpha`** — security fixes (app-name validation, `.env` injection, fail-closed `users.json`, API hardening), installer fixes, Mark M logo, furtka.org/download, on-box UI polish. See [CHANGELOG](CHANGELOG.md).
|
||||||
|
- [ ] Gateway dogfooding on real hardware — two old laptops as boxes, one per brother, both behind CGNAT
|
||||||
- [ ] Installer wizard screens S3–S7 — per-device purpose, network, domain, SSL, diagnostic. S5/S6 blocked on managed-gateway DNS infra not yet built.
|
- [ ] Installer wizard screens S3–S7 — per-device purpose, network, domain, SSL, diagnostic. S5/S6 blocked on managed-gateway DNS infra not yet built.
|
||||||
- [ ] Local HTTPS Phase 2 — dedicated local CA (not Caddy's `tls internal`), streamlined one-click install across Win/Mac/Linux/Android, and HTTPS on the live-installer wizard (`https://proksi.local:5000`).
|
- [ ] Local HTTPS Phase 2 — dedicated local CA (not Caddy's `tls internal`), streamlined one-click install across Win/Mac/Linux/Android, and HTTPS on the live-installer wizard (`https://proksi.local:5000`).
|
||||||
- [ ] Caddy + Authentik wired into first-boot bootstrap
|
- [ ] Caddy + Authentik wired into first-boot bootstrap
|
||||||
- [ ] Managed gateway infrastructure — `ns1/ns2.furtka.org` + DNS-01 wildcard automation
|
- [ ] Managed gateway DNS — `ns1/ns2.furtka.org` + DNS-01 wildcard automation (the gateway itself works today with your own domain and per-app or wildcard A records)
|
||||||
- [ ] First containerized service (Nextcloud?) with auto-SSO + auto-subdomain
|
- [ ] First containerized service (Nextcloud?) with auto-SSO + auto-subdomain
|
||||||
- [ ] Competitor hands-on testing on Proxmox — validate findings from docs/competitors.md
|
- [ ] Competitor hands-on testing on Proxmox — validate findings from docs/competitors.md
|
||||||
- [ ] UI mockups / drafts (Robert)
|
- [ ] UI mockups / drafts (Robert)
|
||||||
|
|
|
||||||
|
|
@ -45,7 +45,7 @@ Tag per meaningful milestone, not on a calendar. A milestone is: ISO boots, a wi
|
||||||
git push origin 26.1-alpha
|
git push origin 26.1-alpha
|
||||||
```
|
```
|
||||||
|
|
||||||
5. **The release workflow does the rest.** `.forgejo/workflows/release.yml` fires on the tag push and runs on the self-hosted runner: `scripts/build-release-tarball.sh` builds the self-update payload (tarball + sha256 + release.json under `dist/`), `iso/build.sh` builds the live-installer ISO, `scripts/publish-release.sh` uploads tarball + sha256 + release.json + ISO to the Forgejo release page. Pre-release is flagged automatically based on the suffix (`-alpha`/`-beta`/`-rc`). ISO build is `continue-on-error`: a flaky ISO step doesn't block the core tarball (the thing boxes need for self-update).
|
5. **The release workflow does the rest.** `.forgejo/workflows/release.yml` fires on the tag push and runs on the self-hosted runner: `scripts/build-release-tarball.sh` builds the self-update payload (tarball + sha256 + release.json under `dist/`), `iso/build.sh` builds the live-installer ISO, `scripts/publish-release.sh` uploads tarball + sha256 + release.json + ISO to the Forgejo release page. Pre-release is flagged automatically based on the suffix (`-alpha`/`-beta`/`-rc`). The ISO gets a `furtka-<ver>.iso.sha256` sidecar, and a last step rebuilds furtka.org so the download page (`/download/`) picks up the new ISO, size, date and checksum from the Forgejo API. ISO build is `continue-on-error`: a flaky ISO step doesn't block the core tarball (the thing boxes need for self-update).
|
||||||
|
|
||||||
The release workflow needs one secret set at repo **Settings → Secrets → Actions**:
|
The release workflow needs one secret set at repo **Settings → Secrets → Actions**:
|
||||||
- `FORGEJO_RELEASE_TOKEN` — a PAT with `write:repository` scope.
|
- `FORGEJO_RELEASE_TOKEN` — a PAT with `write:repository` scope.
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,8 @@
|
||||||
"git",
|
"git",
|
||||||
"htop",
|
"htop",
|
||||||
"curl",
|
"curl",
|
||||||
"openssh"
|
"openssh",
|
||||||
|
"wireguard-tools"
|
||||||
],
|
],
|
||||||
|
|
||||||
"profile": {
|
"profile": {
|
||||||
|
|
|
||||||
|
|
@ -13,6 +13,17 @@ hostname=$(cat /etc/hostname 2>/dev/null || hostname)
|
||||||
mapfile -t ips < <(ip -4 -o addr show scope global 2>/dev/null | awk '{print $4}' | cut -d/ -f1)
|
mapfile -t ips < <(ip -4 -o addr show scope global 2>/dev/null | awk '{print $4}' | cut -d/ -f1)
|
||||||
|
|
||||||
new=$(
|
new=$(
|
||||||
|
# Furtka mark (docs/brand/console-banner.txt, from brand-assets.py)
|
||||||
|
echo ' ▄▄▄▄▄▄▄▄'
|
||||||
|
echo ' ▄██████████▄'
|
||||||
|
echo ' █████▀▀▀▀▀▀███'
|
||||||
|
echo ' ████▀ ████'
|
||||||
|
echo ' ████ █████████'
|
||||||
|
echo ' ████ ████'
|
||||||
|
echo ' ████ ▄▄▄▄▄████'
|
||||||
|
echo ' ████ █████████'
|
||||||
|
echo ' ████ █████████'
|
||||||
|
echo ' ▀▀▀▀ ▀▀▀▀▀▀▀▀▀'
|
||||||
echo
|
echo
|
||||||
echo " Furtka is ready."
|
echo " Furtka is ready."
|
||||||
echo
|
echo
|
||||||
|
|
|
||||||
1
assets/www/favicon.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><style>svg{color:#c03a28}@media (prefers-color-scheme:dark){svg{color:#ff6b56}}</style><path fill="currentColor" fill-rule="evenodd" d="M5 60V27a27 27 0 0 1 54 0v33Z M19.5 60V26A10 10 0 0 1 29.5 16H46v10H32a2.5 2.5 0 0 0-2.5 2.5V32H46v10H29.5v18Z"/></svg>
|
||||||
|
After Width: | Height: | Size: 316 B |
|
|
@ -2,6 +2,7 @@
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
|
<link rel="icon" type="image/svg+xml" href="/favicon.svg">
|
||||||
<title>Install local HTTPS · Furtka</title>
|
<title>Install local HTTPS · Furtka</title>
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
<link rel="stylesheet" href="/style.css">
|
<link rel="stylesheet" href="/style.css">
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
|
<link rel="icon" type="image/svg+xml" href="/favicon.svg">
|
||||||
<title>Furtka</title>
|
<title>Furtka</title>
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
<link rel="stylesheet" href="/style.css">
|
<link rel="stylesheet" href="/style.css">
|
||||||
|
|
@ -68,6 +69,15 @@
|
||||||
</main>
|
</main>
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
|
// Sessions live in API memory, so every restart or self-update logs
|
||||||
|
// everyone out. Send the browser to the login page instead of rendering
|
||||||
|
// the 401 body as if the box had no apps.
|
||||||
|
const _fetch = window.fetch.bind(window);
|
||||||
|
window.fetch = async (...args) => {
|
||||||
|
const r = await _fetch(...args);
|
||||||
|
if (r.status === 401) { location.href = '/login'; }
|
||||||
|
return r;
|
||||||
|
};
|
||||||
// Revoke the cookie server-side and bounce to /login. Shared
|
// Revoke the cookie server-side and bounce to /login. Shared
|
||||||
// shape with the _HTML in furtka/api.py so the two logout
|
// shape with the _HTML in furtka/api.py so the two logout
|
||||||
// links behave identically.
|
// links behave identically.
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
|
<link rel="icon" type="image/svg+xml" href="/favicon.svg">
|
||||||
<title>Settings · Furtka</title>
|
<title>Settings · Furtka</title>
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
<link rel="stylesheet" href="/style.css">
|
<link rel="stylesheet" href="/style.css">
|
||||||
|
|
@ -80,6 +81,45 @@
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<h2>Furtka Gateway</h2>
|
||||||
|
<div class="card">
|
||||||
|
<p class="lede">
|
||||||
|
Connect this box to a furtka-gateway to expose individual apps to the
|
||||||
|
internet over a WireGuard tunnel. Apps stay private until you explicitly
|
||||||
|
publish one from the <a href="/apps">Apps</a> page — connecting here only
|
||||||
|
opens the tunnel, nothing is exposed automatically.
|
||||||
|
</p>
|
||||||
|
<div id="gateway-disconnected" hidden>
|
||||||
|
<div class="field">
|
||||||
|
<label for="gw-url">Gateway URL</label>
|
||||||
|
<input type="text" id="gw-url" placeholder="https://gw.example.com">
|
||||||
|
</div>
|
||||||
|
<div class="field">
|
||||||
|
<label for="gw-token">Registration token</label>
|
||||||
|
<input type="password" id="gw-token" placeholder="from the gateway operator">
|
||||||
|
</div>
|
||||||
|
<div class="field">
|
||||||
|
<label for="gw-name">Box name</label>
|
||||||
|
<input type="text" id="gw-name" placeholder="my-box">
|
||||||
|
</div>
|
||||||
|
<div class="update-actions">
|
||||||
|
<button id="gateway-connect-btn">Connect</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="gateway-connected" hidden>
|
||||||
|
<dl class="kv">
|
||||||
|
<dt>Gateway</dt><dd id="gw-connected-url">—</dd>
|
||||||
|
<dt>Tunnel</dt><dd id="gw-tunnel-status">—</dd>
|
||||||
|
</dl>
|
||||||
|
<div class="update-actions">
|
||||||
|
<button class="danger" id="gateway-disconnect-btn">Disconnect</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<p id="gateway-status" class="hint"></p>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
<section>
|
<section>
|
||||||
<h2>Appearance</h2>
|
<h2>Appearance</h2>
|
||||||
<div class="card">
|
<div class="card">
|
||||||
|
|
@ -112,7 +152,6 @@
|
||||||
<a href="https://furtka.org/#planned">Change hostname</a>
|
<a href="https://furtka.org/#planned">Change hostname</a>
|
||||||
<a href="https://furtka.org/#planned">Backup</a>
|
<a href="https://furtka.org/#planned">Backup</a>
|
||||||
<a href="https://furtka.org/#planned">User accounts</a>
|
<a href="https://furtka.org/#planned">User accounts</a>
|
||||||
<a href="https://furtka.org/#planned">Remote access</a>
|
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|
@ -122,6 +161,15 @@
|
||||||
</main>
|
</main>
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
|
// Sessions live in API memory, so every restart or self-update logs
|
||||||
|
// everyone out. Send the browser to the login page instead of rendering
|
||||||
|
// the 401 body as if the box had no apps.
|
||||||
|
const _fetch = window.fetch.bind(window);
|
||||||
|
window.fetch = async (...args) => {
|
||||||
|
const r = await _fetch(...args);
|
||||||
|
if (r.status === 401) { location.href = '/login'; }
|
||||||
|
return r;
|
||||||
|
};
|
||||||
// Logout button in the nav — same shape as /apps and / pages.
|
// Logout button in the nav — same shape as /apps and / pages.
|
||||||
async function doLogout(ev) {
|
async function doLogout(ev) {
|
||||||
ev.preventDefault();
|
ev.preventDefault();
|
||||||
|
|
@ -162,6 +210,7 @@
|
||||||
done: 'Update complete — reloading…',
|
done: 'Update complete — reloading…',
|
||||||
rolled_back: 'Update failed, rolled back to the previous version',
|
rolled_back: 'Update failed, rolled back to the previous version',
|
||||||
rolled_back_manual: 'Rolled back manually',
|
rolled_back_manual: 'Rolled back manually',
|
||||||
|
error: 'Update failed — nothing was changed',
|
||||||
};
|
};
|
||||||
|
|
||||||
let pollHandle = null;
|
let pollHandle = null;
|
||||||
|
|
@ -339,18 +388,140 @@
|
||||||
await refreshHttpsStatus();
|
await refreshHttpsStatus();
|
||||||
})();
|
})();
|
||||||
|
|
||||||
|
// --- Furtka Gateway -------------------------------------------------
|
||||||
|
|
||||||
|
const CONNECT_STAGE_LABELS = {
|
||||||
|
registering: 'Registering with the gateway…',
|
||||||
|
starting_tunnel: 'Starting the WireGuard tunnel…',
|
||||||
|
done: 'Connected.',
|
||||||
|
};
|
||||||
|
|
||||||
|
const gatewayDisconnectedEl = document.getElementById('gateway-disconnected');
|
||||||
|
const gatewayConnectedEl = document.getElementById('gateway-connected');
|
||||||
|
const gwConnectedUrlEl = document.getElementById('gw-connected-url');
|
||||||
|
const gwTunnelStatusEl = document.getElementById('gw-tunnel-status');
|
||||||
|
const gatewayStatusEl = document.getElementById('gateway-status');
|
||||||
|
const gatewayConnectBtn = document.getElementById('gateway-connect-btn');
|
||||||
|
const gatewayDisconnectBtn = document.getElementById('gateway-disconnect-btn');
|
||||||
|
let gatewayPollHandle = null;
|
||||||
|
|
||||||
|
function setGatewayStatus(msg, isError = false) {
|
||||||
|
gatewayStatusEl.textContent = msg;
|
||||||
|
gatewayStatusEl.style.color = isError ? 'var(--danger)' : 'var(--muted)';
|
||||||
|
}
|
||||||
|
|
||||||
|
function describeTunnel(tunnel) {
|
||||||
|
if (!tunnel || !tunnel.configured) return 'not configured';
|
||||||
|
return tunnel.latest_handshake ? `up (last handshake ${tunnel.latest_handshake})` : 'configured, no handshake yet';
|
||||||
|
}
|
||||||
|
|
||||||
|
async function refreshGatewayStatus() {
|
||||||
|
try {
|
||||||
|
const r = await fetch('/api/gateway/status', { cache: 'no-store' });
|
||||||
|
// Sessions are in-memory, so a furtka-api restart logs us
|
||||||
|
// out. Both panels start hidden — never claim "not
|
||||||
|
// connected" when we simply couldn't ask.
|
||||||
|
if (r.status === 401) {
|
||||||
|
window.location.href = '/login';
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (!r.ok) return;
|
||||||
|
const s = await r.json();
|
||||||
|
gatewayDisconnectedEl.hidden = !!s.connected;
|
||||||
|
gatewayConnectedEl.hidden = !s.connected;
|
||||||
|
if (s.connected) {
|
||||||
|
gwConnectedUrlEl.textContent = s.gateway_url;
|
||||||
|
gwTunnelStatusEl.textContent = describeTunnel(s.tunnel);
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
/* next refresh will retry */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
refreshGatewayStatus();
|
||||||
|
|
||||||
|
gatewayConnectBtn.addEventListener('click', async () => {
|
||||||
|
const gateway_url = document.getElementById('gw-url').value.trim();
|
||||||
|
const registration_token = document.getElementById('gw-token').value;
|
||||||
|
const box_name = document.getElementById('gw-name').value.trim();
|
||||||
|
if (!gateway_url || !registration_token || !box_name) {
|
||||||
|
setGatewayStatus('Gateway URL, registration token, and box name are all required.', true);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
gatewayConnectBtn.disabled = true;
|
||||||
|
setGatewayStatus('Connecting…');
|
||||||
|
try {
|
||||||
|
const r = await fetch('/api/gateway/connect', {
|
||||||
|
method: 'POST',
|
||||||
|
headers: { 'Content-Type': 'application/json' },
|
||||||
|
body: JSON.stringify({ gateway_url, registration_token, box_name }),
|
||||||
|
});
|
||||||
|
const data = await r.json();
|
||||||
|
if (!r.ok) {
|
||||||
|
setGatewayStatus(data.error || `HTTP ${r.status}`, true);
|
||||||
|
gatewayConnectBtn.disabled = false;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
gatewayPollHandle = setInterval(pollGatewayConnectState, 2000);
|
||||||
|
} catch (e) {
|
||||||
|
setGatewayStatus(`Network error: ${e.message}`, true);
|
||||||
|
gatewayConnectBtn.disabled = false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
async function pollGatewayConnectState() {
|
||||||
|
try {
|
||||||
|
const r = await fetch('/api/gateway/connect/status', { cache: 'no-store' });
|
||||||
|
if (!r.ok) return;
|
||||||
|
const s = await r.json();
|
||||||
|
const label = CONNECT_STAGE_LABELS[s.stage] || `Stage: ${s.stage}`;
|
||||||
|
setGatewayStatus(label, s.stage === 'error');
|
||||||
|
if (s.stage === 'done') {
|
||||||
|
clearInterval(gatewayPollHandle);
|
||||||
|
gatewayConnectBtn.disabled = false;
|
||||||
|
await refreshGatewayStatus();
|
||||||
|
} else if (s.stage === 'error') {
|
||||||
|
clearInterval(gatewayPollHandle);
|
||||||
|
gatewayConnectBtn.disabled = false;
|
||||||
|
if (s.error) setGatewayStatus(`${label} — ${s.error}`, true);
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
/* keep polling; transient blip expected */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
gatewayDisconnectBtn.addEventListener('click', async () => {
|
||||||
|
if (!confirm('Disconnect from the gateway? Any apps currently exposed to the internet will stop being reachable.')) return;
|
||||||
|
gatewayDisconnectBtn.disabled = true;
|
||||||
|
setGatewayStatus('Disconnecting…');
|
||||||
|
try {
|
||||||
|
const r = await fetch('/api/gateway/disconnect', { method: 'POST' });
|
||||||
|
const data = await r.json();
|
||||||
|
if (!r.ok) {
|
||||||
|
setGatewayStatus(data.error || `HTTP ${r.status}`, true);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
setGatewayStatus('Disconnected.');
|
||||||
|
await refreshGatewayStatus();
|
||||||
|
} catch (e) {
|
||||||
|
setGatewayStatus(`Network error: ${e.message}`, true);
|
||||||
|
} finally {
|
||||||
|
gatewayDisconnectBtn.disabled = false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
async function pollUpdateState() {
|
async function pollUpdateState() {
|
||||||
try {
|
try {
|
||||||
const r = await fetch('/update-state.json', { cache: 'no-store' });
|
const r = await fetch('/update-state.json', { cache: 'no-store' });
|
||||||
if (!r.ok) return;
|
if (!r.ok) return;
|
||||||
const s = await r.json();
|
const s = await r.json();
|
||||||
const label = STAGE_LABELS[s.stage] || `Stage: ${s.stage}`;
|
const label = STAGE_LABELS[s.stage] || `Stage: ${s.stage}`;
|
||||||
setStatus(label, s.stage === 'rolled_back');
|
const failed = s.stage === 'rolled_back' || s.stage === 'error';
|
||||||
|
setStatus(label, failed);
|
||||||
if (s.stage === 'done') {
|
if (s.stage === 'done') {
|
||||||
clearInterval(pollHandle);
|
clearInterval(pollHandle);
|
||||||
clearTimeout(fallbackReloadHandle);
|
clearTimeout(fallbackReloadHandle);
|
||||||
setTimeout(() => location.reload(), 5000);
|
setTimeout(() => location.reload(), 5000);
|
||||||
} else if (s.stage === 'rolled_back') {
|
} else if (failed) {
|
||||||
clearInterval(pollHandle);
|
clearInterval(pollHandle);
|
||||||
clearTimeout(fallbackReloadHandle);
|
clearTimeout(fallbackReloadHandle);
|
||||||
if (s.reason) {
|
if (s.reason) {
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,13 @@
|
||||||
--r-pill: 999px;
|
--r-pill: 999px;
|
||||||
|
|
||||||
--shadow-card: 0 1px 2px rgba(0, 0, 0, 0.3);
|
--shadow-card: 0 1px 2px rgba(0, 0, 0, 0.3);
|
||||||
|
--shadow-lift: 0 8px 24px rgba(0, 0, 0, 0.35);
|
||||||
--ring: 0 0 0 2px var(--accent);
|
--ring: 0 0 0 2px var(--accent);
|
||||||
|
/* Brand red from the logo, used only for small highlights. */
|
||||||
|
--brand: #ff6b56;
|
||||||
|
--glow-a: rgba(255, 107, 86, 0.10);
|
||||||
|
--glow-b: rgba(110, 231, 183, 0.08);
|
||||||
|
--nav-bg: rgba(15, 17, 21, 0.72);
|
||||||
}
|
}
|
||||||
|
|
||||||
@media (prefers-color-scheme: light) {
|
@media (prefers-color-scheme: light) {
|
||||||
|
|
@ -38,6 +44,11 @@
|
||||||
--warn-fg: #5a2a10;
|
--warn-fg: #5a2a10;
|
||||||
--danger: #c03a28;
|
--danger: #c03a28;
|
||||||
--shadow-card: 0 1px 3px rgba(0, 0, 0, 0.08);
|
--shadow-card: 0 1px 3px rgba(0, 0, 0, 0.08);
|
||||||
|
--shadow-lift: 0 8px 24px rgba(0, 0, 0, 0.10);
|
||||||
|
--brand: #c03a28;
|
||||||
|
--glow-a: rgba(192, 58, 40, 0.07);
|
||||||
|
--glow-b: rgba(15, 138, 95, 0.06);
|
||||||
|
--nav-bg: rgba(247, 246, 243, 0.8);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -45,9 +56,16 @@
|
||||||
body {
|
body {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
font-family: system-ui, -apple-system, "Segoe UI", Roboto, sans-serif;
|
font-family: system-ui, -apple-system, "Segoe UI", Roboto, sans-serif;
|
||||||
background: var(--bg);
|
/* Two soft glows at the top (logo red, accent green) give the page some
|
||||||
|
depth without competing with the content. */
|
||||||
|
background:
|
||||||
|
radial-gradient(60rem 28rem at 15% -10%, var(--glow-a), transparent 70%),
|
||||||
|
radial-gradient(50rem 24rem at 95% -5%, var(--glow-b), transparent 70%),
|
||||||
|
var(--bg);
|
||||||
|
background-attachment: fixed;
|
||||||
color: var(--fg);
|
color: var(--fg);
|
||||||
line-height: 1.5;
|
line-height: 1.5;
|
||||||
|
-webkit-font-smoothing: antialiased;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Shared page container — both landing and /apps wrap content in
|
/* Shared page container — both landing and /apps wrap content in
|
||||||
|
|
@ -59,9 +77,16 @@ body {
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
justify-content: space-between;
|
justify-content: space-between;
|
||||||
padding-bottom: 1.25rem;
|
padding: 0.85rem 0;
|
||||||
border-bottom: 1px solid var(--border);
|
border-bottom: 1px solid var(--border);
|
||||||
margin-bottom: 2rem;
|
margin-bottom: 2rem;
|
||||||
|
/* Stays in reach while scrolling long pages like /settings. */
|
||||||
|
position: sticky;
|
||||||
|
top: 0;
|
||||||
|
z-index: 20;
|
||||||
|
background: var(--nav-bg);
|
||||||
|
-webkit-backdrop-filter: blur(10px);
|
||||||
|
backdrop-filter: blur(10px);
|
||||||
}
|
}
|
||||||
.brand {
|
.brand {
|
||||||
font-weight: 700;
|
font-weight: 700;
|
||||||
|
|
@ -73,13 +98,17 @@ body {
|
||||||
align-items: center;
|
align-items: center;
|
||||||
gap: 0.55rem;
|
gap: 0.55rem;
|
||||||
}
|
}
|
||||||
|
/* Furtka mark (M), drawn as a mask so it takes the accent colour in both
|
||||||
|
themes. Generated geometry: website/tools/brand-assets.py. */
|
||||||
.brand::before {
|
.brand::before {
|
||||||
content: "";
|
content: "";
|
||||||
width: 0.7rem;
|
width: 1.35rem;
|
||||||
height: 0.7rem;
|
height: 1.35rem;
|
||||||
background: var(--accent);
|
/* Brand red, not the UI's green accent — the logo keeps its colour.
|
||||||
border-radius: 2px;
|
This stylesheet is dark-first; the light theme gets the deeper red. */
|
||||||
transform: rotate(45deg);
|
background: #ff6b56;
|
||||||
|
-webkit-mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 64 64'%3E%3Cpath fill-rule='evenodd' d='M5 60V27a27 27 0 0 1 54 0v33Z M19.5 60V26A10 10 0 0 1 29.5 16H46v10H32a2.5 2.5 0 0 0-2.5 2.5V32H46v10H29.5v18Z'/%3E%3C/svg%3E") center / contain no-repeat;
|
||||||
|
mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 64 64'%3E%3Cpath fill-rule='evenodd' d='M5 60V27a27 27 0 0 1 54 0v33Z M19.5 60V26A10 10 0 0 1 29.5 16H46v10H32a2.5 2.5 0 0 0-2.5 2.5V32H46v10H29.5v18Z'/%3E%3C/svg%3E") center / contain no-repeat;
|
||||||
}
|
}
|
||||||
.nav-links { display: flex; gap: 0.25rem; }
|
.nav-links { display: flex; gap: 0.25rem; }
|
||||||
.nav-links a {
|
.nav-links a {
|
||||||
|
|
@ -87,30 +116,52 @@ body {
|
||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
font-size: 0.9rem;
|
font-size: 0.9rem;
|
||||||
padding: 0.35rem 0.75rem;
|
padding: 0.35rem 0.75rem;
|
||||||
border-radius: var(--r-sm);
|
border-radius: var(--r-pill);
|
||||||
|
transition: color 120ms, background 120ms;
|
||||||
}
|
}
|
||||||
.nav-links a:hover { color: var(--fg); }
|
.nav-links a:hover { color: var(--fg); background: var(--card); }
|
||||||
.nav-links a[aria-current="page"] {
|
.nav-links a[aria-current="page"] {
|
||||||
color: var(--fg);
|
color: var(--fg);
|
||||||
background: var(--accent-soft);
|
background: var(--accent-soft);
|
||||||
}
|
}
|
||||||
|
|
||||||
/* -- Landing page ---------------------------------------------- */
|
/* -- Landing page ---------------------------------------------- */
|
||||||
header h1 { margin: 0 0 0.5rem; font-size: 2.5rem; }
|
header h1 {
|
||||||
|
margin: 0 0 0.5rem;
|
||||||
|
font-size: clamp(2rem, 6vw, 2.75rem);
|
||||||
|
letter-spacing: -0.02em;
|
||||||
|
line-height: 1.1;
|
||||||
|
background: linear-gradient(100deg, var(--fg) 40%, var(--accent));
|
||||||
|
-webkit-background-clip: text;
|
||||||
|
background-clip: text;
|
||||||
|
color: transparent;
|
||||||
|
}
|
||||||
.lead { font-size: 1.25rem; color: var(--muted); margin: 0 0 0.25rem; }
|
.lead { font-size: 1.25rem; color: var(--muted); margin: 0 0 0.25rem; }
|
||||||
.host { color: var(--muted); margin: 0 0 3rem; }
|
.host { color: var(--muted); margin: 0 0 3rem; }
|
||||||
.host code {
|
.host code {
|
||||||
background: var(--card);
|
background: var(--accent-soft);
|
||||||
padding: 0.15rem 0.5rem;
|
padding: 0.2rem 0.65rem;
|
||||||
border-radius: var(--r-sm);
|
border-radius: var(--r-pill);
|
||||||
color: var(--accent);
|
color: var(--accent);
|
||||||
|
font-size: 0.9em;
|
||||||
}
|
}
|
||||||
section h2 {
|
section h2 {
|
||||||
font-size: 1.1rem;
|
font-size: 0.85rem;
|
||||||
text-transform: uppercase;
|
text-transform: uppercase;
|
||||||
letter-spacing: 0.1em;
|
letter-spacing: 0.12em;
|
||||||
color: var(--muted);
|
color: var(--muted);
|
||||||
margin: 2rem 0 1rem;
|
margin: 2.5rem 0 1rem;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.6rem;
|
||||||
|
}
|
||||||
|
/* Small brand-red marker in front of each landing-page section title. */
|
||||||
|
section h2::before {
|
||||||
|
content: "";
|
||||||
|
width: 0.45rem;
|
||||||
|
height: 0.45rem;
|
||||||
|
border-radius: var(--r-pill);
|
||||||
|
background: var(--brand);
|
||||||
}
|
}
|
||||||
.tiles {
|
.tiles {
|
||||||
display: grid;
|
display: grid;
|
||||||
|
|
@ -120,9 +171,21 @@ section h2 {
|
||||||
.tile {
|
.tile {
|
||||||
background: var(--card);
|
background: var(--card);
|
||||||
padding: 1.25rem;
|
padding: 1.25rem;
|
||||||
border-radius: var(--r-md);
|
border: 1px solid var(--border);
|
||||||
|
border-radius: var(--r-lg);
|
||||||
display: flex;
|
display: flex;
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
|
position: relative;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
/* Thin accent line along the top edge of each status tile. */
|
||||||
|
.tile::before {
|
||||||
|
content: "";
|
||||||
|
position: absolute;
|
||||||
|
inset: 0 0 auto 0;
|
||||||
|
height: 3px;
|
||||||
|
background: linear-gradient(90deg, var(--accent), transparent);
|
||||||
|
opacity: 0.7;
|
||||||
}
|
}
|
||||||
.tile .label {
|
.tile .label {
|
||||||
font-size: 0.8rem;
|
font-size: 0.8rem;
|
||||||
|
|
@ -130,7 +193,12 @@ section h2 {
|
||||||
text-transform: uppercase;
|
text-transform: uppercase;
|
||||||
letter-spacing: 0.08em;
|
letter-spacing: 0.08em;
|
||||||
}
|
}
|
||||||
.tile .value { font-size: 1.25rem; margin-top: 0.5rem; }
|
.tile .value {
|
||||||
|
font-size: 1.35rem;
|
||||||
|
font-weight: 600;
|
||||||
|
margin-top: 0.5rem;
|
||||||
|
font-variant-numeric: tabular-nums;
|
||||||
|
}
|
||||||
.updated { font-size: 0.85rem; color: var(--muted); margin-top: 1rem; }
|
.updated { font-size: 0.85rem; color: var(--muted); margin-top: 1rem; }
|
||||||
.soon {
|
.soon {
|
||||||
background: var(--card);
|
background: var(--card);
|
||||||
|
|
@ -168,7 +236,9 @@ h2 {
|
||||||
.app {
|
.app {
|
||||||
background: var(--card);
|
background: var(--card);
|
||||||
padding: 1rem;
|
padding: 1rem;
|
||||||
border-radius: var(--r-md);
|
border: 1px solid var(--border);
|
||||||
|
border-radius: var(--r-lg);
|
||||||
|
transition: border-color 120ms;
|
||||||
margin: 0.5rem 0;
|
margin: 0.5rem 0;
|
||||||
display: flex;
|
display: flex;
|
||||||
justify-content: space-between;
|
justify-content: space-between;
|
||||||
|
|
@ -215,13 +285,69 @@ button, .btn {
|
||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
display: inline-flex;
|
display: inline-flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
|
transition: filter 120ms, transform 80ms;
|
||||||
}
|
}
|
||||||
|
button:hover:not(:disabled), .btn:hover { filter: brightness(1.08); }
|
||||||
|
button:active:not(:disabled), .btn:active { transform: translateY(1px); }
|
||||||
button.secondary, .btn.secondary {
|
button.secondary, .btn.secondary {
|
||||||
background: var(--card);
|
background: var(--card);
|
||||||
color: var(--fg);
|
color: var(--fg);
|
||||||
border: 1px solid var(--border);
|
border: 1px solid var(--border);
|
||||||
}
|
}
|
||||||
button.danger { background: var(--danger); color: #fff; }
|
button.danger { background: var(--danger); color: #fff; }
|
||||||
|
|
||||||
|
/* Public-URL line under an app's description, shown while the app is
|
||||||
|
exposed through furtka-gateway. */
|
||||||
|
.public-link {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.4rem;
|
||||||
|
margin-top: 0.25rem;
|
||||||
|
font-size: 0.85rem;
|
||||||
|
color: var(--accent);
|
||||||
|
text-decoration: none;
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
.public-link:hover { text-decoration: underline; }
|
||||||
|
.public-link .dot {
|
||||||
|
width: 0.5rem;
|
||||||
|
height: 0.5rem;
|
||||||
|
border-radius: var(--r-pill);
|
||||||
|
background: var(--accent);
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* "⋯" overflow menu on an installed app row. */
|
||||||
|
details.menu { position: relative; }
|
||||||
|
details.menu > summary { list-style: none; padding: 0.5rem 0.75rem; }
|
||||||
|
details.menu > summary::-webkit-details-marker { display: none; }
|
||||||
|
.menu-list {
|
||||||
|
position: absolute;
|
||||||
|
right: 0;
|
||||||
|
top: calc(100% + 0.25rem);
|
||||||
|
z-index: 10;
|
||||||
|
min-width: 11rem;
|
||||||
|
padding: 0.25rem;
|
||||||
|
background: var(--card);
|
||||||
|
border: 1px solid var(--border);
|
||||||
|
border-radius: var(--r-md);
|
||||||
|
box-shadow: 0 4px 16px rgba(0, 0, 0, 0.25);
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
}
|
||||||
|
.menu-list button {
|
||||||
|
background: none;
|
||||||
|
color: var(--fg);
|
||||||
|
font-weight: 500;
|
||||||
|
width: 100%;
|
||||||
|
justify-content: flex-start;
|
||||||
|
}
|
||||||
|
.menu-list button:hover { background: var(--card-hover); }
|
||||||
|
.menu-list button.danger { background: none; color: var(--danger); }
|
||||||
|
.menu-list button.danger:hover { background: var(--card-hover); }
|
||||||
|
.menu-list hr { border: none; border-top: 1px solid var(--border); margin: 0.25rem 0; }
|
||||||
button:disabled { opacity: 0.5; cursor: wait; }
|
button:disabled { opacity: 0.5; cursor: wait; }
|
||||||
button:focus-visible, .btn:focus-visible { outline: none; box-shadow: var(--ring); }
|
button:focus-visible, .btn:focus-visible { outline: none; box-shadow: var(--ring); }
|
||||||
.empty { color: var(--muted); font-style: italic; padding: 0.5rem 0; }
|
.empty { color: var(--muted); font-style: italic; padding: 0.5rem 0; }
|
||||||
|
|
@ -394,7 +520,8 @@ details.log-details[open] > summary { color: var(--fg); }
|
||||||
.card {
|
.card {
|
||||||
background: var(--card);
|
background: var(--card);
|
||||||
padding: 1.25rem;
|
padding: 1.25rem;
|
||||||
border-radius: var(--r-md);
|
border: 1px solid var(--border);
|
||||||
|
border-radius: var(--r-lg);
|
||||||
box-shadow: var(--shadow-card);
|
box-shadow: var(--shadow-card);
|
||||||
}
|
}
|
||||||
.card + .card { margin-top: 1rem; }
|
.card + .card { margin-top: 1rem; }
|
||||||
|
|
@ -449,9 +576,9 @@ details.log-details[open] > summary { color: var(--fg); }
|
||||||
gap: 0.75rem;
|
gap: 0.75rem;
|
||||||
}
|
}
|
||||||
.app-tile {
|
.app-tile {
|
||||||
background: var(--bg);
|
background: var(--card);
|
||||||
border: 1px solid var(--border);
|
border: 1px solid var(--border);
|
||||||
border-radius: var(--r-md);
|
border-radius: var(--r-lg);
|
||||||
padding: 1rem;
|
padding: 1rem;
|
||||||
display: flex;
|
display: flex;
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
|
|
@ -459,12 +586,20 @@ details.log-details[open] > summary { color: var(--fg); }
|
||||||
align-items: flex-start;
|
align-items: flex-start;
|
||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
color: var(--fg);
|
color: var(--fg);
|
||||||
transition: border-color 120ms, background 120ms;
|
transition: border-color 120ms, background 120ms, transform 120ms, box-shadow 120ms;
|
||||||
|
}
|
||||||
|
.app-tile:hover {
|
||||||
|
border-color: var(--accent);
|
||||||
|
background: var(--card-hover);
|
||||||
|
transform: translateY(-2px);
|
||||||
|
box-shadow: var(--shadow-lift);
|
||||||
}
|
}
|
||||||
.app-tile:hover { border-color: var(--accent); background: var(--card-hover); }
|
|
||||||
.app-tile .icon {
|
.app-tile .icon {
|
||||||
width: 40px;
|
width: 48px;
|
||||||
height: 40px;
|
height: 48px;
|
||||||
|
padding: 6px;
|
||||||
|
border-radius: var(--r-md);
|
||||||
|
background: var(--accent-soft);
|
||||||
color: var(--accent);
|
color: var(--accent);
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
|
|
@ -490,3 +625,15 @@ details.log-details[open] > summary { color: var(--fg); }
|
||||||
color: var(--accent);
|
color: var(--accent);
|
||||||
}
|
}
|
||||||
.app-icon svg { width: 36px; height: 36px; }
|
.app-icon svg { width: 36px; height: 36px; }
|
||||||
|
|
||||||
|
.login-brand { margin: 0 0 1.5rem; font-size: 1.2rem; }
|
||||||
|
|
||||||
|
.app:hover { border-color: color-mix(in srgb, var(--accent) 40%, var(--border)); }
|
||||||
|
|
||||||
|
@media (prefers-reduced-motion: reduce) {
|
||||||
|
*, *::before, *::after { transition: none !important; }
|
||||||
|
.app-tile:hover { transform: none; }
|
||||||
|
}
|
||||||
|
@media (prefers-color-scheme: light) {
|
||||||
|
.brand::before { background: #c03a28; }
|
||||||
|
}
|
||||||
|
|
|
||||||
19
docs/brand/README.md
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
# Furtka brand files
|
||||||
|
|
||||||
|
The Furtka logo is **Mark M** — a lowercase *f* cut out of an arched gate. It won the
|
||||||
|
public logo vote on furtka.org (closed 2026-09-28: M 29, R 13 of 42 votes).
|
||||||
|
|
||||||
|
| File | Use |
|
||||||
|
|---|---|
|
||||||
|
| `furtka-mark.svg` | The mark, 32 px and up |
|
||||||
|
| `furtka-mark-small.svg` | Simplified drawing for 16–24 px (favicons, tab icons) |
|
||||||
|
| `furtka-lockup.svg` | Mark + wordmark, accent colour on light grounds |
|
||||||
|
| `furtka-lockup-white.svg` | Mark + wordmark in white, for dark or accent grounds |
|
||||||
|
| `console-banner.txt` | Text-mode art for the console welcome screens |
|
||||||
|
|
||||||
|
Colours: accent `#c03a28` (dark UI: `#ff6b56`), ink `#0d0d0f`.
|
||||||
|
|
||||||
|
Everything here and the copies in `website/static/`, `webinstaller/static/`,
|
||||||
|
`assets/www/` and `iso/overlay/splash.png` are generated by
|
||||||
|
`website/tools/brand-assets.py` from the geometry in `website/tools/logo-assets.py`.
|
||||||
|
Change the geometry there and re-run the script — don't edit the outputs by hand.
|
||||||
10
docs/brand/console-banner.txt
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
▄▄▄▄▄▄▄▄
|
||||||
|
▄██████████▄
|
||||||
|
█████▀▀▀▀▀▀███
|
||||||
|
████▀ ████
|
||||||
|
████ █████████
|
||||||
|
████ ████
|
||||||
|
████ ▄▄▄▄▄████
|
||||||
|
████ █████████
|
||||||
|
████ █████████
|
||||||
|
▀▀▀▀ ▀▀▀▀▀▀▀▀▀
|
||||||
1
docs/brand/furtka-lockup-white.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -4 232.44 64.00" role="img" aria-label="Furtka"><g transform="scale(1.0000) translate(-6 -2)"><path fill="#ffffff" fill-rule="evenodd" d="M6 60V28a26 26 0 0 1 52 0v32Z M20.0 60V26.5A10.5 10.5 0 0 1 30.5 16H45.0v8.6H32.5a3.5 3.5 0 0 0-3.5 3.5V32h16v8.6H29.0V60Z"/></g><g fill="#ffffff"><path transform="translate(68.24 58.00) scale(0.05354 -0.05354)" d="M115 0V494H30V600H115V637Q115 687 132.5 724.0Q150 761 192.0 781.5Q234 802 305 802Q333 802 358 799V695Q344 698 324 698Q287 698 273.5 682.0Q260 666 260 632V600H358V494H260V0Z"/><path transform="translate(87.21 58.00) scale(0.05354 -0.05354)" d="M271 -15Q169 -15 119.0 48.5Q69 112 69 218V600H218V244Q218 179 241.5 143.0Q265 107 316 107Q379 107 413.0 156.0Q447 205 447 276V600H596V0H462V90H438Q423 44 382.5 14.5Q342 -15 271 -15Z"/><path transform="translate(121.45 58.00) scale(0.05354 -0.05354)" d="M76 0V600H211V492H235Q241 521 257.0 547.0Q273 573 307.0 589.5Q341 606 399 606H428V471H387Q301 471 263.0 427.0Q225 383 225 294V0Z"/><path transform="translate(144.17 58.00) scale(0.05354 -0.05354)" d="M162 0Q139 27 125.5 65.0Q112 103 112 179V494H30V600H114V750H259V600H358V494H260V196Q260 116 278.0 74.5Q296 33 321 6V0Z"/><path transform="translate(163.14 58.00) scale(0.05354 -0.05354)" d="M78 0V800H226V366H274L449 600H608V594L397 320L632 6V0H457L274 254H226V0Z"/><path transform="translate(195.88 58.00) scale(0.05354 -0.05354)" d="M280 -13Q198 -13 144.0 27.5Q90 68 63.5 138.5Q37 209 37 301Q37 395 64.0 465.0Q91 535 145.0 574.0Q199 613 280 613Q344 613 384.5 587.5Q425 562 445 522H469V600H606V0H469V78H445Q425 41 385.0 14.0Q345 -13 280 -13ZM317 95Q381 95 419.5 151.0Q458 207 458 300Q458 394 419.5 449.5Q381 505 317 505Q257 505 223.5 453.0Q190 401 190 300Q190 199 223.5 147.0Q257 95 317 95Z"/></g></svg>
|
||||||
|
After Width: | Height: | Size: 1.8 KiB |
1
docs/brand/furtka-lockup.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 -4 232.44 64.00" role="img" aria-label="Furtka"><g transform="scale(1.0000) translate(-6 -2)"><path fill="#c03a28" fill-rule="evenodd" d="M6 60V28a26 26 0 0 1 52 0v32Z M20.0 60V26.5A10.5 10.5 0 0 1 30.5 16H45.0v8.6H32.5a3.5 3.5 0 0 0-3.5 3.5V32h16v8.6H29.0V60Z"/></g><g fill="#c03a28"><path transform="translate(68.24 58.00) scale(0.05354 -0.05354)" d="M115 0V494H30V600H115V637Q115 687 132.5 724.0Q150 761 192.0 781.5Q234 802 305 802Q333 802 358 799V695Q344 698 324 698Q287 698 273.5 682.0Q260 666 260 632V600H358V494H260V0Z"/><path transform="translate(87.21 58.00) scale(0.05354 -0.05354)" d="M271 -15Q169 -15 119.0 48.5Q69 112 69 218V600H218V244Q218 179 241.5 143.0Q265 107 316 107Q379 107 413.0 156.0Q447 205 447 276V600H596V0H462V90H438Q423 44 382.5 14.5Q342 -15 271 -15Z"/><path transform="translate(121.45 58.00) scale(0.05354 -0.05354)" d="M76 0V600H211V492H235Q241 521 257.0 547.0Q273 573 307.0 589.5Q341 606 399 606H428V471H387Q301 471 263.0 427.0Q225 383 225 294V0Z"/><path transform="translate(144.17 58.00) scale(0.05354 -0.05354)" d="M162 0Q139 27 125.5 65.0Q112 103 112 179V494H30V600H114V750H259V600H358V494H260V196Q260 116 278.0 74.5Q296 33 321 6V0Z"/><path transform="translate(163.14 58.00) scale(0.05354 -0.05354)" d="M78 0V800H226V366H274L449 600H608V594L397 320L632 6V0H457L274 254H226V0Z"/><path transform="translate(195.88 58.00) scale(0.05354 -0.05354)" d="M280 -13Q198 -13 144.0 27.5Q90 68 63.5 138.5Q37 209 37 301Q37 395 64.0 465.0Q91 535 145.0 574.0Q199 613 280 613Q344 613 384.5 587.5Q425 562 445 522H469V600H606V0H469V78H445Q425 41 385.0 14.0Q345 -13 280 -13ZM317 95Q381 95 419.5 151.0Q458 207 458 300Q458 394 419.5 449.5Q381 505 317 505Q257 505 223.5 453.0Q190 401 190 300Q190 199 223.5 147.0Q257 95 317 95Z"/></g></svg>
|
||||||
|
After Width: | Height: | Size: 1.8 KiB |
1
docs/brand/furtka-mark-small.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><path fill="#c03a28" fill-rule="evenodd" d="M5 60V27a27 27 0 0 1 54 0v33Z M19.5 60V26A10 10 0 0 1 29.5 16H46v10H32a2.5 2.5 0 0 0-2.5 2.5V32H46v10H29.5v18Z"/></svg>
|
||||||
|
After Width: | Height: | Size: 224 B |
1
docs/brand/furtka-mark.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><path fill="#c03a28" fill-rule="evenodd" d="M6 60V28a26 26 0 0 1 52 0v32Z M20.0 60V26.5A10.5 10.5 0 0 1 30.5 16H45.0v8.6H32.5a3.5 3.5 0 0 0-3.5 3.5V32h16v8.6H29.0V60Z"/></svg>
|
||||||
|
After Width: | Height: | Size: 236 B |
|
|
@ -15,6 +15,7 @@ neutral ``ReleaseError`` for use in tests or standalone scripts.
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import hashlib
|
import hashlib
|
||||||
|
import http.client
|
||||||
import json
|
import json
|
||||||
import shutil
|
import shutil
|
||||||
import tarfile
|
import tarfile
|
||||||
|
|
@ -33,7 +34,9 @@ def forgejo_api(host: str, repo: str, path: str, *, error_cls: type = ReleaseErr
|
||||||
try:
|
try:
|
||||||
with urllib.request.urlopen(req, timeout=15) as resp:
|
with urllib.request.urlopen(req, timeout=15) as resp:
|
||||||
return json.loads(resp.read())
|
return json.loads(resp.read())
|
||||||
except (urllib.error.URLError, json.JSONDecodeError) as e:
|
except (OSError, http.client.HTTPException, json.JSONDecodeError) as e:
|
||||||
|
# OSError covers URLError plus socket timeouts and resets while
|
||||||
|
# reading the body, which urllib doesn't wrap.
|
||||||
raise error_cls(f"forgejo api {url}: {e}") from e
|
raise error_cls(f"forgejo api {url}: {e}") from e
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -43,7 +46,8 @@ def download(url: str, dest: Path, *, error_cls: type = ReleaseError) -> None:
|
||||||
try:
|
try:
|
||||||
with urllib.request.urlopen(req, timeout=60) as resp, dest.open("wb") as f:
|
with urllib.request.urlopen(req, timeout=60) as resp, dest.open("wb") as f:
|
||||||
shutil.copyfileobj(resp, f)
|
shutil.copyfileobj(resp, f)
|
||||||
except urllib.error.URLError as e:
|
except (OSError, http.client.HTTPException) as e:
|
||||||
|
# Includes disk full while writing `dest` and mid-body disconnects.
|
||||||
raise error_cls(f"download {url}: {e}") from e
|
raise error_cls(f"download {url}: {e}") from e
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
446
furtka/api.py
|
|
@ -17,12 +17,14 @@ stopgap.
|
||||||
|
|
||||||
import json
|
import json
|
||||||
import re
|
import re
|
||||||
|
import threading
|
||||||
import time
|
import time
|
||||||
|
import traceback
|
||||||
from http.cookies import SimpleCookie
|
from http.cookies import SimpleCookie
|
||||||
from http.server import BaseHTTPRequestHandler, HTTPServer
|
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
|
||||||
|
|
||||||
from furtka import auth, deps, dockerops, install_runner, installer, reconciler, sources
|
from furtka import auth, deps, dockerops, install_runner, installer, reconciler, sources
|
||||||
from furtka.manifest import ManifestError, load_manifest
|
from furtka.manifest import APP_NAME_RE, ManifestError, load_manifest
|
||||||
from furtka.paths import apps_dir, static_www_dir
|
from furtka.paths import apps_dir, static_www_dir
|
||||||
from furtka.scanner import scan
|
from furtka.scanner import scan
|
||||||
|
|
||||||
|
|
@ -71,6 +73,7 @@ _HTML = """<!DOCTYPE html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
|
<link rel="icon" type="image/svg+xml" href="/favicon.svg">
|
||||||
<title>Furtka Apps</title>
|
<title>Furtka Apps</title>
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
<link rel="stylesheet" href="/style.css">
|
<link rel="stylesheet" href="/style.css">
|
||||||
|
|
@ -120,6 +123,15 @@ _HTML = """<!DOCTYPE html>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
|
// Sessions live in API memory, so every restart or self-update logs
|
||||||
|
// everyone out. Send the browser to the login page instead of rendering
|
||||||
|
// the 401 body as if the box had no apps.
|
||||||
|
const _fetch = window.fetch.bind(window);
|
||||||
|
window.fetch = async (...args) => {
|
||||||
|
const r = await _fetch(...args);
|
||||||
|
if (r.status === 401) { location.href = '/login'; }
|
||||||
|
return r;
|
||||||
|
};
|
||||||
function esc(s) {
|
function esc(s) {
|
||||||
const d = document.createElement('div');
|
const d = document.createElement('div');
|
||||||
d.textContent = s == null ? '' : String(s);
|
d.textContent = s == null ? '' : String(s);
|
||||||
|
|
@ -358,6 +370,20 @@ async function refresh() {
|
||||||
const openBtn = openHref
|
const openBtn = openHref
|
||||||
? `<a class="btn" href="${esc(openHref)}" target="_blank" rel="noopener">Open</a>`
|
? `<a class="btn" href="${esc(openHref)}" target="_blank" rel="noopener">Open</a>`
|
||||||
: '';
|
: '';
|
||||||
|
// Both filled in async by loadInternetSlots() after this markup
|
||||||
|
// lands — the current publish state needs its own fetch per app
|
||||||
|
// (/api/apps/<name>/internet), so it can't be known at row-build
|
||||||
|
// time. The status line sits under the description (public URL,
|
||||||
|
// when exposed); the toggle lives in the "⋯" menu.
|
||||||
|
const viable = a.internet && a.internet.viable;
|
||||||
|
const internetStatus = viable
|
||||||
|
? `<span class="internet-status" data-name="${esc(a.name)}"></span>`
|
||||||
|
: '';
|
||||||
|
const internetItem = viable
|
||||||
|
? `<span class="internet-item" data-name="${esc(a.name)}"></span>`
|
||||||
|
: '';
|
||||||
|
// Only Open stays visible; everything else goes in a <details>
|
||||||
|
// menu so the description isn't squeezed by a row of buttons.
|
||||||
return `
|
return `
|
||||||
<div class="app">
|
<div class="app">
|
||||||
<div class="left">
|
<div class="left">
|
||||||
|
|
@ -365,15 +391,23 @@ async function refresh() {
|
||||||
<div class="meta">
|
<div class="meta">
|
||||||
<span class="name">${esc(a.display_name || a.name)} <small>${esc(a.version || '')}</small></span>
|
<span class="name">${esc(a.display_name || a.name)} <small>${esc(a.version || '')}</small></span>
|
||||||
<span class="desc">${esc(a.description || a.error || '')}</span>
|
<span class="desc">${esc(a.description || a.error || '')}</span>
|
||||||
|
${internetStatus}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="buttons">
|
<div class="buttons">
|
||||||
${openBtn}
|
${openBtn}
|
||||||
|
<details class="menu">
|
||||||
|
<summary class="btn secondary" aria-label="More actions for ${esc(a.display_name || a.name)}">⋯</summary>
|
||||||
|
<div class="menu-list">
|
||||||
${hasSettings ? `<button data-op="edit" data-name="${esc(a.name)}">Settings</button>` : ''}
|
${hasSettings ? `<button data-op="edit" data-name="${esc(a.name)}">Settings</button>` : ''}
|
||||||
<button class="secondary" data-op="update" data-name="${esc(a.name)}">Update</button>
|
${internetItem}
|
||||||
<button class="secondary" data-op="reinstall" data-name="${esc(a.name)}">Reinstall</button>
|
<button data-op="update" data-name="${esc(a.name)}">Update</button>
|
||||||
|
<button data-op="reinstall" data-name="${esc(a.name)}">Reinstall</button>
|
||||||
|
<hr>
|
||||||
<button class="danger" data-op="remove" data-name="${esc(a.name)}">Remove</button>
|
<button class="danger" data-op="remove" data-name="${esc(a.name)}">Remove</button>
|
||||||
</div>
|
</div>
|
||||||
|
</details>
|
||||||
|
</div>
|
||||||
</div>`;
|
</div>`;
|
||||||
}).join('')
|
}).join('')
|
||||||
: '<div class="empty">No apps installed yet.</div>';
|
: '<div class="empty">No apps installed yet.</div>';
|
||||||
|
|
@ -393,6 +427,78 @@ async function refresh() {
|
||||||
for (const btn of document.querySelectorAll('button[data-op]')) {
|
for (const btn of document.querySelectorAll('button[data-op]')) {
|
||||||
btn.addEventListener('click', () => handleButton(btn.dataset.op, btn.dataset.name, btn));
|
btn.addEventListener('click', () => handleButton(btn.dataset.op, btn.dataset.name, btn));
|
||||||
}
|
}
|
||||||
|
loadInternetSlots();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Populates each installed internet-viable app's public-URL status line
|
||||||
|
// and its "Expose to Internet" / "Stop exposing" menu item. Separate from
|
||||||
|
// the main refresh() render because the current publish state needs its
|
||||||
|
// own per-app fetch — the /api/apps list only carries whether an app is
|
||||||
|
// *capable* of being exposed, not whether it currently is.
|
||||||
|
async function loadInternetSlots() {
|
||||||
|
for (const item of document.querySelectorAll('.internet-item')) {
|
||||||
|
const name = item.dataset.name;
|
||||||
|
const status = document.querySelector(`.internet-status[data-name="${CSS.escape(name)}"]`);
|
||||||
|
try {
|
||||||
|
const r = await fetch(`/api/apps/${encodeURIComponent(name)}/internet`);
|
||||||
|
if (!r.ok) continue;
|
||||||
|
renderInternetSlot(item, status, name, await r.json());
|
||||||
|
} catch (e) {
|
||||||
|
// Leave the slots empty — next refresh() retries.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function renderInternetSlot(item, status, name, data) {
|
||||||
|
if (data.enabled) {
|
||||||
|
const host = data.public_url.replace(/^https?:\\/\\//, '').replace(/\\/$/, '');
|
||||||
|
if (status) {
|
||||||
|
status.innerHTML =
|
||||||
|
`<a class="public-link" href="${esc(data.public_url)}" target="_blank" rel="noopener">` +
|
||||||
|
`<span class="dot"></span>${esc(host)} ↗</a>`;
|
||||||
|
}
|
||||||
|
item.innerHTML = `<button data-internet="${esc(name)}">Stop exposing</button>`;
|
||||||
|
} else {
|
||||||
|
if (status) status.innerHTML = '';
|
||||||
|
item.innerHTML = `<button data-internet="${esc(name)}">Expose to Internet</button>`;
|
||||||
|
}
|
||||||
|
item.querySelector('[data-internet]').addEventListener('click', () => handleInternetToggle(name, !!data.enabled));
|
||||||
|
}
|
||||||
|
|
||||||
|
// <details> menus don't close on an outside click by themselves.
|
||||||
|
document.addEventListener('click', (e) => {
|
||||||
|
for (const menu of document.querySelectorAll('details.menu[open]')) {
|
||||||
|
if (!menu.contains(e.target)) menu.removeAttribute('open');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
async function handleInternetToggle(name, currentlyEnabled) {
|
||||||
|
const logEl = document.getElementById('log');
|
||||||
|
if (currentlyEnabled) {
|
||||||
|
if (!confirm(`Stop exposing ${name} to the internet?`)) return;
|
||||||
|
}
|
||||||
|
let subdomain = null;
|
||||||
|
if (!currentlyEnabled) {
|
||||||
|
subdomain = prompt(
|
||||||
|
`Public hostname for ${name} — needs its own DNS record already pointing at your gateway:`
|
||||||
|
);
|
||||||
|
if (!subdomain) return;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
const r = await fetch(`/api/apps/${encodeURIComponent(name)}/internet`, {
|
||||||
|
method: 'POST',
|
||||||
|
headers: { 'Content-Type': 'application/json' },
|
||||||
|
body: JSON.stringify(currentlyEnabled ? { enabled: false } : { enabled: true, subdomain }),
|
||||||
|
});
|
||||||
|
const data = await r.json();
|
||||||
|
if (!r.ok) {
|
||||||
|
logEl.textContent = `[internet ${name}] HTTP ${r.status}\\n` + JSON.stringify(data, null, 2);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
await refresh();
|
||||||
|
} catch (e) {
|
||||||
|
logEl.textContent = `[internet ${name}] Network error: ${e.message}`;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function handleButton(op, name, btn) {
|
async function handleButton(op, name, btn) {
|
||||||
|
|
@ -546,12 +652,14 @@ _HTML_LOGIN = """<!DOCTYPE html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
|
<link rel="icon" type="image/svg+xml" href="/favicon.svg">
|
||||||
<title>Furtka · {{ TITLE }}</title>
|
<title>Furtka · {{ TITLE }}</title>
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
<link rel="stylesheet" href="/style.css">
|
<link rel="stylesheet" href="/style.css">
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<main class="wrap login-wrap">
|
<main class="wrap login-wrap">
|
||||||
|
<p class="brand login-brand">Furtka</p>
|
||||||
<h1>{{ HEADING }}</h1>
|
<h1>{{ HEADING }}</h1>
|
||||||
<p class="lede">{{ LEDE }}</p>
|
<p class="lede">{{ LEDE }}</p>
|
||||||
<form id="login-form" onsubmit="return doLogin(event)">
|
<form id="login-form" onsubmit="return doLogin(event)">
|
||||||
|
|
@ -669,6 +777,7 @@ def _manifest_summary(m, app_dir=None):
|
||||||
{"app": req.app, "on_install": req.on_install, "on_start": req.on_start}
|
{"app": req.app, "on_install": req.on_install, "on_start": req.on_start}
|
||||||
for req in m.requires
|
for req in m.requires
|
||||||
],
|
],
|
||||||
|
"internet": {"viable": m.internet.viable, "port": m.internet.port},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -765,7 +874,7 @@ def _do_get_settings(name):
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
_INSTALL_TERMINAL_STAGES = frozenset({"done", "error"})
|
_INSTALL_TERMINAL_STAGES = install_runner.TERMINAL_STAGES
|
||||||
|
|
||||||
|
|
||||||
def _do_install_plan(name):
|
def _do_install_plan(name):
|
||||||
|
|
@ -819,8 +928,9 @@ def _do_install(name, settings=None, confirm_dependencies=False):
|
||||||
# POST can sneak in during that tiny window. Reading the state
|
# POST can sneak in during that tiny window. Reading the state
|
||||||
# first closes that gap: as long as a previous install hasn't
|
# first closes that gap: as long as a previous install hasn't
|
||||||
# written "done" or "error", we refuse.
|
# written "done" or "error", we refuse.
|
||||||
|
install_runner.clear_stale_state()
|
||||||
current_state = install_runner.read_state()
|
current_state = install_runner.read_state()
|
||||||
current_stage = current_state.get("stage", "") if isinstance(current_state, dict) else ""
|
current_stage = current_state.get("stage", "")
|
||||||
if current_stage and current_stage not in _INSTALL_TERMINAL_STAGES:
|
if current_stage and current_stage not in _INSTALL_TERMINAL_STAGES:
|
||||||
return 409, {
|
return 409, {
|
||||||
"error": (
|
"error": (
|
||||||
|
|
@ -916,6 +1026,7 @@ def _do_install(name, settings=None, confirm_dependencies=False):
|
||||||
|
|
||||||
def _do_install_status():
|
def _do_install_status():
|
||||||
"""Return the current install-state.json contents (or {})."""
|
"""Return the current install-state.json contents (or {})."""
|
||||||
|
install_runner.clear_stale_state()
|
||||||
return 200, install_runner.read_state()
|
return 200, install_runner.read_state()
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1142,6 +1253,208 @@ def _do_catalog_status():
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _do_gateway_status():
|
||||||
|
"""This box's furtka-gateway connection + tunnel state.
|
||||||
|
|
||||||
|
No connection at all is the common case (most boxes never connect to a
|
||||||
|
gateway) — always 200s with connected=False rather than 404ing.
|
||||||
|
"""
|
||||||
|
from furtka import gateway, wireguard
|
||||||
|
|
||||||
|
config = gateway.load_config()
|
||||||
|
if config is None:
|
||||||
|
return 200, {"connected": False}
|
||||||
|
return 200, {
|
||||||
|
"connected": True,
|
||||||
|
"gateway_url": config["gateway_url"],
|
||||||
|
"box_id": config["box_id"],
|
||||||
|
"tunnel": wireguard.status(),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _do_gateway_connect(payload):
|
||||||
|
"""Kick off gateway registration + tunnel setup detached from this process.
|
||||||
|
|
||||||
|
Fast validation happens here so a bad request comes back as an
|
||||||
|
immediate 4xx. The slow part — a network call to a possibly slow or
|
||||||
|
unreachable gateway, then `systemctl enable --now wg-quick@...` — is
|
||||||
|
dispatched as a background systemd-run unit, the same idiom
|
||||||
|
_do_install uses for its docker-facing phase, so it can't tie up the
|
||||||
|
API thread. Client polls /api/gateway/connect/status.
|
||||||
|
|
||||||
|
Note: registration_token travels as a systemd-run argv entry, briefly
|
||||||
|
visible to anything on this box that can read `ps`/`systemctl show`
|
||||||
|
while the transient unit runs. Accepted here the same way furtka
|
||||||
|
already treats local-box access as a trusted boundary (see _do_power's
|
||||||
|
"anyone on the LAN can reboot" posture) — not something a home/single-
|
||||||
|
tenant box's threat model treats as a meaningful new exposure.
|
||||||
|
"""
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
from furtka import gateway
|
||||||
|
|
||||||
|
gateway_url = payload.get("gateway_url")
|
||||||
|
registration_token = payload.get("registration_token")
|
||||||
|
box_name = payload.get("box_name")
|
||||||
|
if not gateway_url or not registration_token or not box_name:
|
||||||
|
return 400, {"error": "gateway_url, registration_token, and box_name are all required"}
|
||||||
|
|
||||||
|
try:
|
||||||
|
fh = gateway.acquire_lock()
|
||||||
|
except gateway.GatewayError as e:
|
||||||
|
return 409, {"error": str(e)}
|
||||||
|
try:
|
||||||
|
# Initial state so the UI has something to show between this
|
||||||
|
# response and the background job's first write.
|
||||||
|
gateway.write_state("registering")
|
||||||
|
finally:
|
||||||
|
fh.close()
|
||||||
|
|
||||||
|
try:
|
||||||
|
subprocess.run(
|
||||||
|
[
|
||||||
|
"systemd-run",
|
||||||
|
"--unit=furtka-gateway-connect-api",
|
||||||
|
"--no-block",
|
||||||
|
"--collect",
|
||||||
|
"/usr/local/bin/furtka",
|
||||||
|
"gateway",
|
||||||
|
"connect-bg",
|
||||||
|
gateway_url,
|
||||||
|
registration_token,
|
||||||
|
box_name,
|
||||||
|
],
|
||||||
|
check=True,
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
)
|
||||||
|
except FileNotFoundError:
|
||||||
|
gateway.write_state("error", error="systemd-run not available")
|
||||||
|
return 502, {"error": "systemd-run not available"}
|
||||||
|
except subprocess.CalledProcessError as e:
|
||||||
|
err = (e.stderr or e.stdout or "").strip()
|
||||||
|
gateway.write_state("error", error=f"dispatch failed: {err}")
|
||||||
|
return 502, {"error": f"systemd-run failed: {err}"}
|
||||||
|
|
||||||
|
return 202, {"status": "dispatched", "unit": "furtka-gateway-connect-api"}
|
||||||
|
|
||||||
|
|
||||||
|
def _do_gateway_connect_status():
|
||||||
|
from furtka import gateway
|
||||||
|
|
||||||
|
return 200, gateway.read_state()
|
||||||
|
|
||||||
|
|
||||||
|
def _do_gateway_disconnect():
|
||||||
|
"""Tear down the tunnel and deregister from the gateway.
|
||||||
|
|
||||||
|
Synchronous — deregistering is one HTTP call plus a systemctl disable,
|
||||||
|
not a slow docker pull, so this doesn't need the async+poll dance
|
||||||
|
(same posture as _do_update_settings).
|
||||||
|
"""
|
||||||
|
from furtka import gateway, wireguard
|
||||||
|
|
||||||
|
if gateway.load_config() is None:
|
||||||
|
return 200, {"status": "not connected"}
|
||||||
|
try:
|
||||||
|
gateway.deregister()
|
||||||
|
except gateway.GatewayError as e:
|
||||||
|
return 502, {"error": str(e)}
|
||||||
|
try:
|
||||||
|
wireguard.set_tunnel_enabled(False)
|
||||||
|
except wireguard.WireguardError as e:
|
||||||
|
return 502, {"error": str(e)}
|
||||||
|
return 200, {"status": "disconnected"}
|
||||||
|
|
||||||
|
|
||||||
|
def _internet_routes() -> dict:
|
||||||
|
from furtka.paths import internet_routes_file
|
||||||
|
|
||||||
|
path = internet_routes_file()
|
||||||
|
if not path.is_file():
|
||||||
|
return {}
|
||||||
|
try:
|
||||||
|
return json.loads(path.read_text())
|
||||||
|
except json.JSONDecodeError:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
|
||||||
|
def _save_internet_routes(routes: dict) -> None:
|
||||||
|
from furtka.paths import internet_routes_file
|
||||||
|
|
||||||
|
path = internet_routes_file()
|
||||||
|
path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
tmp = path.with_suffix(path.suffix + ".tmp")
|
||||||
|
tmp.write_text(json.dumps(routes, indent=2))
|
||||||
|
tmp.chmod(0o600)
|
||||||
|
tmp.replace(path)
|
||||||
|
|
||||||
|
|
||||||
|
def _do_get_internet(name):
|
||||||
|
"""Current internet-exposure state for one installed app.
|
||||||
|
|
||||||
|
404s for apps that aren't installed or aren't internet.viable — the UI
|
||||||
|
only ever renders the toggle for viable, installed apps, so either
|
||||||
|
case means this request shouldn't have been made.
|
||||||
|
"""
|
||||||
|
m, _values, installed = _load_manifest_for(name)
|
||||||
|
if m is None or not installed:
|
||||||
|
return 404, {"error": f"{name!r} is not installed"}
|
||||||
|
if not m.internet.viable:
|
||||||
|
return 404, {"error": f"{name!r} is not internet-viable"}
|
||||||
|
entry = _internet_routes().get(name)
|
||||||
|
if entry is None:
|
||||||
|
return 200, {"enabled": False}
|
||||||
|
return 200, {"enabled": True, "public_url": entry.get("public_url")}
|
||||||
|
|
||||||
|
|
||||||
|
def _do_set_internet(name, payload):
|
||||||
|
"""Publish or unpublish an app through the connected gateway.
|
||||||
|
|
||||||
|
Synchronous — a plain HTTP call to the gateway's control plane, no
|
||||||
|
image pull involved, same posture as _do_update_settings, not the
|
||||||
|
async+poll pattern _do_gateway_connect needs.
|
||||||
|
"""
|
||||||
|
from furtka import gateway
|
||||||
|
|
||||||
|
enabled = payload.get("enabled")
|
||||||
|
if not isinstance(enabled, bool):
|
||||||
|
return 400, {"error": "'enabled' (bool) is required"}
|
||||||
|
|
||||||
|
m, _values, installed = _load_manifest_for(name)
|
||||||
|
if m is None or not installed:
|
||||||
|
return 404, {"error": f"{name!r} is not installed"}
|
||||||
|
if not m.internet.viable:
|
||||||
|
return 400, {"error": f"{name!r} is not internet-viable"}
|
||||||
|
|
||||||
|
if gateway.load_config() is None:
|
||||||
|
return 409, {"error": "this box is not connected to a gateway"}
|
||||||
|
|
||||||
|
routes = _internet_routes()
|
||||||
|
|
||||||
|
if enabled:
|
||||||
|
subdomain = payload.get("subdomain")
|
||||||
|
if not subdomain:
|
||||||
|
return 400, {"error": "'subdomain' is required to publish"}
|
||||||
|
try:
|
||||||
|
result = gateway.publish_route(name, subdomain, m.internet.port)
|
||||||
|
except gateway.GatewayError as e:
|
||||||
|
return 502, {"error": str(e)}
|
||||||
|
routes[name] = {"route_id": result["route_id"], "public_url": result["public_url"]}
|
||||||
|
_save_internet_routes(routes)
|
||||||
|
return 200, {"enabled": True, "public_url": result["public_url"]}
|
||||||
|
|
||||||
|
entry = routes.pop(name, None)
|
||||||
|
if entry is None:
|
||||||
|
return 200, {"enabled": False}
|
||||||
|
try:
|
||||||
|
gateway.unpublish_route(entry["route_id"])
|
||||||
|
except gateway.GatewayError as e:
|
||||||
|
return 502, {"error": str(e)}
|
||||||
|
_save_internet_routes(routes)
|
||||||
|
return 200, {"enabled": False}
|
||||||
|
|
||||||
|
|
||||||
_POWER_ACTIONS = {
|
_POWER_ACTIONS = {
|
||||||
"reboot": "reboot",
|
"reboot": "reboot",
|
||||||
"poweroff": "poweroff",
|
"poweroff": "poweroff",
|
||||||
|
|
@ -1238,7 +1551,33 @@ def _parse_settings_body(payload):
|
||||||
return out
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
# Largest request body we read. Every legitimate body is a small JSON
|
||||||
|
# object; without a cap a LAN client could make us buffer gigabytes.
|
||||||
|
MAX_BODY_BYTES = 1024 * 1024
|
||||||
|
|
||||||
|
# The server is threaded so status polls and page loads keep answering while
|
||||||
|
# a slow request (image pull, reconcile) runs. Requests that change state
|
||||||
|
# still run one at a time, as they did on the single-threaded server.
|
||||||
|
_MUTATION_LOCK = threading.Lock()
|
||||||
|
# First-run admin creation is check-then-write; two setup POSTs racing on
|
||||||
|
# the threaded server must not both create an admin.
|
||||||
|
_SETUP_LOCK = threading.Lock()
|
||||||
|
|
||||||
|
_USERS_FILE_BROKEN = (
|
||||||
|
"The login file on this box (/var/lib/furtka/users.json) is damaged. "
|
||||||
|
"Log in over SSH, delete that file, then reload this page to set a new admin password."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _valid_app_name(name) -> bool:
|
||||||
|
return isinstance(name, str) and APP_NAME_RE.fullmatch(name) is not None
|
||||||
|
|
||||||
|
|
||||||
class _Handler(BaseHTTPRequestHandler):
|
class _Handler(BaseHTTPRequestHandler):
|
||||||
|
# Socket read timeout: a client that stops sending mid-request gets
|
||||||
|
# dropped instead of holding a worker forever.
|
||||||
|
timeout = 30
|
||||||
|
|
||||||
def _json(self, status, payload, extra_headers=None):
|
def _json(self, status, payload, extra_headers=None):
|
||||||
body = json.dumps(payload).encode()
|
body = json.dumps(payload).encode()
|
||||||
self.send_response(status)
|
self.send_response(status)
|
||||||
|
|
@ -1347,6 +1686,14 @@ class _Handler(BaseHTTPRequestHandler):
|
||||||
return self._json(400, {"error": "password is required"})
|
return self._json(400, {"error": "password is required"})
|
||||||
username = username.strip()
|
username = username.strip()
|
||||||
|
|
||||||
|
try:
|
||||||
|
with _SETUP_LOCK:
|
||||||
|
return self._login_or_setup(payload, username, password)
|
||||||
|
except auth.UsersFileError:
|
||||||
|
traceback.print_exc()
|
||||||
|
return self._json(503, {"error": _USERS_FILE_BROKEN})
|
||||||
|
|
||||||
|
def _login_or_setup(self, payload, username, password):
|
||||||
if auth.setup_needed():
|
if auth.setup_needed():
|
||||||
# First-run setup path — create the admin account, then log
|
# First-run setup path — create the admin account, then log
|
||||||
# in. Require password2 so a typo doesn't lock the user out
|
# in. Require password2 so a typo doesn't lock the user out
|
||||||
|
|
@ -1393,13 +1740,39 @@ class _Handler(BaseHTTPRequestHandler):
|
||||||
auth.SESSIONS.revoke(morsel.value)
|
auth.SESSIONS.revoke(morsel.value)
|
||||||
return self._json(200, {"ok": True}, extra_headers=[self._clear_cookie_header()])
|
return self._json(200, {"ok": True}, extra_headers=[self._clear_cookie_header()])
|
||||||
|
|
||||||
|
def _internal_error(self):
|
||||||
|
# Without this, an unexpected exception makes socketserver drop the
|
||||||
|
# connection and the UI shows "Failed to fetch" with nothing to go on.
|
||||||
|
traceback.print_exc()
|
||||||
|
try:
|
||||||
|
self._json(500, {"error": "internal error — see `journalctl -u furtka-api`"})
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
|
||||||
def do_GET(self): # noqa: N802 — http.server convention
|
def do_GET(self): # noqa: N802 — http.server convention
|
||||||
|
try:
|
||||||
|
self._route_get()
|
||||||
|
except Exception:
|
||||||
|
self._internal_error()
|
||||||
|
|
||||||
|
def do_POST(self): # noqa: N802
|
||||||
|
try:
|
||||||
|
self._route_post()
|
||||||
|
except Exception:
|
||||||
|
self._internal_error()
|
||||||
|
|
||||||
|
def _route_get(self):
|
||||||
# --- Public routes: login page + its assets ------------------
|
# --- Public routes: login page + its assets ------------------
|
||||||
if self.path in ("/login", "/login/"):
|
if self.path in ("/login", "/login/"):
|
||||||
# Already authed? Skip straight to the app list.
|
# Already authed? Skip straight to the app list.
|
||||||
if self._current_session() is not None:
|
if self._current_session() is not None:
|
||||||
return self._redirect("/apps")
|
return self._redirect("/apps")
|
||||||
return self._html(200, _render_login_html(auth.setup_needed()))
|
try:
|
||||||
|
setup = auth.setup_needed()
|
||||||
|
except auth.UsersFileError:
|
||||||
|
traceback.print_exc()
|
||||||
|
return self._html(503, f"<h1>Login unavailable</h1><p>{_USERS_FILE_BROKEN}</p>")
|
||||||
|
return self._html(200, _render_login_html(setup))
|
||||||
|
|
||||||
# --- Auth guard for everything below -------------------------
|
# --- Auth guard for everything below -------------------------
|
||||||
session = self._current_session()
|
session = self._current_session()
|
||||||
|
|
@ -1444,17 +1817,42 @@ class _Handler(BaseHTTPRequestHandler):
|
||||||
if self.path == "/api/apps/install/status":
|
if self.path == "/api/apps/install/status":
|
||||||
status, body = _do_install_status()
|
status, body = _do_install_status()
|
||||||
return self._json(status, body)
|
return self._json(status, body)
|
||||||
|
if self.path == "/api/gateway/status":
|
||||||
|
status, body = _do_gateway_status()
|
||||||
|
return self._json(status, body)
|
||||||
|
if self.path == "/api/gateway/connect/status":
|
||||||
|
status, body = _do_gateway_connect_status()
|
||||||
|
return self._json(status, body)
|
||||||
# /api/apps/<name>/settings
|
# /api/apps/<name>/settings
|
||||||
if self.path.startswith("/api/apps/") and self.path.endswith("/settings"):
|
if self.path.startswith("/api/apps/") and self.path.endswith("/settings"):
|
||||||
name = self.path[len("/api/apps/") : -len("/settings")]
|
name = self.path[len("/api/apps/") : -len("/settings")]
|
||||||
if "/" in name or not name:
|
if not _valid_app_name(name):
|
||||||
return self._json(400, {"error": "invalid app name"})
|
return self._json(400, {"error": "invalid app name"})
|
||||||
status, body = _do_get_settings(name)
|
status, body = _do_get_settings(name)
|
||||||
return self._json(status, body)
|
return self._json(status, body)
|
||||||
|
# /api/apps/<name>/internet
|
||||||
|
if self.path.startswith("/api/apps/") and self.path.endswith("/internet"):
|
||||||
|
name = self.path[len("/api/apps/") : -len("/internet")]
|
||||||
|
if "/" in name or not name:
|
||||||
|
return self._json(400, {"error": "invalid app name"})
|
||||||
|
status, body = _do_get_internet(name)
|
||||||
|
return self._json(status, body)
|
||||||
self._json(404, {"error": "not found"})
|
self._json(404, {"error": "not found"})
|
||||||
|
|
||||||
def do_POST(self): # noqa: N802
|
def _route_post(self):
|
||||||
|
# Browsers tag every request with where it came from. Only accept
|
||||||
|
# state changes from our own pages — an app on another port of the
|
||||||
|
# same host counts as "same-site" and would pass SameSite=Strict.
|
||||||
|
# Old browsers that don't send the header fall back to the cookie.
|
||||||
|
fetch_site = self.headers.get("Sec-Fetch-Site")
|
||||||
|
if fetch_site is not None and fetch_site not in ("same-origin", "none"):
|
||||||
|
return self._json(403, {"error": "cross-site request refused"})
|
||||||
|
try:
|
||||||
length = int(self.headers.get("Content-Length", "0"))
|
length = int(self.headers.get("Content-Length", "0"))
|
||||||
|
except ValueError:
|
||||||
|
return self._json(400, {"error": "invalid Content-Length"})
|
||||||
|
if length < 0 or length > MAX_BODY_BYTES:
|
||||||
|
return self._json(413, {"error": "request body too large"})
|
||||||
raw = self.rfile.read(length) if length else b""
|
raw = self.rfile.read(length) if length else b""
|
||||||
try:
|
try:
|
||||||
payload = json.loads(raw.decode()) if raw else {}
|
payload = json.loads(raw.decode()) if raw else {}
|
||||||
|
|
@ -1473,10 +1871,15 @@ class _Handler(BaseHTTPRequestHandler):
|
||||||
if self._current_session() is None:
|
if self._current_session() is None:
|
||||||
return self._json(401, {"error": "not authenticated"})
|
return self._json(401, {"error": "not authenticated"})
|
||||||
|
|
||||||
|
with _MUTATION_LOCK:
|
||||||
|
return self._route_authed_post(payload)
|
||||||
|
|
||||||
|
def _route_authed_post(self, payload):
|
||||||
|
|
||||||
# Per-app settings update: /api/apps/<name>/settings
|
# Per-app settings update: /api/apps/<name>/settings
|
||||||
if self.path.startswith("/api/apps/") and self.path.endswith("/settings"):
|
if self.path.startswith("/api/apps/") and self.path.endswith("/settings"):
|
||||||
name = self.path[len("/api/apps/") : -len("/settings")]
|
name = self.path[len("/api/apps/") : -len("/settings")]
|
||||||
if "/" in name or not name:
|
if not _valid_app_name(name):
|
||||||
return self._json(400, {"error": "invalid app name"})
|
return self._json(400, {"error": "invalid app name"})
|
||||||
settings = _parse_settings_body(payload)
|
settings = _parse_settings_body(payload)
|
||||||
if settings is False or settings is None:
|
if settings is False or settings is None:
|
||||||
|
|
@ -1487,11 +1890,27 @@ class _Handler(BaseHTTPRequestHandler):
|
||||||
# Per-app image update: /api/apps/<name>/update
|
# Per-app image update: /api/apps/<name>/update
|
||||||
if self.path.startswith("/api/apps/") and self.path.endswith("/update"):
|
if self.path.startswith("/api/apps/") and self.path.endswith("/update"):
|
||||||
name = self.path[len("/api/apps/") : -len("/update")]
|
name = self.path[len("/api/apps/") : -len("/update")]
|
||||||
if "/" in name or not name:
|
if not _valid_app_name(name):
|
||||||
return self._json(400, {"error": "invalid app name"})
|
return self._json(400, {"error": "invalid app name"})
|
||||||
status, body = _do_update(name)
|
status, body = _do_update(name)
|
||||||
return self._json(status, body)
|
return self._json(status, body)
|
||||||
|
|
||||||
|
# Per-app internet-exposure toggle: /api/apps/<name>/internet
|
||||||
|
if self.path.startswith("/api/apps/") and self.path.endswith("/internet"):
|
||||||
|
name = self.path[len("/api/apps/") : -len("/internet")]
|
||||||
|
if "/" in name or not name:
|
||||||
|
return self._json(400, {"error": "invalid app name"})
|
||||||
|
status, body = _do_set_internet(name, payload)
|
||||||
|
return self._json(status, body)
|
||||||
|
|
||||||
|
# This box's furtka-gateway connection: connect / disconnect.
|
||||||
|
if self.path == "/api/gateway/connect":
|
||||||
|
status, body = _do_gateway_connect(payload)
|
||||||
|
return self._json(status, body)
|
||||||
|
if self.path == "/api/gateway/disconnect":
|
||||||
|
status, body = _do_gateway_disconnect()
|
||||||
|
return self._json(status, body)
|
||||||
|
|
||||||
# Furtka itself: check + apply endpoints (Phase 2 self-update).
|
# Furtka itself: check + apply endpoints (Phase 2 self-update).
|
||||||
if self.path == "/api/furtka/update/check":
|
if self.path == "/api/furtka/update/check":
|
||||||
status, body = _do_furtka_check()
|
status, body = _do_furtka_check()
|
||||||
|
|
@ -1519,6 +1938,8 @@ class _Handler(BaseHTTPRequestHandler):
|
||||||
name = payload.get("name")
|
name = payload.get("name")
|
||||||
if not isinstance(name, str) or not name:
|
if not isinstance(name, str) or not name:
|
||||||
return self._json(400, {"error": "missing or empty 'name' field"})
|
return self._json(400, {"error": "missing or empty 'name' field"})
|
||||||
|
if not _valid_app_name(name):
|
||||||
|
return self._json(400, {"error": "invalid app name"})
|
||||||
|
|
||||||
if self.path == "/api/apps/install/plan":
|
if self.path == "/api/apps/install/plan":
|
||||||
status, body = _do_install_plan(name)
|
status, body = _do_install_plan(name)
|
||||||
|
|
@ -1541,7 +1962,8 @@ class _Handler(BaseHTTPRequestHandler):
|
||||||
|
|
||||||
def serve(host: str = "127.0.0.1", port: int = 7000) -> None:
|
def serve(host: str = "127.0.0.1", port: int = 7000) -> None:
|
||||||
"""Run the API server. Blocks forever; exits on SIGINT/SIGTERM."""
|
"""Run the API server. Blocks forever; exits on SIGINT/SIGTERM."""
|
||||||
server = HTTPServer((host, port), _Handler)
|
server = ThreadingHTTPServer((host, port), _Handler)
|
||||||
|
server.daemon_threads = True
|
||||||
print(f"Furtka API listening on http://{host}:{port}/")
|
print(f"Furtka API listening on http://{host}:{port}/")
|
||||||
try:
|
try:
|
||||||
server.serve_forever()
|
server.serve_forever()
|
||||||
|
|
|
||||||
|
|
@ -23,6 +23,7 @@ from __future__ import annotations
|
||||||
|
|
||||||
import json
|
import json
|
||||||
import math
|
import math
|
||||||
|
import os
|
||||||
import secrets
|
import secrets
|
||||||
import threading
|
import threading
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
|
|
@ -46,27 +47,33 @@ def verify_password(plain: str, hashed: str) -> bool:
|
||||||
return _verify_password(plain, hashed)
|
return _verify_password(plain, hashed)
|
||||||
|
|
||||||
|
|
||||||
|
class UsersFileError(RuntimeError):
|
||||||
|
"""users.json exists but can't be read or parsed."""
|
||||||
|
|
||||||
|
|
||||||
def load_users() -> dict:
|
def load_users() -> dict:
|
||||||
"""Return the users dict, or {} if the file is missing or empty.
|
"""Return the users dict, or {} if the file is missing.
|
||||||
|
|
||||||
Missing-file is the expected state on first boot and on upgrades from
|
Missing-file is the expected state on first boot and on upgrades from
|
||||||
pre-auth versions — callers treat empty-dict as "setup required".
|
pre-auth versions — callers treat empty-dict as "setup required".
|
||||||
|
|
||||||
|
A file that exists but is unreadable, empty or corrupt raises
|
||||||
|
UsersFileError instead: treating it as "no admin yet" would turn /login
|
||||||
|
into an open "create admin" form for anyone on the network.
|
||||||
"""
|
"""
|
||||||
path = users_file()
|
path = users_file()
|
||||||
if not path.exists():
|
|
||||||
return {}
|
|
||||||
try:
|
try:
|
||||||
raw = path.read_text()
|
raw = path.read_text()
|
||||||
except OSError:
|
except FileNotFoundError:
|
||||||
return {}
|
|
||||||
if not raw.strip():
|
|
||||||
return {}
|
return {}
|
||||||
|
except (OSError, UnicodeDecodeError) as e:
|
||||||
|
raise UsersFileError(f"{path} is unreadable: {e}") from e
|
||||||
try:
|
try:
|
||||||
data = json.loads(raw)
|
data = json.loads(raw)
|
||||||
except json.JSONDecodeError:
|
except json.JSONDecodeError as e:
|
||||||
return {}
|
raise UsersFileError(f"{path} is corrupt: {e}") from e
|
||||||
if not isinstance(data, dict):
|
if not isinstance(data, dict):
|
||||||
return {}
|
raise UsersFileError(f"{path} is corrupt: not a JSON object")
|
||||||
return data
|
return data
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -80,7 +87,12 @@ def save_users(users: dict) -> None:
|
||||||
path = users_file()
|
path = users_file()
|
||||||
path.parent.mkdir(parents=True, exist_ok=True)
|
path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
tmp = path.with_suffix(path.suffix + ".tmp")
|
tmp = path.with_suffix(path.suffix + ".tmp")
|
||||||
tmp.write_text(json.dumps(users, indent=2) + "\n")
|
with open(tmp, "w") as fh:
|
||||||
|
fh.write(json.dumps(users, indent=2) + "\n")
|
||||||
|
# A power cut right after rename() can otherwise leave a zero-length
|
||||||
|
# users.json, which load_users() refuses — locking the owner out.
|
||||||
|
fh.flush()
|
||||||
|
os.fsync(fh.fileno())
|
||||||
tmp.chmod(0o600)
|
tmp.chmod(0o600)
|
||||||
tmp.replace(path)
|
tmp.replace(path)
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -34,6 +34,7 @@ from __future__ import annotations
|
||||||
import fcntl
|
import fcntl
|
||||||
import json
|
import json
|
||||||
import os
|
import os
|
||||||
|
import re
|
||||||
import shutil
|
import shutil
|
||||||
import time
|
import time
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
|
|
@ -150,6 +151,9 @@ def acquire_lock():
|
||||||
return fh
|
return fh
|
||||||
|
|
||||||
|
|
||||||
|
_PRIVILEGED_RE = re.compile(r"^\s*privileged:\s*true\s*$", re.MULTILINE)
|
||||||
|
|
||||||
|
|
||||||
def _validate_staging(staging: Path, expected_version: str) -> None:
|
def _validate_staging(staging: Path, expected_version: str) -> None:
|
||||||
"""Fail hard if the staging tree isn't a well-formed catalog release."""
|
"""Fail hard if the staging tree isn't a well-formed catalog release."""
|
||||||
version_file = staging / _VERSION_FILE
|
version_file = staging / _VERSION_FILE
|
||||||
|
|
@ -170,10 +174,23 @@ def _validate_staging(staging: Path, expected_version: str) -> None:
|
||||||
if not manifest_path.exists():
|
if not manifest_path.exists():
|
||||||
raise CatalogError(f"catalog app {entry.name!r} has no manifest.json")
|
raise CatalogError(f"catalog app {entry.name!r} has no manifest.json")
|
||||||
try:
|
try:
|
||||||
load_manifest(manifest_path, expected_name=entry.name)
|
manifest = load_manifest(manifest_path, expected_name=entry.name)
|
||||||
except ManifestError as e:
|
except ManifestError as e:
|
||||||
raise CatalogError(f"catalog app {entry.name!r}: invalid manifest: {e}") from e
|
raise CatalogError(f"catalog app {entry.name!r}: invalid manifest: {e}") from e
|
||||||
|
|
||||||
|
if manifest.internet.viable:
|
||||||
|
compose_path = entry / "docker-compose.yaml"
|
||||||
|
if compose_path.exists() and _PRIVILEGED_RE.search(compose_path.read_text()):
|
||||||
|
# Not a network-mode check — Traefik reaches a host-networked
|
||||||
|
# container's port exactly like a bridge-published one. The
|
||||||
|
# real risk of `internet.viable: true` here is a compromised
|
||||||
|
# internet-facing container also having host device/kernel
|
||||||
|
# access, which `privileged: true` grants outright.
|
||||||
|
raise CatalogError(
|
||||||
|
f"catalog app {entry.name!r}: internet.viable apps must not run "
|
||||||
|
"privileged (docker-compose.yaml sets privileged: true)"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _atomic_swap(staging: Path) -> None:
|
def _atomic_swap(staging: Path) -> None:
|
||||||
"""Move staging → live catalog, keeping the previous tree as .prev until
|
"""Move staging → live catalog, keeping the previous tree as .prev until
|
||||||
|
|
@ -216,6 +233,9 @@ def sync_catalog() -> CatalogCheck:
|
||||||
except CatalogError as e:
|
except CatalogError as e:
|
||||||
write_state("error", error=str(e))
|
write_state("error", error=str(e))
|
||||||
raise
|
raise
|
||||||
|
except Exception as e:
|
||||||
|
write_state("error", error=str(e) or type(e).__name__)
|
||||||
|
raise CatalogError(str(e) or type(e).__name__) from e
|
||||||
|
|
||||||
|
|
||||||
def _sync_locked() -> CatalogCheck:
|
def _sync_locked() -> CatalogCheck:
|
||||||
|
|
|
||||||
|
|
@ -46,6 +46,10 @@ def _cmd_app_list(args: argparse.Namespace) -> int:
|
||||||
}
|
}
|
||||||
for req in r.manifest.requires
|
for req in r.manifest.requires
|
||||||
],
|
],
|
||||||
|
"internet": {
|
||||||
|
"viable": r.manifest.internet.viable,
|
||||||
|
"port": r.manifest.internet.port,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
if r.manifest
|
if r.manifest
|
||||||
else None,
|
else None,
|
||||||
|
|
@ -171,6 +175,25 @@ def _cmd_app_remove(args: argparse.Namespace) -> int:
|
||||||
return 0
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def _cmd_gateway_connect_bg(args: argparse.Namespace) -> int:
|
||||||
|
"""Register + bring up the tunnel — called by the API via systemd-run.
|
||||||
|
|
||||||
|
Internal subcommand; the UI drives this through
|
||||||
|
`POST /api/gateway/connect`, which does fast input validation
|
||||||
|
synchronously and dispatches this the same way `app install` dispatches
|
||||||
|
`app install-bg`.
|
||||||
|
"""
|
||||||
|
from furtka import gateway
|
||||||
|
|
||||||
|
try:
|
||||||
|
gateway.run_connect(args.gateway_url, args.registration_token, args.box_name)
|
||||||
|
except Exception as e:
|
||||||
|
# run_connect already wrote state="error"; echo for journald.
|
||||||
|
print(f"gateway connect-bg failed: {e}", file=sys.stderr)
|
||||||
|
return 1
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
def _cmd_serve(args: argparse.Namespace) -> int:
|
def _cmd_serve(args: argparse.Namespace) -> int:
|
||||||
# Imported lazily so `furtka` startup stays cheap when the user only runs
|
# Imported lazily so `furtka` startup stays cheap when the user only runs
|
||||||
# `app list` or `reconcile` (the common case during tests + scripts).
|
# `app list` or `reconcile` (the common case during tests + scripts).
|
||||||
|
|
@ -399,6 +422,20 @@ def build_parser() -> argparse.ArgumentParser:
|
||||||
)
|
)
|
||||||
catalog_status.set_defaults(func=_cmd_catalog_status)
|
catalog_status.set_defaults(func=_cmd_catalog_status)
|
||||||
|
|
||||||
|
gateway = sub.add_parser("gateway", help="Manage this box's furtka-gateway connection")
|
||||||
|
gateway_sub = gateway.add_subparsers(dest="subcommand", required=True)
|
||||||
|
|
||||||
|
# Internal — called by the HTTP API via systemd-run. Deliberately
|
||||||
|
# omitted from the help listing, same as `app install-bg`.
|
||||||
|
gateway_connect_bg = gateway_sub.add_parser(
|
||||||
|
"connect-bg",
|
||||||
|
help=argparse.SUPPRESS,
|
||||||
|
)
|
||||||
|
gateway_connect_bg.add_argument("gateway_url")
|
||||||
|
gateway_connect_bg.add_argument("registration_token")
|
||||||
|
gateway_connect_bg.add_argument("box_name")
|
||||||
|
gateway_connect_bg.set_defaults(func=_cmd_gateway_connect_bg)
|
||||||
|
|
||||||
return p
|
return p
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
246
furtka/gateway.py
Normal file
|
|
@ -0,0 +1,246 @@
|
||||||
|
"""Client for a Furtka box registering with (and talking to) a
|
||||||
|
furtka-gateway.
|
||||||
|
|
||||||
|
Talks to the gateway's `/v1/boxes/*` API (see the furtka-gateway repo's
|
||||||
|
`control_plane/api.py` for the server side) using the same stdlib-only
|
||||||
|
`urllib.request` convention as `_release_common.py`/`updater.py` — no new
|
||||||
|
dependency for this.
|
||||||
|
|
||||||
|
`register()` persists the result to `paths.gateway_config_file()` (0600,
|
||||||
|
atomic write — the same tmp-file-then-replace pattern `auth.save_users`
|
||||||
|
uses) so later calls don't need the box to re-register, and so
|
||||||
|
`/api/gateway/status` has something to read without holding a live
|
||||||
|
connection open.
|
||||||
|
|
||||||
|
`run_connect()` plus the state/lock helpers below follow the exact shape
|
||||||
|
of furtka.catalog's own state/lock functions — this module is the
|
||||||
|
"runner" `furtka gateway connect-bg` calls after `api.py`'s
|
||||||
|
`POST /api/gateway/connect` dispatches it via systemd-run, the same
|
||||||
|
async-with-state-file-polling idiom used for install/update/catalog-sync.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import fcntl
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
import time
|
||||||
|
import urllib.error
|
||||||
|
import urllib.request
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from furtka import wireguard
|
||||||
|
from furtka.paths import gateway_config_file
|
||||||
|
|
||||||
|
_CONNECT_STATE = Path(
|
||||||
|
os.environ.get("FURTKA_GATEWAY_CONNECT_STATE", "/var/lib/furtka/gateway-connect-state.json")
|
||||||
|
)
|
||||||
|
_CONNECT_LOCK = Path(
|
||||||
|
os.environ.get("FURTKA_GATEWAY_CONNECT_LOCK", "/run/furtka/gateway-connect.lock")
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class GatewayError(Exception):
|
||||||
|
"""Recoverable failure talking to a furtka-gateway — the caller should 5xx."""
|
||||||
|
|
||||||
|
|
||||||
|
def _request(method: str, url: str, body: dict | None = None, *, token: str | None = None) -> dict:
|
||||||
|
data = json.dumps(body).encode() if body is not None else None
|
||||||
|
headers = {}
|
||||||
|
if data is not None:
|
||||||
|
headers["Content-Type"] = "application/json"
|
||||||
|
if token:
|
||||||
|
headers["Authorization"] = f"Bearer {token}"
|
||||||
|
req = urllib.request.Request(url, data=data, headers=headers, method=method)
|
||||||
|
try:
|
||||||
|
with urllib.request.urlopen(req, timeout=15) as resp:
|
||||||
|
return json.loads(resp.read())
|
||||||
|
except urllib.error.HTTPError as e:
|
||||||
|
detail = e.read().decode(errors="replace")
|
||||||
|
raise GatewayError(f"{method} {url} -> HTTP {e.code}: {detail}") from e
|
||||||
|
except urllib.error.URLError as e:
|
||||||
|
raise GatewayError(f"{method} {url}: {e}") from e
|
||||||
|
|
||||||
|
|
||||||
|
def _post(url: str, body: dict, *, token: str | None = None) -> dict:
|
||||||
|
return _request("POST", url, body, token=token)
|
||||||
|
|
||||||
|
|
||||||
|
def _delete(url: str, *, token: str | None = None) -> dict:
|
||||||
|
return _request("DELETE", url, token=token)
|
||||||
|
|
||||||
|
|
||||||
|
def _save_config(config: dict) -> None:
|
||||||
|
path = gateway_config_file()
|
||||||
|
path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
tmp = path.with_suffix(path.suffix + ".tmp")
|
||||||
|
tmp.write_text(json.dumps(config, indent=2) + "\n")
|
||||||
|
tmp.chmod(0o600)
|
||||||
|
tmp.replace(path)
|
||||||
|
|
||||||
|
|
||||||
|
def load_config() -> dict | None:
|
||||||
|
"""Return the persisted {gateway_url, box_id, box_token, wg} config, or
|
||||||
|
None if this box has never registered with a gateway."""
|
||||||
|
path = gateway_config_file()
|
||||||
|
if not path.is_file():
|
||||||
|
return None
|
||||||
|
return json.loads(path.read_text())
|
||||||
|
|
||||||
|
|
||||||
|
def register(gateway_url: str, registration_token: str, box_name: str) -> dict:
|
||||||
|
"""Register this box with a furtka-gateway.
|
||||||
|
|
||||||
|
No local keypair is generated here — the gateway's response carries the
|
||||||
|
full WireGuard interface config, private key included (see
|
||||||
|
furtka-gateway's `wgeasy.py` module docstring for why stock wg-easy
|
||||||
|
makes that unavoidable). Persists and returns
|
||||||
|
{gateway_url, box_id, box_token, wg}.
|
||||||
|
"""
|
||||||
|
gateway_url = gateway_url.rstrip("/")
|
||||||
|
result = _post(
|
||||||
|
f"{gateway_url}/v1/boxes/register",
|
||||||
|
{"registration_token": registration_token, "box_name": box_name},
|
||||||
|
)
|
||||||
|
config = {
|
||||||
|
"gateway_url": gateway_url,
|
||||||
|
"box_id": result["box_id"],
|
||||||
|
"box_token": result["box_token"],
|
||||||
|
"wg": result["wg"],
|
||||||
|
}
|
||||||
|
_save_config(config)
|
||||||
|
return config
|
||||||
|
|
||||||
|
|
||||||
|
def rotate_token() -> str:
|
||||||
|
"""Ask the gateway for a new box token, replacing the stored one."""
|
||||||
|
config = load_config()
|
||||||
|
if config is None:
|
||||||
|
raise GatewayError("not connected to a gateway")
|
||||||
|
result = _post(
|
||||||
|
f"{config['gateway_url']}/v1/boxes/{config['box_id']}/rotate-token",
|
||||||
|
{},
|
||||||
|
token=config["box_token"],
|
||||||
|
)
|
||||||
|
config["box_token"] = result["box_token"]
|
||||||
|
_save_config(config)
|
||||||
|
return config["box_token"]
|
||||||
|
|
||||||
|
|
||||||
|
def deregister() -> None:
|
||||||
|
"""Tell the gateway to forget this box, then drop the local config.
|
||||||
|
|
||||||
|
Raises on a failed gateway call rather than silently clearing local
|
||||||
|
state — a box that can't reach the gateway should stay "connected"
|
||||||
|
locally so the operation can be retried, instead of losing its
|
||||||
|
box_token while the gateway's own row (and the wg-easy peer / any
|
||||||
|
published routes) linger orphaned.
|
||||||
|
"""
|
||||||
|
config = load_config()
|
||||||
|
if config is None:
|
||||||
|
return
|
||||||
|
_post(
|
||||||
|
f"{config['gateway_url']}/v1/boxes/{config['box_id']}/deregister",
|
||||||
|
{},
|
||||||
|
token=config["box_token"],
|
||||||
|
)
|
||||||
|
gateway_config_file().unlink(missing_ok=True)
|
||||||
|
|
||||||
|
|
||||||
|
def publish_route(app_name: str, subdomain: str, port: int) -> dict:
|
||||||
|
"""Publish `app_name` at `subdomain` through the connected gateway.
|
||||||
|
|
||||||
|
Returns {route_id, public_url}. The gateway independently re-validates
|
||||||
|
subdomain/port server-side regardless of what's sent here — see
|
||||||
|
furtka-gateway's routes.py — this call just carries the box owner's
|
||||||
|
request, it isn't itself the security boundary.
|
||||||
|
"""
|
||||||
|
config = load_config()
|
||||||
|
if config is None:
|
||||||
|
raise GatewayError("not connected to a gateway")
|
||||||
|
return _post(
|
||||||
|
f"{config['gateway_url']}/v1/routes",
|
||||||
|
{"app_name": app_name, "subdomain": subdomain, "port": port},
|
||||||
|
token=config["box_token"],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def unpublish_route(route_id: str) -> None:
|
||||||
|
config = load_config()
|
||||||
|
if config is None:
|
||||||
|
raise GatewayError("not connected to a gateway")
|
||||||
|
_delete(f"{config['gateway_url']}/v1/routes/{route_id}", token=config["box_token"])
|
||||||
|
|
||||||
|
|
||||||
|
def state_path() -> Path:
|
||||||
|
return _CONNECT_STATE
|
||||||
|
|
||||||
|
|
||||||
|
def lock_path() -> Path:
|
||||||
|
return _CONNECT_LOCK
|
||||||
|
|
||||||
|
|
||||||
|
def write_state(stage: str, **extra) -> None:
|
||||||
|
"""Atomic JSON state write — same shape as catalog/update-state."""
|
||||||
|
state_path().parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
tmp = state_path().with_suffix(".tmp")
|
||||||
|
payload = {"stage": stage, "updated_at": time.strftime("%Y-%m-%dT%H:%M:%S%z"), **extra}
|
||||||
|
tmp.write_text(json.dumps(payload, indent=2))
|
||||||
|
tmp.replace(state_path())
|
||||||
|
|
||||||
|
|
||||||
|
def read_state() -> dict:
|
||||||
|
try:
|
||||||
|
return json.loads(state_path().read_text())
|
||||||
|
except (FileNotFoundError, json.JSONDecodeError):
|
||||||
|
return {}
|
||||||
|
|
||||||
|
|
||||||
|
def acquire_lock():
|
||||||
|
path = lock_path()
|
||||||
|
path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
fh = path.open("w")
|
||||||
|
try:
|
||||||
|
fcntl.flock(fh, fcntl.LOCK_EX | fcntl.LOCK_NB)
|
||||||
|
except BlockingIOError as e:
|
||||||
|
fh.close()
|
||||||
|
raise GatewayError("another gateway connect is already in progress") from e
|
||||||
|
return fh
|
||||||
|
|
||||||
|
|
||||||
|
def run_connect(gateway_url: str, registration_token: str, box_name: str) -> None:
|
||||||
|
"""Register with the gateway, then bring the tunnel up — the slow part
|
||||||
|
`furtka gateway connect-bg` runs in the background (dispatched via
|
||||||
|
systemd-run from `POST /api/gateway/connect`), writing state
|
||||||
|
transitions as it goes so the UI can poll instead of the request
|
||||||
|
thread blocking on a slow/unreachable gateway.
|
||||||
|
|
||||||
|
A registration saved by an earlier attempt whose tunnel failed to come
|
||||||
|
up is reused rather than registering again — re-registering would leave
|
||||||
|
the first box (and its wg-easy peer) orphaned on the gateway.
|
||||||
|
"""
|
||||||
|
existing = load_config()
|
||||||
|
if existing is not None:
|
||||||
|
if existing["gateway_url"] != gateway_url.rstrip("/"):
|
||||||
|
write_state(
|
||||||
|
"error",
|
||||||
|
error=f"already registered with {existing['gateway_url']} — disconnect first",
|
||||||
|
)
|
||||||
|
return
|
||||||
|
config = existing
|
||||||
|
else:
|
||||||
|
write_state("registering")
|
||||||
|
try:
|
||||||
|
config = register(gateway_url, registration_token, box_name)
|
||||||
|
except GatewayError as e:
|
||||||
|
write_state("error", error=str(e))
|
||||||
|
return
|
||||||
|
|
||||||
|
write_state("starting_tunnel")
|
||||||
|
try:
|
||||||
|
wireguard.set_tunnel_enabled(True, wg=config["wg"])
|
||||||
|
except wireguard.WireguardError as e:
|
||||||
|
write_state("error", error=str(e))
|
||||||
|
return
|
||||||
|
|
||||||
|
write_state("done")
|
||||||
|
|
@ -36,7 +36,11 @@ from pathlib import Path
|
||||||
CA_CERT_PATH = Path("/var/lib/caddy/pki/authorities/local/root.crt")
|
CA_CERT_PATH = Path("/var/lib/caddy/pki/authorities/local/root.crt")
|
||||||
SNIPPET_DIR = Path("/etc/caddy/furtka.d")
|
SNIPPET_DIR = Path("/etc/caddy/furtka.d")
|
||||||
REDIRECT_SNIPPET = SNIPPET_DIR / "redirect.caddyfile"
|
REDIRECT_SNIPPET = SNIPPET_DIR / "redirect.caddyfile"
|
||||||
REDIRECT_CONTENT = "redir https://{host}{uri} permanent\n"
|
# Pre-26.21 redirect: permanent (browsers cache a 301 indefinitely, so
|
||||||
|
# turning HTTPS off left them bouncing to a dead :443) and for every Host —
|
||||||
|
# including a bare IP, which has no certificate, so devices that reach the
|
||||||
|
# box by IP (no mDNS on Android / older Windows) couldn't load the UI at all.
|
||||||
|
LEGACY_REDIRECT_CONTENT = "redir https://{host}{uri} permanent\n"
|
||||||
HTTPS_SNIPPET_DIR = Path("/etc/caddy/furtka-https.d")
|
HTTPS_SNIPPET_DIR = Path("/etc/caddy/furtka-https.d")
|
||||||
HTTPS_SNIPPET = HTTPS_SNIPPET_DIR / "https.caddyfile"
|
HTTPS_SNIPPET = HTTPS_SNIPPET_DIR / "https.caddyfile"
|
||||||
HOSTNAME_FILE = Path("/etc/hostname")
|
HOSTNAME_FILE = Path("/etc/hostname")
|
||||||
|
|
@ -62,6 +66,19 @@ def _read_hostname(hostname_file: Path = HOSTNAME_FILE) -> str:
|
||||||
return value or "furtka"
|
return value or "furtka"
|
||||||
|
|
||||||
|
|
||||||
|
def _redirect_snippet_content(hostname: str) -> str:
|
||||||
|
"""HTTP→HTTPS redirect for the names the HTTPS block has a cert for.
|
||||||
|
|
||||||
|
Only those hosts are redirected: an IP or any other name keeps plain
|
||||||
|
HTTP instead of landing on a TLS handshake that can't succeed. 302 so
|
||||||
|
switching HTTPS off takes effect in browsers immediately.
|
||||||
|
"""
|
||||||
|
return (
|
||||||
|
f"@furtka_https_host host {hostname}.local {hostname}\n"
|
||||||
|
"redir @furtka_https_host https://{host}{uri} 302\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _https_snippet_content(hostname: str) -> str:
|
def _https_snippet_content(hostname: str) -> str:
|
||||||
"""Caddy site block the HTTPS toggle installs at opt-in.
|
"""Caddy site block the HTTPS toggle installs at opt-in.
|
||||||
|
|
||||||
|
|
@ -151,8 +168,9 @@ def set_force_https(
|
||||||
previous_https = https_snippet.read_text() if had_https else None
|
previous_https = https_snippet.read_text() if had_https else None
|
||||||
|
|
||||||
if enabled:
|
if enabled:
|
||||||
snippet.write_text(REDIRECT_CONTENT)
|
hostname = _read_hostname(hostname_file)
|
||||||
https_snippet.write_text(_https_snippet_content(_read_hostname(hostname_file)))
|
snippet.write_text(_redirect_snippet_content(hostname))
|
||||||
|
https_snippet.write_text(_https_snippet_content(hostname))
|
||||||
else:
|
else:
|
||||||
if had_redirect:
|
if had_redirect:
|
||||||
snippet.unlink()
|
snippet.unlink()
|
||||||
|
|
|
||||||
|
|
@ -91,9 +91,53 @@ def write_state(stage: str, **extra) -> None:
|
||||||
|
|
||||||
def read_state() -> dict:
|
def read_state() -> dict:
|
||||||
try:
|
try:
|
||||||
return json.loads(state_path().read_text())
|
data = json.loads(state_path().read_text())
|
||||||
except (FileNotFoundError, json.JSONDecodeError):
|
except (OSError, UnicodeDecodeError, json.JSONDecodeError):
|
||||||
return {}
|
return {}
|
||||||
|
return data if isinstance(data, dict) else {}
|
||||||
|
|
||||||
|
|
||||||
|
TERMINAL_STAGES = frozenset({"done", "error"})
|
||||||
|
|
||||||
|
# How old an unfinished state must be before we believe the job is gone.
|
||||||
|
# Covers the gap between the API writing the first stage and the detached
|
||||||
|
# runner taking the lock.
|
||||||
|
_STALE_AFTER_SECONDS = 60
|
||||||
|
|
||||||
|
|
||||||
|
def clear_stale_state(now: float | None = None) -> bool:
|
||||||
|
"""Mark an unfinished install as failed if no runner is alive any more.
|
||||||
|
|
||||||
|
install-state.json lives in /var/lib and survives reboots, OOM kills and
|
||||||
|
a runner that never started — each of which used to block every later
|
||||||
|
install with "another install is in progress" until someone fixed it
|
||||||
|
over SSH. The runner holds the flock for its whole run, so a free lock
|
||||||
|
plus an old timestamp means nobody is coming back to finish. Returns
|
||||||
|
True when it reset the state.
|
||||||
|
"""
|
||||||
|
state = read_state()
|
||||||
|
stage = state.get("stage", "")
|
||||||
|
if not stage or stage in TERMINAL_STAGES:
|
||||||
|
return False
|
||||||
|
try:
|
||||||
|
updated = time.mktime(time.strptime(state.get("updated_at", ""), "%Y-%m-%dT%H:%M:%S%z"))
|
||||||
|
except (TypeError, ValueError):
|
||||||
|
updated = 0.0
|
||||||
|
if (now if now is not None else time.time()) - updated < _STALE_AFTER_SECONDS:
|
||||||
|
return False
|
||||||
|
try:
|
||||||
|
fh = acquire_lock()
|
||||||
|
except (InstallRunnerError, OSError):
|
||||||
|
return False # a runner is still working
|
||||||
|
try:
|
||||||
|
write_state(
|
||||||
|
"error",
|
||||||
|
app=state.get("app", ""),
|
||||||
|
error=f"the install was interrupted at '{stage}' (restart or crash) — try again",
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
fh.close()
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
def _read_plan(target: str) -> dict:
|
def _read_plan(target: str) -> dict:
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@ import shutil
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from furtka import sources
|
from furtka import sources
|
||||||
from furtka.manifest import Manifest, ManifestError, load_manifest
|
from furtka.manifest import APP_NAME_RE, Manifest, ManifestError, load_manifest
|
||||||
from furtka.paths import apps_dir
|
from furtka.paths import apps_dir
|
||||||
|
|
||||||
# Values that an app's .env.example may use as obvious "fill me in" markers.
|
# Values that an app's .env.example may use as obvious "fill me in" markers.
|
||||||
|
|
@ -35,19 +35,26 @@ class InstallError(RuntimeError):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def app_dir(name: str) -> Path:
|
||||||
|
"""/var/lib/furtka/apps/<name>, refusing anything that isn't a plain app name.
|
||||||
|
|
||||||
|
Names reach us from API bodies and URL paths; without this check "..",
|
||||||
|
"." or "/" would point remove()'s rmtree at /var/lib/furtka, every app,
|
||||||
|
or the root filesystem.
|
||||||
|
"""
|
||||||
|
if not isinstance(name, str) or not APP_NAME_RE.fullmatch(name):
|
||||||
|
raise InstallError(f"{name!r} is not a valid app name")
|
||||||
|
return apps_dir() / name
|
||||||
|
|
||||||
|
|
||||||
|
def _placeholder_values(values: dict[str, str]) -> list[str]:
|
||||||
|
return [k for k, v in values.items() if v.strip() in PLACEHOLDER_SECRETS]
|
||||||
|
|
||||||
|
|
||||||
def _placeholder_keys(env_path: Path) -> list[str]:
|
def _placeholder_keys(env_path: Path) -> list[str]:
|
||||||
if not env_path.exists():
|
if not env_path.exists():
|
||||||
return []
|
return []
|
||||||
bad: list[str] = []
|
return _placeholder_values(_read_env(env_path))
|
||||||
for raw in env_path.read_text().splitlines():
|
|
||||||
line = raw.strip()
|
|
||||||
if not line or line.startswith("#") or "=" not in line:
|
|
||||||
continue
|
|
||||||
key, _, value = line.partition("=")
|
|
||||||
value = value.strip().strip('"').strip("'")
|
|
||||||
if value in PLACEHOLDER_SECRETS:
|
|
||||||
bad.append(key.strip())
|
|
||||||
return bad
|
|
||||||
|
|
||||||
|
|
||||||
def _is_denied_system_path(resolved: str) -> bool:
|
def _is_denied_system_path(resolved: str) -> bool:
|
||||||
|
|
@ -59,16 +66,13 @@ def _is_denied_system_path(resolved: str) -> bool:
|
||||||
return False
|
return False
|
||||||
|
|
||||||
|
|
||||||
def _path_setting_errors(m: Manifest, env_path: Path) -> list[str]:
|
def _path_setting_errors(m: Manifest, values: dict[str, str]) -> list[str]:
|
||||||
"""Validate the filesystem paths named by `path`-type settings.
|
"""Validate the filesystem paths named by `path`-type settings.
|
||||||
|
|
||||||
Returns one human-readable message per offending setting. Empty values
|
Returns one human-readable message per offending setting. Empty values
|
||||||
on non-required settings are allowed — the required-field check in the
|
on non-required settings are allowed — the required-field check in the
|
||||||
caller already refuses blanks on required fields before write.
|
caller already refuses blanks on required fields before write.
|
||||||
"""
|
"""
|
||||||
if not env_path.exists():
|
|
||||||
return []
|
|
||||||
values = _read_env(env_path)
|
|
||||||
errors: list[str] = []
|
errors: list[str] = []
|
||||||
for s in m.settings:
|
for s in m.settings:
|
||||||
if s.type != "path":
|
if s.type != "path":
|
||||||
|
|
@ -97,10 +101,35 @@ def _path_setting_errors(m: Manifest, env_path: Path) -> list[str]:
|
||||||
return errors
|
return errors
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_settings(m: Manifest, values: dict[str, str]) -> None:
|
||||||
|
"""Refuse a merged settings view before it is written to .env.
|
||||||
|
|
||||||
|
Runs in memory so a rejected value (placeholder, system path, line
|
||||||
|
break) never reaches the live .env where the next reconcile would use it.
|
||||||
|
"""
|
||||||
|
for k, v in values.items():
|
||||||
|
if any(c in v for c in "\r\n\0"):
|
||||||
|
raise InstallError(f"{m.name}: setting {k!r} must not contain line breaks")
|
||||||
|
bad = _placeholder_values({s.name: values.get(s.name, "") for s in m.settings})
|
||||||
|
if bad:
|
||||||
|
raise InstallError(
|
||||||
|
f"{m.name}: please replace the example value for {', '.join(bad)} with your own"
|
||||||
|
)
|
||||||
|
path_errors = _path_setting_errors(m, values)
|
||||||
|
if path_errors:
|
||||||
|
raise InstallError(f"{m.name}: {'; '.join(path_errors)}")
|
||||||
|
|
||||||
|
|
||||||
def _format_env_value(v: str) -> str:
|
def _format_env_value(v: str) -> str:
|
||||||
# Quote values that contain whitespace, quotes, or shell metacharacters so
|
# Quote values that contain whitespace, quotes, or shell metacharacters so
|
||||||
# docker-compose's env substitution reads them back intact. Simple values
|
# docker-compose's env substitution reads them back intact. Simple values
|
||||||
# stay unquoted to keep the file readable when a user SSHes in.
|
# stay unquoted to keep the file readable when a user SSHes in.
|
||||||
|
if any(c in v for c in "\r\n\0"):
|
||||||
|
raise InstallError("setting values must not contain line breaks")
|
||||||
|
if "$" in v and "'" not in v:
|
||||||
|
# Compose expands ${VAR} inside double quotes, so "pa$word" would
|
||||||
|
# silently turn into "pa". Single-quoted values are taken literally.
|
||||||
|
return f"'{v}'"
|
||||||
if v == "" or any(c in v for c in " \t\"'$`\\#"):
|
if v == "" or any(c in v for c in " \t\"'$`\\#"):
|
||||||
escaped = v.replace("\\", "\\\\").replace('"', '\\"')
|
escaped = v.replace("\\", "\\\\").replace('"', '\\"')
|
||||||
return f'"{escaped}"'
|
return f'"{escaped}"'
|
||||||
|
|
@ -167,7 +196,7 @@ def install_from(src: Path, settings: dict[str, str] | None = None) -> Path:
|
||||||
if key not in declared:
|
if key not in declared:
|
||||||
raise InstallError(f"{m.name}: unknown setting {key!r}")
|
raise InstallError(f"{m.name}: unknown setting {key!r}")
|
||||||
|
|
||||||
target = apps_dir() / m.name
|
target = app_dir(m.name)
|
||||||
target.mkdir(parents=True, exist_ok=True)
|
target.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
for item in src.iterdir():
|
for item in src.iterdir():
|
||||||
|
|
@ -216,6 +245,7 @@ def install_from(src: Path, settings: dict[str, str] | None = None) -> Path:
|
||||||
for s in m.settings:
|
for s in m.settings:
|
||||||
if s.required and not merged.get(s.name):
|
if s.required and not merged.get(s.name):
|
||||||
raise InstallError(f"{m.name}: setting {s.name!r} is required")
|
raise InstallError(f"{m.name}: setting {s.name!r} is required")
|
||||||
|
_validate_settings(m, merged)
|
||||||
write_env(env, merged)
|
write_env(env, merged)
|
||||||
elif not env.exists() and env_example.exists():
|
elif not env.exists() and env_example.exists():
|
||||||
# First install with no settings and no .env shipped: bootstrap from
|
# First install with no settings and no .env shipped: bootstrap from
|
||||||
|
|
@ -235,7 +265,7 @@ def install_from(src: Path, settings: dict[str, str] | None = None) -> Path:
|
||||||
f"file and re-run `furtka app install {m.name}`."
|
f"file and re-run `furtka app install {m.name}`."
|
||||||
)
|
)
|
||||||
|
|
||||||
path_errors = _path_setting_errors(m, env)
|
path_errors = _path_setting_errors(m, read_env_values(env))
|
||||||
if path_errors:
|
if path_errors:
|
||||||
raise InstallError(f"{m.name}: {'; '.join(path_errors)}")
|
raise InstallError(f"{m.name}: {'; '.join(path_errors)}")
|
||||||
|
|
||||||
|
|
@ -256,10 +286,11 @@ def parse_env_text(text: str) -> dict[str, str]:
|
||||||
continue
|
continue
|
||||||
key, _, value = line.partition("=")
|
key, _, value = line.partition("=")
|
||||||
value = value.strip()
|
value = value.strip()
|
||||||
if (value.startswith('"') and value.endswith('"')) or (
|
if len(value) >= 2 and value.startswith('"') and value.endswith('"'):
|
||||||
value.startswith("'") and value.endswith("'")
|
|
||||||
):
|
|
||||||
value = value[1:-1].replace('\\"', '"').replace("\\\\", "\\")
|
value = value[1:-1].replace('\\"', '"').replace("\\\\", "\\")
|
||||||
|
elif len(value) >= 2 and value.startswith("'") and value.endswith("'"):
|
||||||
|
# Single quotes are literal in compose's dotenv — no escapes.
|
||||||
|
value = value[1:-1]
|
||||||
out[key.strip()] = value
|
out[key.strip()] = value
|
||||||
return out
|
return out
|
||||||
|
|
||||||
|
|
@ -284,7 +315,7 @@ def update_env(name: str, settings: dict[str, str]) -> Path:
|
||||||
apps only. Returns the target folder; caller is expected to run
|
apps only. Returns the target folder; caller is expected to run
|
||||||
reconcile to restart the containers.
|
reconcile to restart the containers.
|
||||||
"""
|
"""
|
||||||
target = apps_dir() / name
|
target = app_dir(name)
|
||||||
manifest_path = target / "manifest.json"
|
manifest_path = target / "manifest.json"
|
||||||
if not manifest_path.exists():
|
if not manifest_path.exists():
|
||||||
raise InstallError(f"{name!r} is not installed")
|
raise InstallError(f"{name!r} is not installed")
|
||||||
|
|
@ -316,13 +347,8 @@ def update_env(name: str, settings: dict[str, str]) -> Path:
|
||||||
for s in m.settings:
|
for s in m.settings:
|
||||||
if s.required and not merged.get(s.name):
|
if s.required and not merged.get(s.name):
|
||||||
raise InstallError(f"{m.name}: setting {s.name!r} is required")
|
raise InstallError(f"{m.name}: setting {s.name!r} is required")
|
||||||
|
_validate_settings(m, merged)
|
||||||
write_env(env, merged)
|
write_env(env, merged)
|
||||||
bad = _placeholder_keys(env)
|
|
||||||
if bad:
|
|
||||||
raise InstallError(f"{m.name}: {env} still has placeholder values for {', '.join(bad)}.")
|
|
||||||
path_errors = _path_setting_errors(m, env)
|
|
||||||
if path_errors:
|
|
||||||
raise InstallError(f"{m.name}: {'; '.join(path_errors)}")
|
|
||||||
return target
|
return target
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -353,7 +379,7 @@ def remove(name: str) -> Path:
|
||||||
|
|
||||||
Caller is responsible for stopping the compose project first.
|
Caller is responsible for stopping the compose project first.
|
||||||
"""
|
"""
|
||||||
target = apps_dir() / name
|
target = app_dir(name)
|
||||||
if not target.exists():
|
if not target.exists():
|
||||||
raise InstallError(f"{name!r} is not installed")
|
raise InstallError(f"{name!r} is not installed")
|
||||||
shutil.rmtree(target)
|
shutil.rmtree(target)
|
||||||
|
|
|
||||||
|
|
@ -32,6 +32,21 @@ class Setting:
|
||||||
default: str | None
|
default: str | None
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class Internet:
|
||||||
|
# Whether this app is safe to expose to the internet through a
|
||||||
|
# furtka-gateway at all. Only ever a catalog author's self-declaration —
|
||||||
|
# the gateway independently re-validates the port it's given at publish
|
||||||
|
# time regardless of what this says (see furtka-gateway's routes.py).
|
||||||
|
viable: bool
|
||||||
|
# Which declared `ports` entry is the exposable web UI. Required when
|
||||||
|
# viable is True — an app declaring several ports (e.g. a DNS service
|
||||||
|
# exposing both its resolver port and an admin UI port) must say which
|
||||||
|
# one is actually meant to be reachable from the internet; there is no
|
||||||
|
# way to infer that from `ports` alone.
|
||||||
|
port: int | None
|
||||||
|
|
||||||
|
|
||||||
@dataclass(frozen=True)
|
@dataclass(frozen=True)
|
||||||
class Requirement:
|
class Requirement:
|
||||||
app: str # name of the required app — must resolve in installed/catalog/bundled
|
app: str # name of the required app — must resolve in installed/catalog/bundled
|
||||||
|
|
@ -62,6 +77,7 @@ class Manifest:
|
||||||
# no frontend (CLI-only, background workers) leave this empty.
|
# no frontend (CLI-only, background workers) leave this empty.
|
||||||
open_url: str = ""
|
open_url: str = ""
|
||||||
requires: tuple[Requirement, ...] = field(default_factory=tuple)
|
requires: tuple[Requirement, ...] = field(default_factory=tuple)
|
||||||
|
internet: Internet = field(default_factory=lambda: Internet(viable=False, port=None))
|
||||||
|
|
||||||
def volume_name(self, short: str) -> str:
|
def volume_name(self, short: str) -> str:
|
||||||
# Namespace volume names so two apps can each declare e.g. "data"
|
# Namespace volume names so two apps can each declare e.g. "data"
|
||||||
|
|
@ -155,6 +171,27 @@ def _parse_requires(raw: object, manifest_path: Path, self_name: str) -> tuple[R
|
||||||
return tuple(out)
|
return tuple(out)
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_internet(raw: object, manifest_path: Path, ports: list[int]) -> Internet:
|
||||||
|
if raw is None:
|
||||||
|
return Internet(viable=False, port=None)
|
||||||
|
if not isinstance(raw, dict):
|
||||||
|
raise ManifestError(f"{manifest_path}: internet must be an object")
|
||||||
|
|
||||||
|
viable = bool(raw.get("viable", False))
|
||||||
|
port = raw.get("port")
|
||||||
|
|
||||||
|
if not viable:
|
||||||
|
return Internet(viable=False, port=None)
|
||||||
|
|
||||||
|
if not isinstance(port, int) or isinstance(port, bool):
|
||||||
|
raise ManifestError(f"{manifest_path}: internet.port must be an integer when viable")
|
||||||
|
if port not in ports:
|
||||||
|
raise ManifestError(
|
||||||
|
f"{manifest_path}: internet.port {port} must be one of the declared ports {ports}"
|
||||||
|
)
|
||||||
|
return Internet(viable=True, port=port)
|
||||||
|
|
||||||
|
|
||||||
def load_manifest(path: Path, expected_name: str | None = None) -> Manifest:
|
def load_manifest(path: Path, expected_name: str | None = None) -> Manifest:
|
||||||
"""Parse and validate a manifest.json.
|
"""Parse and validate a manifest.json.
|
||||||
|
|
||||||
|
|
@ -175,8 +212,10 @@ def load_manifest(path: Path, expected_name: str | None = None) -> Manifest:
|
||||||
raise ManifestError(f"{path}: missing required fields: {', '.join(missing)}")
|
raise ManifestError(f"{path}: missing required fields: {', '.join(missing)}")
|
||||||
|
|
||||||
name = raw["name"]
|
name = raw["name"]
|
||||||
if not isinstance(name, str) or not name:
|
if not isinstance(name, str) or not APP_NAME_RE.fullmatch(name):
|
||||||
raise ManifestError(f"{path}: name must be a non-empty string")
|
raise ManifestError(
|
||||||
|
f"{path}: name must be lowercase letters, digits, '-' or '_' (got {name!r})"
|
||||||
|
)
|
||||||
if expected_name is not None and name != expected_name:
|
if expected_name is not None and name != expected_name:
|
||||||
raise ManifestError(f"{path}: name {name!r} must equal {expected_name!r}")
|
raise ManifestError(f"{path}: name {name!r} must equal {expected_name!r}")
|
||||||
|
|
||||||
|
|
@ -190,6 +229,7 @@ def load_manifest(path: Path, expected_name: str | None = None) -> Manifest:
|
||||||
|
|
||||||
settings = _parse_settings(raw.get("settings"), path)
|
settings = _parse_settings(raw.get("settings"), path)
|
||||||
requires = _parse_requires(raw.get("requires"), path, name)
|
requires = _parse_requires(raw.get("requires"), path, name)
|
||||||
|
internet = _parse_internet(raw.get("internet"), path, ports)
|
||||||
|
|
||||||
open_url_raw = raw.get("open_url", "")
|
open_url_raw = raw.get("open_url", "")
|
||||||
if not isinstance(open_url_raw, str):
|
if not isinstance(open_url_raw, str):
|
||||||
|
|
@ -207,4 +247,5 @@ def load_manifest(path: Path, expected_name: str | None = None) -> Manifest:
|
||||||
settings=settings,
|
settings=settings,
|
||||||
open_url=open_url_raw,
|
open_url=open_url_raw,
|
||||||
requires=requires,
|
requires=requires,
|
||||||
|
internet=internet,
|
||||||
)
|
)
|
||||||
|
|
|
||||||
|
|
@ -20,6 +20,18 @@ DEFAULT_USERS_FILE = Path("/var/lib/furtka/users.json")
|
||||||
# /settings* so those pages pick up the auth-guard. Caddy also serves
|
# /settings* so those pages pick up the auth-guard. Caddy also serves
|
||||||
# /style.css and other assets directly from here for the login page.
|
# /style.css and other assets directly from here for the login page.
|
||||||
DEFAULT_STATIC_WWW = Path("/opt/furtka/current/assets/www")
|
DEFAULT_STATIC_WWW = Path("/opt/furtka/current/assets/www")
|
||||||
|
# This box's furtka-gateway registration: {gateway_url, box_id, box_token,
|
||||||
|
# wg: {...}}. Written once by furtka.gateway.register(), 0600 (it carries
|
||||||
|
# the box's WireGuard private key — see furtka-gateway's wgeasy.py for why
|
||||||
|
# that's unavoidable with stock wg-easy). Lives under /var/lib/furtka/ so
|
||||||
|
# self-updates don't stomp it, same as users.json.
|
||||||
|
DEFAULT_GATEWAY_CONFIG = Path("/var/lib/furtka/gateway.json")
|
||||||
|
# Which installed apps are currently published through the connected
|
||||||
|
# gateway, keyed by app name: {app_name: {route_id, subdomain, port}}.
|
||||||
|
# Separate from gateway.json since this changes per-app-toggle, not per
|
||||||
|
# gateway-connection — no reason to rewrite the (more sensitive) box
|
||||||
|
# credentials file on every publish/unpublish.
|
||||||
|
DEFAULT_INTERNET_ROUTES_FILE = Path("/var/lib/furtka/internet-routes.json")
|
||||||
|
|
||||||
|
|
||||||
def apps_dir() -> Path:
|
def apps_dir() -> Path:
|
||||||
|
|
@ -44,3 +56,11 @@ def users_file() -> Path:
|
||||||
|
|
||||||
def static_www_dir() -> Path:
|
def static_www_dir() -> Path:
|
||||||
return Path(os.environ.get("FURTKA_STATIC_WWW", DEFAULT_STATIC_WWW))
|
return Path(os.environ.get("FURTKA_STATIC_WWW", DEFAULT_STATIC_WWW))
|
||||||
|
|
||||||
|
|
||||||
|
def gateway_config_file() -> Path:
|
||||||
|
return Path(os.environ.get("FURTKA_GATEWAY_CONFIG", DEFAULT_GATEWAY_CONFIG))
|
||||||
|
|
||||||
|
|
||||||
|
def internet_routes_file() -> Path:
|
||||||
|
return Path(os.environ.get("FURTKA_INTERNET_ROUTES_FILE", DEFAULT_INTERNET_ROUTES_FILE))
|
||||||
|
|
|
||||||
|
|
@ -29,6 +29,7 @@ the updater at a tmpdir.
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import fcntl
|
import fcntl
|
||||||
|
import http.client
|
||||||
import json
|
import json
|
||||||
import os
|
import os
|
||||||
import shutil
|
import shutil
|
||||||
|
|
@ -191,6 +192,20 @@ def _maybe_migrate_preserve_https() -> None:
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _maybe_migrate_redirect_snippet() -> None:
|
||||||
|
"""26.21 migration: swap the old catch-all 301 redirect for the
|
||||||
|
hostname-scoped 302 one, so boxes reached by IP can load the UI again
|
||||||
|
and turning HTTPS off stops sticking in browser caches."""
|
||||||
|
from furtka import https
|
||||||
|
|
||||||
|
redirect_snippet = _CADDY_SNIPPET_DIR / "redirect.caddyfile"
|
||||||
|
if not redirect_snippet.is_file():
|
||||||
|
return
|
||||||
|
if redirect_snippet.read_text() != https.LEGACY_REDIRECT_CONTENT:
|
||||||
|
return
|
||||||
|
redirect_snippet.write_text(https._redirect_snippet_content(_current_hostname()))
|
||||||
|
|
||||||
|
|
||||||
def _refresh_caddyfile(source: Path) -> bool:
|
def _refresh_caddyfile(source: Path) -> bool:
|
||||||
"""Copy the shipped Caddyfile to /etc/caddy/ iff it differs. Returns True
|
"""Copy the shipped Caddyfile to /etc/caddy/ iff it differs. Returns True
|
||||||
if the file changed (so caddy needs more than a bare reload).
|
if the file changed (so caddy needs more than a bare reload).
|
||||||
|
|
@ -214,6 +229,7 @@ def _refresh_caddyfile(source: Path) -> bool:
|
||||||
# hostname block is gone, so the redirect would 301 to a dead :443.
|
# hostname block is gone, so the redirect would 301 to a dead :443.
|
||||||
# Preserve intent by writing the HTTPS listener snippet too.
|
# Preserve intent by writing the HTTPS listener snippet too.
|
||||||
_maybe_migrate_preserve_https()
|
_maybe_migrate_preserve_https()
|
||||||
|
_maybe_migrate_redirect_snippet()
|
||||||
rendered = source.read_text().replace(_CADDYFILE_HOSTNAME_MARKER, _current_hostname())
|
rendered = source.read_text().replace(_CADDYFILE_HOSTNAME_MARKER, _current_hostname())
|
||||||
if _CADDYFILE_LIVE.is_file() and rendered == _CADDYFILE_LIVE.read_text():
|
if _CADDYFILE_LIVE.is_file() and rendered == _CADDYFILE_LIVE.read_text():
|
||||||
return False
|
return False
|
||||||
|
|
@ -265,9 +281,10 @@ def write_state(stage: str, **extra) -> None:
|
||||||
|
|
||||||
def read_state() -> dict:
|
def read_state() -> dict:
|
||||||
try:
|
try:
|
||||||
return json.loads(state_path().read_text())
|
data = json.loads(state_path().read_text())
|
||||||
except (FileNotFoundError, json.JSONDecodeError):
|
except (OSError, UnicodeDecodeError, json.JSONDecodeError):
|
||||||
return {}
|
return {}
|
||||||
|
return data if isinstance(data, dict) else {}
|
||||||
|
|
||||||
|
|
||||||
def acquire_lock():
|
def acquire_lock():
|
||||||
|
|
@ -318,13 +335,29 @@ def _health_check(url: str, deadline_s: float = 30.0) -> bool:
|
||||||
# check. 5xx → genuinely broken, don't accept.
|
# check. 5xx → genuinely broken, don't accept.
|
||||||
if 400 <= e.code < 500:
|
if 400 <= e.code < 500:
|
||||||
return True
|
return True
|
||||||
except urllib.error.URLError:
|
except (OSError, http.client.HTTPException):
|
||||||
# Connection refused / DNS / timeout → not up yet, retry.
|
# Connection refused / reset / timeout (URLError is an OSError;
|
||||||
|
# a read timeout or RemoteDisconnected is not wrapped by urllib)
|
||||||
|
# → not up yet, retry.
|
||||||
pass
|
pass
|
||||||
time.sleep(1)
|
time.sleep(1)
|
||||||
return False
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def _swap_symlink(link: Path, target: str | Path) -> None:
|
||||||
|
"""Point `link` at `target` atomically.
|
||||||
|
|
||||||
|
unlink() + symlink_to() leaves a window with no /opt/furtka/current at
|
||||||
|
all — a power cut there boots a box with no services. rename() over the
|
||||||
|
old link is atomic.
|
||||||
|
"""
|
||||||
|
tmp = link.with_name(link.name + ".new")
|
||||||
|
if tmp.is_symlink() or tmp.exists():
|
||||||
|
tmp.unlink()
|
||||||
|
tmp.symlink_to(target)
|
||||||
|
os.replace(tmp, link)
|
||||||
|
|
||||||
|
|
||||||
def prepare_update(check: UpdateCheck, download_dir: Path | None = None) -> tuple[Path, str]:
|
def prepare_update(check: UpdateCheck, download_dir: Path | None = None) -> tuple[Path, str]:
|
||||||
"""Download + verify the tarball. Returns (tarball_path, version)."""
|
"""Download + verify the tarball. Returns (tarball_path, version)."""
|
||||||
if not check.tarball_url or not check.sha256_url:
|
if not check.tarball_url or not check.sha256_url:
|
||||||
|
|
@ -369,15 +402,11 @@ def apply_update(tarball: Path, version: str) -> None:
|
||||||
target.chmod(0o755)
|
target.chmod(0o755)
|
||||||
|
|
||||||
write_state("swapping", latest=version)
|
write_state("swapping", latest=version)
|
||||||
previous = None
|
previous = os.readlink(current) if current.is_symlink() else None
|
||||||
if current.is_symlink():
|
old_caddyfile = _CADDYFILE_LIVE.read_text() if _CADDYFILE_LIVE.is_file() else None
|
||||||
previous = os.readlink(current)
|
|
||||||
current.unlink()
|
|
||||||
try:
|
try:
|
||||||
current.symlink_to(target)
|
_swap_symlink(current, target)
|
||||||
except OSError as e:
|
except OSError as e:
|
||||||
if previous:
|
|
||||||
current.symlink_to(previous)
|
|
||||||
raise UpdateError(f"symlink swap failed: {e}") from e
|
raise UpdateError(f"symlink swap failed: {e}") from e
|
||||||
|
|
||||||
write_state("restarting", latest=version)
|
write_state("restarting", latest=version)
|
||||||
|
|
@ -393,27 +422,41 @@ def apply_update(tarball: Path, version: str) -> None:
|
||||||
_run(["systemctl", "daemon-reload"])
|
_run(["systemctl", "daemon-reload"])
|
||||||
_run(["systemctl", "try-restart", "furtka-reconcile.service"])
|
_run(["systemctl", "try-restart", "furtka-reconcile.service"])
|
||||||
_run(["systemctl", "restart", "furtka-api.service"])
|
_run(["systemctl", "restart", "furtka-api.service"])
|
||||||
except UpdateError as e:
|
except (UpdateError, OSError) as e:
|
||||||
_rollback(previous, version, f"service restart failed: {e}")
|
# OSError: e.g. disk full or EACCES writing the Caddyfile — the new
|
||||||
raise
|
# version is already live, so this must roll back too.
|
||||||
|
_rollback(previous, version, f"service restart failed: {e}", old_caddyfile)
|
||||||
|
raise UpdateError(f"service restart failed: {e} — rolled back") from e
|
||||||
|
|
||||||
write_state("verifying", latest=version)
|
write_state("verifying", latest=version)
|
||||||
ok = _health_check("http://127.0.0.1:7000/api/apps", deadline_s=30.0)
|
ok = _health_check("http://127.0.0.1:7000/api/apps", deadline_s=30.0)
|
||||||
if not ok:
|
if not ok:
|
||||||
_rollback(previous, version, "health check failed after restart")
|
_rollback(previous, version, "health check failed after restart", old_caddyfile)
|
||||||
raise UpdateError("new version failed health check — rolled back")
|
raise UpdateError("new version failed health check — rolled back")
|
||||||
|
|
||||||
write_state("done", version=version)
|
write_state("done", version=version)
|
||||||
|
|
||||||
|
|
||||||
def _rollback(previous_target: str | None, failed_version: str, reason: str) -> None:
|
def _rollback(
|
||||||
|
previous_target: str | None,
|
||||||
|
failed_version: str,
|
||||||
|
reason: str,
|
||||||
|
old_caddyfile: str | None = None,
|
||||||
|
) -> None:
|
||||||
current = current_symlink()
|
current = current_symlink()
|
||||||
if previous_target:
|
if previous_target:
|
||||||
if current.is_symlink():
|
_swap_symlink(current, previous_target)
|
||||||
current.unlink()
|
# The new release may have shipped Caddy routes the old code
|
||||||
current.symlink_to(previous_target)
|
# doesn't serve; put the previous Caddyfile back before reloading.
|
||||||
|
if old_caddyfile is not None:
|
||||||
|
try:
|
||||||
|
_CADDYFILE_LIVE.write_text(old_caddyfile)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
# Best-effort restart on the previous target — if it fails too the
|
# Best-effort restart on the previous target — if it fails too the
|
||||||
# box is in a hard state, but we can only surface the reason.
|
# box is in a hard state, but we can only surface the reason.
|
||||||
|
subprocess.run(["systemctl", "daemon-reload"], check=False)
|
||||||
|
subprocess.run(["systemctl", "reload", "caddy"], check=False)
|
||||||
subprocess.run(["systemctl", "restart", "furtka-api.service"], check=False)
|
subprocess.run(["systemctl", "restart", "furtka-api.service"], check=False)
|
||||||
write_state(
|
write_state(
|
||||||
"rolled_back",
|
"rolled_back",
|
||||||
|
|
@ -430,6 +473,7 @@ def run_update() -> UpdateCheck:
|
||||||
UpdateError on any failure; the state file records the stage.
|
UpdateError on any failure; the state file records the stage.
|
||||||
"""
|
"""
|
||||||
with acquire_lock():
|
with acquire_lock():
|
||||||
|
try:
|
||||||
check = check_update()
|
check = check_update()
|
||||||
if not check.update_available:
|
if not check.update_available:
|
||||||
write_state("done", version=check.current, note="already up to date")
|
write_state("done", version=check.current, note="already up to date")
|
||||||
|
|
@ -437,6 +481,17 @@ def run_update() -> UpdateCheck:
|
||||||
tarball, version = prepare_update(check)
|
tarball, version = prepare_update(check)
|
||||||
apply_update(tarball, version)
|
apply_update(tarball, version)
|
||||||
return check
|
return check
|
||||||
|
except Exception as e:
|
||||||
|
# Without a terminal stage the settings page keeps showing
|
||||||
|
# "Downloading…" forever. Rollback already wrote its own stage.
|
||||||
|
if read_state().get("stage") != "rolled_back":
|
||||||
|
try:
|
||||||
|
write_state("error", reason=str(e) or type(e).__name__)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
if isinstance(e, UpdateError):
|
||||||
|
raise
|
||||||
|
raise UpdateError(str(e) or type(e).__name__) from e
|
||||||
|
|
||||||
|
|
||||||
def rollback() -> str:
|
def rollback() -> str:
|
||||||
|
|
@ -456,8 +511,7 @@ def rollback() -> str:
|
||||||
raise UpdateError("no other version slots available to roll back to")
|
raise UpdateError("no other version slots available to roll back to")
|
||||||
target_name = candidates[0]
|
target_name = candidates[0]
|
||||||
target = versions_dir() / target_name
|
target = versions_dir() / target_name
|
||||||
current.unlink()
|
_swap_symlink(current, target)
|
||||||
current.symlink_to(target)
|
|
||||||
subprocess.run(["systemctl", "daemon-reload"], check=False)
|
subprocess.run(["systemctl", "daemon-reload"], check=False)
|
||||||
subprocess.run(["systemctl", "restart", "furtka-api.service"], check=False)
|
subprocess.run(["systemctl", "restart", "furtka-api.service"], check=False)
|
||||||
write_state("rolled_back_manual", restored_to=target_name)
|
write_state("rolled_back_manual", restored_to=target_name)
|
||||||
|
|
|
||||||
160
furtka/wireguard.py
Normal file
|
|
@ -0,0 +1,160 @@
|
||||||
|
"""WireGuard tunnel to a connected furtka-gateway.
|
||||||
|
|
||||||
|
Structural mirror of furtka.https's snippet-write-plus-reload pattern:
|
||||||
|
write/remove /etc/wireguard/furtka-gw.conf, then flip the wg-quick@furtka-gw
|
||||||
|
systemd unit, reverting the conf file if that call fails so a bad config
|
||||||
|
can't leave the tunnel half-configured. One deliberate difference from
|
||||||
|
https.py: enabling and disabling are genuinely different systemctl
|
||||||
|
subcommands here (Caddy only ever needs a single `reload` either way), so
|
||||||
|
the injectable `reload` callable takes the resolved action ("enable" or
|
||||||
|
"disable") rather than being a fixed zero-argument call.
|
||||||
|
|
||||||
|
This module never generates its own keypair or contacts furtka-gateway
|
||||||
|
directly — furtka.gateway.register() gets the full WireGuard interface
|
||||||
|
config (including the private key; see furtka-gateway's wgeasy.py for why
|
||||||
|
that's unavoidable with stock wg-easy) and hands it to
|
||||||
|
set_tunnel_enabled() here.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import subprocess
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
DEFAULT_CONF_PATH = Path("/etc/wireguard/furtka-gw.conf")
|
||||||
|
INTERFACE = "furtka-gw"
|
||||||
|
|
||||||
|
|
||||||
|
def default_conf_path() -> Path:
|
||||||
|
return Path(os.environ.get("FURTKA_WIREGUARD_CONF", DEFAULT_CONF_PATH))
|
||||||
|
|
||||||
|
|
||||||
|
class WireguardError(Exception):
|
||||||
|
"""Recoverable failure from set_tunnel_enabled — the caller should 5xx."""
|
||||||
|
|
||||||
|
|
||||||
|
def _conf_content(wg: dict) -> str:
|
||||||
|
"""Render a wg-quick .conf from a furtka-gateway registration response's
|
||||||
|
`wg` block. AllowedIPs here governs what THIS box routes *through* the
|
||||||
|
tunnel — furtka-gateway hands back a split-tunnel value (its own peer
|
||||||
|
subnet only), which this module passes through verbatim rather than
|
||||||
|
widening it, so a compromised gateway can't pull the box's other
|
||||||
|
traffic through it.
|
||||||
|
|
||||||
|
`preshared_key` is only present when the gateway's wg-easy is v15
|
||||||
|
(which generates one per client by default and enforces it
|
||||||
|
server-side) — omitted (None/missing) for v14, which has none.
|
||||||
|
Dropping a present preshared key here would break the handshake
|
||||||
|
silently, since the server side would still expect it.
|
||||||
|
"""
|
||||||
|
preshared_key_line = ""
|
||||||
|
if wg.get("preshared_key"):
|
||||||
|
preshared_key_line = f"PresharedKey = {wg['preshared_key']}\n"
|
||||||
|
return (
|
||||||
|
"[Interface]\n"
|
||||||
|
f"PrivateKey = {wg['private_key']}\n"
|
||||||
|
f"Address = {wg['address']}\n"
|
||||||
|
"\n"
|
||||||
|
"[Peer]\n"
|
||||||
|
f"PublicKey = {wg['server_public_key']}\n"
|
||||||
|
f"{preshared_key_line}"
|
||||||
|
f"Endpoint = {wg['endpoint']}\n"
|
||||||
|
f"AllowedIPs = {wg['allowed_ips']}\n"
|
||||||
|
"PersistentKeepalive = 25\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _default_reload(action: str) -> None:
|
||||||
|
subprocess.run(
|
||||||
|
["systemctl", action, "--now", f"wg-quick@{INTERFACE}"],
|
||||||
|
check=True,
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def set_tunnel_enabled(
|
||||||
|
enabled: bool,
|
||||||
|
wg: dict | None = None,
|
||||||
|
conf_path: Path | None = None,
|
||||||
|
reload=_default_reload,
|
||||||
|
) -> bool:
|
||||||
|
"""Bring the tunnel up (writing conf_path from `wg`) or down.
|
||||||
|
|
||||||
|
`wg` is required when enabling ({private_key, address, server_public_key,
|
||||||
|
endpoint, allowed_ips} — furtka.gateway.register()'s return shape),
|
||||||
|
ignored when disabling. Reverts conf_path to its pre-call state if the
|
||||||
|
systemctl action fails, so a bad config can't leave the tunnel wedged.
|
||||||
|
"""
|
||||||
|
if enabled and wg is None:
|
||||||
|
raise ValueError("wg config is required to enable the tunnel")
|
||||||
|
if conf_path is None:
|
||||||
|
conf_path = default_conf_path()
|
||||||
|
|
||||||
|
try:
|
||||||
|
conf_path.parent.mkdir(mode=0o700, parents=True, exist_ok=True)
|
||||||
|
had_conf = conf_path.is_file()
|
||||||
|
previous = conf_path.read_text() if had_conf else None
|
||||||
|
|
||||||
|
if enabled:
|
||||||
|
conf_path.write_text(_conf_content(wg))
|
||||||
|
conf_path.chmod(0o600)
|
||||||
|
elif had_conf:
|
||||||
|
conf_path.unlink()
|
||||||
|
except OSError as e:
|
||||||
|
raise WireguardError(f"could not access {conf_path}: {e}") from e
|
||||||
|
|
||||||
|
try:
|
||||||
|
reload("enable" if enabled else "disable")
|
||||||
|
except subprocess.CalledProcessError as e:
|
||||||
|
_revert(conf_path, previous)
|
||||||
|
msg = (e.stderr or e.stdout or "").strip() or f"exit {e.returncode}"
|
||||||
|
raise WireguardError(f"systemctl failed: {msg}") from e
|
||||||
|
except FileNotFoundError as e:
|
||||||
|
_revert(conf_path, previous)
|
||||||
|
raise WireguardError(f"systemctl not available: {e}") from e
|
||||||
|
return enabled
|
||||||
|
|
||||||
|
|
||||||
|
def _revert(conf_path: Path, previous: str | None) -> None:
|
||||||
|
if previous is None:
|
||||||
|
try:
|
||||||
|
conf_path.unlink()
|
||||||
|
except FileNotFoundError:
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
conf_path.write_text(previous)
|
||||||
|
|
||||||
|
|
||||||
|
def _default_wg_show() -> str:
|
||||||
|
result = subprocess.run(
|
||||||
|
["wg", "show", INTERFACE, "latest-handshakes"],
|
||||||
|
check=True,
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
)
|
||||||
|
return result.stdout.strip()
|
||||||
|
|
||||||
|
|
||||||
|
def status(conf_path: Path | None = None, wg_show=_default_wg_show) -> dict:
|
||||||
|
"""Whether the tunnel is configured, and its latest handshake if `wg`
|
||||||
|
tooling is available (None if not — e.g. wg-tools missing, or the
|
||||||
|
interface isn't actually up yet right after enabling).
|
||||||
|
|
||||||
|
Read-only and best-effort: any OSError stat-ing conf_path (missing
|
||||||
|
parent dir, an unexpected permission situation) is treated the same as
|
||||||
|
"not configured" rather than raised — a status check must never 500
|
||||||
|
the whole request over something this innocuous.
|
||||||
|
"""
|
||||||
|
if conf_path is None:
|
||||||
|
conf_path = default_conf_path()
|
||||||
|
try:
|
||||||
|
configured = conf_path.is_file()
|
||||||
|
except OSError:
|
||||||
|
configured = False
|
||||||
|
latest_handshake = None
|
||||||
|
if configured:
|
||||||
|
try:
|
||||||
|
latest_handshake = wg_show()
|
||||||
|
except (subprocess.CalledProcessError, FileNotFoundError):
|
||||||
|
latest_handshake = None
|
||||||
|
return {"configured": configured, "latest_handshake": latest_handshake}
|
||||||
|
|
@ -34,6 +34,17 @@ The systemd service runs `flask --app app run --host 0.0.0.0 --port 5000` under
|
||||||
|
|
||||||
mDNS is wired: `avahi-daemon` + `nss-mdns` come from `packages.extra`, the live ISO's hostname is `proksi`, and as soon as `systemd-networkd-wait-online` fires the installer is reachable at `http://proksi.local:5000`. The raw IP still shows on the console for fallback — some Windows clients need the Bonjour service for `.local` to resolve at all.
|
mDNS is wired: `avahi-daemon` + `nss-mdns` come from `packages.extra`, the live ISO's hostname is `proksi`, and as soon as `systemd-networkd-wait-online` fires the installer is reachable at `http://proksi.local:5000`. The raw IP still shows on the console for fallback — some Windows clients need the Bonjour service for `.local` to resolve at all.
|
||||||
|
|
||||||
|
### archinstall is pinned
|
||||||
|
|
||||||
|
The webinstaller imports archinstall internals and `furtka-webinstaller.service` sed-patches one of its files, so `build.sh` does not take whatever archinstall the Arch repos currently ship. It downloads the version in `ARCHINSTALL_PIN` from `archive.archlinux.org`, checks it against `ARCHINSTALL_SHA256`, and serves it from a local `[furtka-pinned]` repo listed before `[core]` in the build's `pacman.conf` (pacman takes a package from the first repo that has it). Only the build uses that repo; the live system's own `pacman.conf` is untouched.
|
||||||
|
|
||||||
|
The build fails with "pinned archinstall … targets Python X, Arch now ships Y" once Arch moves to a new Python — the pinned package would install into a dead `site-packages`. To bump:
|
||||||
|
|
||||||
|
1. Pick the new version from <https://archive.archlinux.org/packages/a/archinstall/>.
|
||||||
|
2. `curl -LO` the `.pkg.tar.zst`, `sha256sum` it, and update `ARCHINSTALL_PIN` + `ARCHINSTALL_SHA256` at the top of `build.sh`.
|
||||||
|
3. Check that `webinstaller/app.py:build_disk_config` still imports and that the `ExecStartPre` sed in `furtka-webinstaller.service` still matches (`journalctl -u furtka-webinstaller` on the live ISO).
|
||||||
|
4. Full VM install (UEFI and BIOS) before merging.
|
||||||
|
|
||||||
`build.sh` also deletes releng's `getty@tty1.service.d/autologin.conf`. With root auto-logged-in, tty1 belongs to a shell and `agetty --reload` can't redraw the banner, so the IP line was a snapshot of whatever DHCP had done by the time getty started. Without autologin tty1 sits at the login prompt showing the live banner; for a shell type `root` + Enter (releng's root has no password) — the banner says so.
|
`build.sh` also deletes releng's `getty@tty1.service.d/autologin.conf`. With root auto-logged-in, tty1 belongs to a shell and `agetty --reload` can't redraw the banner, so the IP line was a snapshot of whatever DHCP had done by the time getty started. Without autologin tty1 sits at the login prompt showing the live banner; for a shell type `root` + Enter (releng's root has no password) — the banner says so.
|
||||||
|
|
||||||
## Test flow
|
## Test flow
|
||||||
|
|
|
||||||
40
iso/build.sh
|
|
@ -27,7 +27,11 @@ fi
|
||||||
# ---- inside the container from here on ----
|
# ---- inside the container from here on ----
|
||||||
|
|
||||||
echo "==> Syncing pacman, installing archiso"
|
echo "==> Syncing pacman, installing archiso"
|
||||||
pacman -Syu --noconfirm --needed archiso
|
pacman -Syu --noconfirm --needed archiso curl zstd
|
||||||
|
|
||||||
|
# archinstall build the webinstaller is validated against (see pin step below).
|
||||||
|
ARCHINSTALL_PIN="4.4-1"
|
||||||
|
ARCHINSTALL_SHA256="6cb5da75c108ef2f5d25a7a20baf6c52cc927d5e06890dd10182e6eb4be815cb"
|
||||||
|
|
||||||
PROFILE_SRC="/usr/share/archiso/configs/releng"
|
PROFILE_SRC="/usr/share/archiso/configs/releng"
|
||||||
PROFILE_WORK="/tmp/furtka-profile"
|
PROFILE_WORK="/tmp/furtka-profile"
|
||||||
|
|
@ -43,6 +47,37 @@ cat "$SCRIPT_DIR/overlay/packages.extra" >> "$PROFILE_WORK/packages.x86_64"
|
||||||
|
|
||||||
cat "$SCRIPT_DIR/overlay/profiledef.sh" >> "$PROFILE_WORK/profiledef.sh"
|
cat "$SCRIPT_DIR/overlay/profiledef.sh" >> "$PROFILE_WORK/profiledef.sh"
|
||||||
|
|
||||||
|
echo "==> Pinning archinstall ${ARCHINSTALL_PIN}"
|
||||||
|
# The webinstaller imports archinstall internals (build_disk_config) and
|
||||||
|
# sed-patches one of its files at service start, so a silent archinstall
|
||||||
|
# upgrade in the Arch repos can break every install with no change on our
|
||||||
|
# side. Serve the validated build from a local repo listed *before* [core]:
|
||||||
|
# pacman takes a package from the first repo that has it, whatever the
|
||||||
|
# version elsewhere. Bump deliberately: new version + sha256 below, rebuild,
|
||||||
|
# run the smoke VM (see iso/README.md).
|
||||||
|
PINNED_REPO="/tmp/furtka-pinned-repo"
|
||||||
|
rm -rf "$PINNED_REPO" && mkdir -p "$PINNED_REPO"
|
||||||
|
ARCHINSTALL_PKG="archinstall-${ARCHINSTALL_PIN}-any.pkg.tar.zst"
|
||||||
|
curl -fsSL --retry 3 -o "$PINNED_REPO/$ARCHINSTALL_PKG" \
|
||||||
|
"https://archive.archlinux.org/packages/a/archinstall/$ARCHINSTALL_PKG"
|
||||||
|
echo "${ARCHINSTALL_SHA256} $PINNED_REPO/$ARCHINSTALL_PKG" | sha256sum -c -
|
||||||
|
# archinstall is an "any" package installed under /usr/lib/python3.X; after
|
||||||
|
# Arch moves to a new Python it would install into a dead directory. Fail
|
||||||
|
# the build with a clear message instead of shipping a broken installer.
|
||||||
|
pkg_py=$(tar --zstd -tf "$PINNED_REPO/$ARCHINSTALL_PKG" \
|
||||||
|
| sed -n 's|^usr/lib/python\(3\.[0-9]*\)/.*|\1|p' | sort -u)
|
||||||
|
repo_py=$(pacman -Si python | awk -F': ' '/^Version/ {split($2, v, "."); print v[1] "." v[2]}')
|
||||||
|
if [ "$pkg_py" != "$repo_py" ]; then
|
||||||
|
echo "ERROR: pinned archinstall ${ARCHINSTALL_PIN} targets Python $pkg_py, Arch now ships $repo_py." >&2
|
||||||
|
echo " Bump ARCHINSTALL_PIN/ARCHINSTALL_SHA256 in iso/build.sh (see iso/README.md)." >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
repo-add -q "$PINNED_REPO/furtka-pinned.db.tar.gz" "$PINNED_REPO/$ARCHINSTALL_PKG"
|
||||||
|
# The sha256 above already pins the exact bytes.
|
||||||
|
sed -i "0,/^\[core\]/s||[furtka-pinned]\nSigLevel = Optional TrustAll\nServer = file://$PINNED_REPO\n\n[core]|" \
|
||||||
|
"$PROFILE_WORK/pacman.conf"
|
||||||
|
grep -q '^\[furtka-pinned\]' "$PROFILE_WORK/pacman.conf"
|
||||||
|
|
||||||
cp -a "$SCRIPT_DIR/overlay/airootfs/." "$PROFILE_WORK/airootfs/"
|
cp -a "$SCRIPT_DIR/overlay/airootfs/." "$PROFILE_WORK/airootfs/"
|
||||||
|
|
||||||
# releng auto-logs root in on tty1. That turns our /etc/issue banner into a
|
# releng auto-logs root in on tty1. That turns our /etc/issue banner into a
|
||||||
|
|
@ -55,6 +90,9 @@ cp -a "$SCRIPT_DIR/overlay/airootfs/." "$PROFILE_WORK/airootfs/"
|
||||||
rm -rf "$PROFILE_WORK/airootfs/etc/systemd/system/getty@tty1.service.d"
|
rm -rf "$PROFILE_WORK/airootfs/etc/systemd/system/getty@tty1.service.d"
|
||||||
|
|
||||||
echo "==> Rebranding boot menu (GRUB + syslinux + systemd-boot)"
|
echo "==> Rebranding boot menu (GRUB + syslinux + systemd-boot)"
|
||||||
|
# BIOS boot menu background: Furtka lockup instead of the Arch logo
|
||||||
|
# (generated by website/tools/brand-assets.py, 640x480 as syslinux wants).
|
||||||
|
cp "$SCRIPT_DIR/overlay/splash.png" "$PROFILE_WORK/syslinux/splash.png"
|
||||||
# releng ships menu entries labelled "Arch Linux install medium" across three
|
# releng ships menu entries labelled "Arch Linux install medium" across three
|
||||||
# bootloader configs (BIOS syslinux, GRUB, systemd-boot for UEFI). Rewrite to
|
# bootloader configs (BIOS syslinux, GRUB, systemd-boot for UEFI). Rewrite to
|
||||||
# our brand. Done with sed (not a static overlay) so upstream archiso file
|
# our brand. Done with sed (not a static overlay) so upstream archiso file
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,17 @@ issue=/etc/issue
|
||||||
mapfile -t ips < <(ip -4 -o addr show scope global 2>/dev/null | awk '{print $4}' | cut -d/ -f1)
|
mapfile -t ips < <(ip -4 -o addr show scope global 2>/dev/null | awk '{print $4}' | cut -d/ -f1)
|
||||||
|
|
||||||
new=$(
|
new=$(
|
||||||
|
# Furtka mark (docs/brand/console-banner.txt, from brand-assets.py)
|
||||||
|
echo ' ▄▄▄▄▄▄▄▄'
|
||||||
|
echo ' ▄██████████▄'
|
||||||
|
echo ' █████▀▀▀▀▀▀███'
|
||||||
|
echo ' ████▀ ████'
|
||||||
|
echo ' ████ █████████'
|
||||||
|
echo ' ████ ████'
|
||||||
|
echo ' ████ ▄▄▄▄▄████'
|
||||||
|
echo ' ████ █████████'
|
||||||
|
echo ' ████ █████████'
|
||||||
|
echo ' ▀▀▀▀ ▀▀▀▀▀▀▀▀▀'
|
||||||
echo
|
echo
|
||||||
echo " Open Furtka in a browser on another device on your network:"
|
echo " Open Furtka in a browser on another device on your network:"
|
||||||
echo
|
echo
|
||||||
|
|
@ -30,6 +41,8 @@ new=$(
|
||||||
fi
|
fi
|
||||||
echo
|
echo
|
||||||
echo " Then follow the wizard to install Furtka on this machine."
|
echo " Then follow the wizard to install Furtka on this machine."
|
||||||
|
echo " The install downloads packages, so this machine needs a network"
|
||||||
|
echo " cable with internet access. Wi-Fi is not set up automatically."
|
||||||
echo
|
echo
|
||||||
echo " Need a shell? Log in as root (no password)."
|
echo " Need a shell? Log in as root (no password)."
|
||||||
echo
|
echo
|
||||||
|
|
|
||||||
BIN
iso/overlay/splash.png
Normal file
|
After Width: | Height: | Size: 4.3 KiB |
|
|
@ -1,6 +1,6 @@
|
||||||
[project]
|
[project]
|
||||||
name = "furtka"
|
name = "furtka"
|
||||||
version = "26.20-alpha"
|
version = "26.21-alpha"
|
||||||
description = "Open-source home server OS — simple enough for everyone."
|
description = "Open-source home server OS — simple enough for everyone."
|
||||||
requires-python = ">=3.11"
|
requires-python = ">=3.11"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
|
|
|
||||||
|
|
@ -113,6 +113,15 @@ if [ -f "$ISO" ]; then
|
||||||
if ! upload_asset "$ISO"; then
|
if ! upload_asset "$ISO"; then
|
||||||
echo "warning: ISO upload failed — release published without ISO asset" >&2
|
echo "warning: ISO upload failed — release published without ISO asset" >&2
|
||||||
fi
|
fi
|
||||||
|
# Checksum sidecar for the download page on furtka.org (and anyone
|
||||||
|
# verifying by hand). Uploaded even when the ISO upload reported a
|
||||||
|
# failure — a 504 there often still lands the file. Written from inside
|
||||||
|
# dist/ so the line carries the bare filename `sha256sum -c` expects.
|
||||||
|
ISO_SHA="$ISO.sha256"
|
||||||
|
(cd "$DIST_DIR" && sha256sum "$(basename "$ISO")" > "$(basename "$ISO_SHA")")
|
||||||
|
if ! upload_asset "$ISO_SHA"; then
|
||||||
|
echo "warning: ISO checksum upload failed" >&2
|
||||||
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
echo "Release $VERSION published: https://$HOST/$REPO/releases/tag/$VERSION"
|
echo "Release $VERSION published: https://$HOST/$REPO/releases/tag/$VERSION"
|
||||||
|
|
|
||||||
|
|
@ -407,7 +407,7 @@ def _request(port, path, cookie=None, method="GET", body=None):
|
||||||
|
|
||||||
def test_http_get_apps_route(fake_dirs, no_docker, admin_session):
|
def test_http_get_apps_route(fake_dirs, no_docker, admin_session):
|
||||||
"""Smoke test the actual HTTP server with a real socket, urllib client."""
|
"""Smoke test the actual HTTP server with a real socket, urllib client."""
|
||||||
server = api.HTTPServer(("127.0.0.1", 0), api._Handler) # port 0 → ephemeral
|
server = api.ThreadingHTTPServer(("127.0.0.1", 0), api._Handler) # port 0 → ephemeral
|
||||||
port = server.server_address[1]
|
port = server.server_address[1]
|
||||||
t = threading.Thread(target=server.serve_forever, daemon=True)
|
t = threading.Thread(target=server.serve_forever, daemon=True)
|
||||||
t.start()
|
t.start()
|
||||||
|
|
@ -431,7 +431,7 @@ def test_http_get_apps_route(fake_dirs, no_docker, admin_session):
|
||||||
|
|
||||||
|
|
||||||
def test_http_post_install_unknown_app(fake_dirs, admin_session):
|
def test_http_post_install_unknown_app(fake_dirs, admin_session):
|
||||||
server = api.HTTPServer(("127.0.0.1", 0), api._Handler)
|
server = api.ThreadingHTTPServer(("127.0.0.1", 0), api._Handler)
|
||||||
port = server.server_address[1]
|
port = server.server_address[1]
|
||||||
t = threading.Thread(target=server.serve_forever, daemon=True)
|
t = threading.Thread(target=server.serve_forever, daemon=True)
|
||||||
t.start()
|
t.start()
|
||||||
|
|
@ -459,7 +459,7 @@ def test_http_post_install_unknown_app(fake_dirs, admin_session):
|
||||||
|
|
||||||
|
|
||||||
def _start_server():
|
def _start_server():
|
||||||
server = api.HTTPServer(("127.0.0.1", 0), api._Handler)
|
server = api.ThreadingHTTPServer(("127.0.0.1", 0), api._Handler)
|
||||||
port = server.server_address[1]
|
port = server.server_address[1]
|
||||||
t = threading.Thread(target=server.serve_forever, daemon=True)
|
t = threading.Thread(target=server.serve_forever, daemon=True)
|
||||||
t.start()
|
t.start()
|
||||||
|
|
@ -980,7 +980,7 @@ def test_update_settings_unknown_app(fake_dirs):
|
||||||
def test_http_get_settings_route(fake_dirs, no_docker, admin_session):
|
def test_http_get_settings_route(fake_dirs, no_docker, admin_session):
|
||||||
_, bundled = fake_dirs
|
_, bundled = fake_dirs
|
||||||
_write_bundled(bundled, "fileshare", manifest=SETTINGS_MANIFEST)
|
_write_bundled(bundled, "fileshare", manifest=SETTINGS_MANIFEST)
|
||||||
server = api.HTTPServer(("127.0.0.1", 0), api._Handler)
|
server = api.ThreadingHTTPServer(("127.0.0.1", 0), api._Handler)
|
||||||
port = server.server_address[1]
|
port = server.server_address[1]
|
||||||
t = threading.Thread(target=server.serve_forever, daemon=True)
|
t = threading.Thread(target=server.serve_forever, daemon=True)
|
||||||
t.start()
|
t.start()
|
||||||
|
|
@ -1211,7 +1211,7 @@ def test_http_post_update_route(
|
||||||
api._do_install("fileshare")
|
api._do_install("fileshare")
|
||||||
update_docker_stubs["up_called"] = 0 # reset counter after install
|
update_docker_stubs["up_called"] = 0 # reset counter after install
|
||||||
update_docker_stubs["local"] = {"samba": "sha256:NEW"}
|
update_docker_stubs["local"] = {"samba": "sha256:NEW"}
|
||||||
server = api.HTTPServer(("127.0.0.1", 0), api._Handler)
|
server = api.ThreadingHTTPServer(("127.0.0.1", 0), api._Handler)
|
||||||
port = server.server_address[1]
|
port = server.server_address[1]
|
||||||
t = threading.Thread(target=server.serve_forever, daemon=True)
|
t = threading.Thread(target=server.serve_forever, daemon=True)
|
||||||
t.start()
|
t.start()
|
||||||
|
|
@ -1236,7 +1236,7 @@ def test_http_post_update_route(
|
||||||
def test_http_post_install_with_settings(fake_dirs, no_docker, no_systemd_run, admin_session):
|
def test_http_post_install_with_settings(fake_dirs, no_docker, no_systemd_run, admin_session):
|
||||||
_, bundled = fake_dirs
|
_, bundled = fake_dirs
|
||||||
_write_bundled(bundled, "fileshare", manifest=SETTINGS_MANIFEST)
|
_write_bundled(bundled, "fileshare", manifest=SETTINGS_MANIFEST)
|
||||||
server = api.HTTPServer(("127.0.0.1", 0), api._Handler)
|
server = api.ThreadingHTTPServer(("127.0.0.1", 0), api._Handler)
|
||||||
port = server.server_address[1]
|
port = server.server_address[1]
|
||||||
t = threading.Thread(target=server.serve_forever, daemon=True)
|
t = threading.Thread(target=server.serve_forever, daemon=True)
|
||||||
t.start()
|
t.start()
|
||||||
|
|
@ -1424,3 +1424,425 @@ def test_power_surfaces_systemd_run_missing(fake_dirs, monkeypatch):
|
||||||
status, body = api._do_power({"action": "reboot"})
|
status, body = api._do_power({"action": "reboot"})
|
||||||
assert status == 502
|
assert status == 502
|
||||||
assert "systemd-run" in body["error"]
|
assert "systemd-run" in body["error"]
|
||||||
|
|
||||||
|
|
||||||
|
# --- Gateway endpoints -------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def gateway_paths(fake_dirs, monkeypatch):
|
||||||
|
"""Redirect furtka.gateway's own env-cached state/lock paths into
|
||||||
|
tmp_path — same "set env, reload module" idiom fake_dirs already uses
|
||||||
|
for install_runner. gateway_config_file()/internet_routes_file() read
|
||||||
|
FURTKA_GATEWAY_CONFIG/FURTKA_INTERNET_ROUTES_FILE fresh on every call
|
||||||
|
(no caching), so they don't need a reload — only gateway.py's module-
|
||||||
|
level connect-state/lock constants do.
|
||||||
|
"""
|
||||||
|
apps_dir, _ = fake_dirs
|
||||||
|
root = apps_dir.parent
|
||||||
|
monkeypatch.setenv("FURTKA_GATEWAY_CONFIG", str(root / "gateway.json"))
|
||||||
|
monkeypatch.setenv("FURTKA_INTERNET_ROUTES_FILE", str(root / "internet-routes.json"))
|
||||||
|
monkeypatch.setenv("FURTKA_GATEWAY_CONNECT_STATE", str(root / "gateway-connect-state.json"))
|
||||||
|
monkeypatch.setenv("FURTKA_GATEWAY_CONNECT_LOCK", str(root / "gateway-connect.lock"))
|
||||||
|
import importlib
|
||||||
|
|
||||||
|
from furtka import gateway as g
|
||||||
|
|
||||||
|
importlib.reload(g)
|
||||||
|
return g
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_status_not_connected(gateway_paths):
|
||||||
|
status, body = api._do_gateway_status()
|
||||||
|
assert status == 200
|
||||||
|
assert body == {"connected": False}
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_status_connected(gateway_paths, monkeypatch):
|
||||||
|
gateway_paths._save_config(
|
||||||
|
{"gateway_url": "https://gw.example.com", "box_id": "abc", "box_token": "abc.x", "wg": {}}
|
||||||
|
)
|
||||||
|
from furtka import wireguard
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
wireguard, "status", lambda: {"configured": True, "latest_handshake": "123"}
|
||||||
|
)
|
||||||
|
status, body = api._do_gateway_status()
|
||||||
|
assert status == 200
|
||||||
|
assert body["connected"] is True
|
||||||
|
assert body["gateway_url"] == "https://gw.example.com"
|
||||||
|
assert body["box_id"] == "abc"
|
||||||
|
assert body["tunnel"] == {"configured": True, "latest_handshake": "123"}
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_connect_requires_all_fields(gateway_paths):
|
||||||
|
status, body = api._do_gateway_connect({"gateway_url": "https://gw.example.com"})
|
||||||
|
assert status == 400
|
||||||
|
assert "required" in body["error"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_connect_dispatches_systemd_run(gateway_paths, no_systemd_run):
|
||||||
|
status, body = api._do_gateway_connect(
|
||||||
|
{
|
||||||
|
"gateway_url": "https://gw.example.com",
|
||||||
|
"registration_token": "reg-tok",
|
||||||
|
"box_name": "my-box",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
assert status == 202
|
||||||
|
assert body["status"] == "dispatched"
|
||||||
|
[cmd] = no_systemd_run
|
||||||
|
assert cmd[:1] == ["systemd-run"]
|
||||||
|
assert cmd[-5:] == [
|
||||||
|
"gateway",
|
||||||
|
"connect-bg",
|
||||||
|
"https://gw.example.com",
|
||||||
|
"reg-tok",
|
||||||
|
"my-box",
|
||||||
|
]
|
||||||
|
# Initial state written synchronously so the UI has something to poll
|
||||||
|
# before the background job's first write.
|
||||||
|
assert gateway_paths.read_state()["stage"] == "registering"
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_connect_lock_contention(gateway_paths):
|
||||||
|
fh = gateway_paths.acquire_lock()
|
||||||
|
try:
|
||||||
|
status, body = api._do_gateway_connect(
|
||||||
|
{
|
||||||
|
"gateway_url": "https://gw.example.com",
|
||||||
|
"registration_token": "reg-tok",
|
||||||
|
"box_name": "my-box",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
assert status == 409
|
||||||
|
assert "already in progress" in body["error"]
|
||||||
|
finally:
|
||||||
|
fh.close()
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_connect_surfaces_systemd_run_missing(gateway_paths, monkeypatch):
|
||||||
|
def boom(*a, **kw):
|
||||||
|
raise FileNotFoundError(2, "No such file", "systemd-run")
|
||||||
|
|
||||||
|
monkeypatch.setattr("subprocess.run", boom)
|
||||||
|
status, body = api._do_gateway_connect(
|
||||||
|
{
|
||||||
|
"gateway_url": "https://gw.example.com",
|
||||||
|
"registration_token": "reg-tok",
|
||||||
|
"box_name": "my-box",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
assert status == 502
|
||||||
|
assert "systemd-run" in body["error"]
|
||||||
|
assert gateway_paths.read_state()["stage"] == "error"
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_connect_status_reads_state(gateway_paths):
|
||||||
|
gateway_paths.write_state("starting_tunnel")
|
||||||
|
status, body = api._do_gateway_connect_status()
|
||||||
|
assert status == 200
|
||||||
|
assert body["stage"] == "starting_tunnel"
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_disconnect_when_not_connected(gateway_paths):
|
||||||
|
status, body = api._do_gateway_disconnect()
|
||||||
|
assert status == 200
|
||||||
|
assert body == {"status": "not connected"}
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_disconnect_happy_path(gateway_paths, monkeypatch):
|
||||||
|
gateway_paths._save_config(
|
||||||
|
{"gateway_url": "https://gw.example.com", "box_id": "abc", "box_token": "abc.x", "wg": {}}
|
||||||
|
)
|
||||||
|
from furtka import wireguard
|
||||||
|
|
||||||
|
deregister_calls = []
|
||||||
|
tunnel_calls = []
|
||||||
|
monkeypatch.setattr(gateway_paths, "deregister", lambda: deregister_calls.append(1))
|
||||||
|
monkeypatch.setattr(
|
||||||
|
wireguard, "set_tunnel_enabled", lambda enabled: tunnel_calls.append(enabled)
|
||||||
|
)
|
||||||
|
|
||||||
|
status, body = api._do_gateway_disconnect()
|
||||||
|
|
||||||
|
assert status == 200
|
||||||
|
assert body == {"status": "disconnected"}
|
||||||
|
assert deregister_calls == [1]
|
||||||
|
assert tunnel_calls == [False]
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_disconnect_surfaces_deregister_failure(gateway_paths, monkeypatch):
|
||||||
|
gateway_paths._save_config(
|
||||||
|
{"gateway_url": "https://gw.example.com", "box_id": "abc", "box_token": "abc.x", "wg": {}}
|
||||||
|
)
|
||||||
|
|
||||||
|
def boom():
|
||||||
|
raise gateway_paths.GatewayError("gateway unreachable")
|
||||||
|
|
||||||
|
monkeypatch.setattr(gateway_paths, "deregister", boom)
|
||||||
|
status, body = api._do_gateway_disconnect()
|
||||||
|
assert status == 502
|
||||||
|
assert "gateway unreachable" in body["error"]
|
||||||
|
|
||||||
|
|
||||||
|
# --- Internet exposure toggle ------------------------------------------------
|
||||||
|
|
||||||
|
VIABLE_MANIFEST = dict(
|
||||||
|
VALID_MANIFEST,
|
||||||
|
internet={"viable": True, "port": 445},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_internet_not_installed(gateway_paths):
|
||||||
|
status, body = api._do_get_internet("ghost")
|
||||||
|
assert status == 404
|
||||||
|
|
||||||
|
|
||||||
|
def _install_app(fake_dirs, manifest, no_docker, no_systemd_run):
|
||||||
|
apps, bundled = fake_dirs
|
||||||
|
_write_bundled(bundled, manifest["name"], manifest=manifest)
|
||||||
|
status, body = api._do_install(manifest["name"])
|
||||||
|
assert status == 202, body
|
||||||
|
return apps / manifest["name"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_internet_not_viable_app(gateway_paths, fake_dirs, no_docker, no_systemd_run):
|
||||||
|
_install_app(fake_dirs, VALID_MANIFEST, no_docker, no_systemd_run)
|
||||||
|
status, body = api._do_get_internet("fileshare")
|
||||||
|
assert status == 404
|
||||||
|
assert "not internet-viable" in body["error"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_internet_viable_app_not_published(gateway_paths, fake_dirs, no_docker, no_systemd_run):
|
||||||
|
_install_app(fake_dirs, VIABLE_MANIFEST, no_docker, no_systemd_run)
|
||||||
|
status, body = api._do_get_internet("fileshare")
|
||||||
|
assert status == 200
|
||||||
|
assert body == {"enabled": False}
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_internet_viable_app_published(gateway_paths, fake_dirs, no_docker, no_systemd_run):
|
||||||
|
_install_app(fake_dirs, VIABLE_MANIFEST, no_docker, no_systemd_run)
|
||||||
|
api._save_internet_routes(
|
||||||
|
{"fileshare": {"route_id": "r1", "public_url": "https://fs.example.com/"}}
|
||||||
|
)
|
||||||
|
status, body = api._do_get_internet("fileshare")
|
||||||
|
assert status == 200
|
||||||
|
assert body == {"enabled": True, "public_url": "https://fs.example.com/"}
|
||||||
|
|
||||||
|
|
||||||
|
def test_set_internet_requires_enabled_bool(gateway_paths, fake_dirs, no_docker, no_systemd_run):
|
||||||
|
_install_app(fake_dirs, VIABLE_MANIFEST, no_docker, no_systemd_run)
|
||||||
|
status, body = api._do_set_internet("fileshare", {})
|
||||||
|
assert status == 400
|
||||||
|
|
||||||
|
|
||||||
|
def test_set_internet_rejects_non_viable_app(gateway_paths, fake_dirs, no_docker, no_systemd_run):
|
||||||
|
_install_app(fake_dirs, VALID_MANIFEST, no_docker, no_systemd_run)
|
||||||
|
status, body = api._do_set_internet(
|
||||||
|
"fileshare", {"enabled": True, "subdomain": "x.example.com"}
|
||||||
|
)
|
||||||
|
assert status == 400
|
||||||
|
assert "not internet-viable" in body["error"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_set_internet_requires_gateway_connection(
|
||||||
|
gateway_paths, fake_dirs, no_docker, no_systemd_run
|
||||||
|
):
|
||||||
|
_install_app(fake_dirs, VIABLE_MANIFEST, no_docker, no_systemd_run)
|
||||||
|
status, body = api._do_set_internet(
|
||||||
|
"fileshare", {"enabled": True, "subdomain": "x.example.com"}
|
||||||
|
)
|
||||||
|
assert status == 409
|
||||||
|
assert "not connected" in body["error"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_set_internet_enable_requires_subdomain(
|
||||||
|
gateway_paths, fake_dirs, no_docker, no_systemd_run
|
||||||
|
):
|
||||||
|
_install_app(fake_dirs, VIABLE_MANIFEST, no_docker, no_systemd_run)
|
||||||
|
gateway_paths._save_config(
|
||||||
|
{"gateway_url": "https://gw.example.com", "box_id": "abc", "box_token": "abc.x", "wg": {}}
|
||||||
|
)
|
||||||
|
status, body = api._do_set_internet("fileshare", {"enabled": True})
|
||||||
|
assert status == 400
|
||||||
|
assert "subdomain" in body["error"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_set_internet_enable_happy_path(
|
||||||
|
gateway_paths, fake_dirs, no_docker, no_systemd_run, monkeypatch
|
||||||
|
):
|
||||||
|
_install_app(fake_dirs, VIABLE_MANIFEST, no_docker, no_systemd_run)
|
||||||
|
gateway_paths._save_config(
|
||||||
|
{"gateway_url": "https://gw.example.com", "box_id": "abc", "box_token": "abc.x", "wg": {}}
|
||||||
|
)
|
||||||
|
calls = []
|
||||||
|
|
||||||
|
def fake_publish(app_name, subdomain, port):
|
||||||
|
calls.append((app_name, subdomain, port))
|
||||||
|
return {"route_id": "r1", "public_url": "https://fs.example.com/"}
|
||||||
|
|
||||||
|
monkeypatch.setattr(gateway_paths, "publish_route", fake_publish)
|
||||||
|
|
||||||
|
status, body = api._do_set_internet(
|
||||||
|
"fileshare", {"enabled": True, "subdomain": "fs.example.com"}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert status == 200
|
||||||
|
assert body == {"enabled": True, "public_url": "https://fs.example.com/"}
|
||||||
|
assert calls == [("fileshare", "fs.example.com", 445)]
|
||||||
|
assert api._internet_routes()["fileshare"]["route_id"] == "r1"
|
||||||
|
|
||||||
|
|
||||||
|
def test_set_internet_enable_surfaces_gateway_error(
|
||||||
|
gateway_paths, fake_dirs, no_docker, no_systemd_run, monkeypatch
|
||||||
|
):
|
||||||
|
_install_app(fake_dirs, VIABLE_MANIFEST, no_docker, no_systemd_run)
|
||||||
|
gateway_paths._save_config(
|
||||||
|
{"gateway_url": "https://gw.example.com", "box_id": "abc", "box_token": "abc.x", "wg": {}}
|
||||||
|
)
|
||||||
|
|
||||||
|
def boom(app_name, subdomain, port):
|
||||||
|
raise gateway_paths.GatewayError("subdomain already in use")
|
||||||
|
|
||||||
|
monkeypatch.setattr(gateway_paths, "publish_route", boom)
|
||||||
|
|
||||||
|
status, body = api._do_set_internet(
|
||||||
|
"fileshare", {"enabled": True, "subdomain": "fs.example.com"}
|
||||||
|
)
|
||||||
|
assert status == 502
|
||||||
|
assert "subdomain already in use" in body["error"]
|
||||||
|
assert api._internet_routes() == {}
|
||||||
|
|
||||||
|
|
||||||
|
def test_set_internet_disable_happy_path(
|
||||||
|
gateway_paths, fake_dirs, no_docker, no_systemd_run, monkeypatch
|
||||||
|
):
|
||||||
|
_install_app(fake_dirs, VIABLE_MANIFEST, no_docker, no_systemd_run)
|
||||||
|
gateway_paths._save_config(
|
||||||
|
{"gateway_url": "https://gw.example.com", "box_id": "abc", "box_token": "abc.x", "wg": {}}
|
||||||
|
)
|
||||||
|
api._save_internet_routes(
|
||||||
|
{"fileshare": {"route_id": "r1", "public_url": "https://fs.example.com/"}}
|
||||||
|
)
|
||||||
|
calls = []
|
||||||
|
monkeypatch.setattr(gateway_paths, "unpublish_route", lambda route_id: calls.append(route_id))
|
||||||
|
|
||||||
|
status, body = api._do_set_internet("fileshare", {"enabled": False})
|
||||||
|
|
||||||
|
assert status == 200
|
||||||
|
assert body == {"enabled": False}
|
||||||
|
assert calls == ["r1"]
|
||||||
|
assert api._internet_routes() == {}
|
||||||
|
|
||||||
|
|
||||||
|
def test_set_internet_disable_when_not_published_is_a_noop(
|
||||||
|
gateway_paths, fake_dirs, no_docker, no_systemd_run
|
||||||
|
):
|
||||||
|
_install_app(fake_dirs, VIABLE_MANIFEST, no_docker, no_systemd_run)
|
||||||
|
gateway_paths._save_config(
|
||||||
|
{"gateway_url": "https://gw.example.com", "box_id": "abc", "box_token": "abc.x", "wg": {}}
|
||||||
|
)
|
||||||
|
status, body = api._do_set_internet("fileshare", {"enabled": False})
|
||||||
|
assert status == 200
|
||||||
|
assert body == {"enabled": False}
|
||||||
|
|
||||||
|
|
||||||
|
# --- hardening: names, body size, cross-site POSTs, crash handling ----------
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("bad", ["/", ".", "..", "../catalog"])
|
||||||
|
def test_http_remove_rejects_path_names(fake_dirs, no_docker, admin_session, bad):
|
||||||
|
apps, _ = fake_dirs
|
||||||
|
(apps / "fileshare").mkdir()
|
||||||
|
server, port = _start_server()
|
||||||
|
try:
|
||||||
|
req = _request(
|
||||||
|
port, "/api/apps/remove", cookie=admin_session, method="POST", body={"name": bad}
|
||||||
|
)
|
||||||
|
with pytest.raises(urllib.error.HTTPError) as e:
|
||||||
|
urllib.request.urlopen(req)
|
||||||
|
assert e.value.code == 400
|
||||||
|
assert (apps / "fileshare").exists()
|
||||||
|
finally:
|
||||||
|
server.shutdown()
|
||||||
|
server.server_close()
|
||||||
|
|
||||||
|
|
||||||
|
def test_http_post_rejects_oversized_body(fake_dirs, admin_session):
|
||||||
|
server, port = _start_server()
|
||||||
|
try:
|
||||||
|
import http.client
|
||||||
|
|
||||||
|
# Announce a huge body but never send it: the server must answer
|
||||||
|
# from the header alone instead of waiting to buffer it.
|
||||||
|
conn = http.client.HTTPConnection("127.0.0.1", port, timeout=5)
|
||||||
|
conn.putrequest("POST", "/api/apps/remove")
|
||||||
|
conn.putheader("Cookie", admin_session)
|
||||||
|
conn.putheader("Content-Length", str(api.MAX_BODY_BYTES + 1))
|
||||||
|
conn.endheaders()
|
||||||
|
assert conn.getresponse().status == 413
|
||||||
|
conn.close()
|
||||||
|
finally:
|
||||||
|
server.shutdown()
|
||||||
|
server.server_close()
|
||||||
|
|
||||||
|
|
||||||
|
def test_http_post_rejects_same_site_other_origin(fake_dirs, no_docker, admin_session):
|
||||||
|
apps, _ = fake_dirs
|
||||||
|
(apps / "fileshare").mkdir()
|
||||||
|
server, port = _start_server()
|
||||||
|
try:
|
||||||
|
req = _request(
|
||||||
|
port,
|
||||||
|
"/api/apps/remove",
|
||||||
|
cookie=admin_session,
|
||||||
|
method="POST",
|
||||||
|
body={"name": "fileshare"},
|
||||||
|
)
|
||||||
|
req.add_header("Sec-Fetch-Site", "same-site")
|
||||||
|
with pytest.raises(urllib.error.HTTPError) as e:
|
||||||
|
urllib.request.urlopen(req)
|
||||||
|
assert e.value.code == 403
|
||||||
|
assert (apps / "fileshare").exists()
|
||||||
|
finally:
|
||||||
|
server.shutdown()
|
||||||
|
server.server_close()
|
||||||
|
|
||||||
|
|
||||||
|
def test_http_unexpected_exception_returns_json_500(fake_dirs, admin_session, monkeypatch):
|
||||||
|
def boom():
|
||||||
|
raise FileNotFoundError("docker")
|
||||||
|
|
||||||
|
monkeypatch.setattr(api, "_list_installed", boom)
|
||||||
|
server, port = _start_server()
|
||||||
|
try:
|
||||||
|
with pytest.raises(urllib.error.HTTPError) as e:
|
||||||
|
urllib.request.urlopen(_request(port, "/api/apps", cookie=admin_session))
|
||||||
|
assert e.value.code == 500
|
||||||
|
assert "internal error" in json.loads(e.value.read())["error"]
|
||||||
|
finally:
|
||||||
|
server.shutdown()
|
||||||
|
server.server_close()
|
||||||
|
|
||||||
|
|
||||||
|
def test_login_with_corrupt_users_file_is_503_not_setup(fake_dirs, tmp_path):
|
||||||
|
(tmp_path / "users.json").write_text("")
|
||||||
|
server, port = _start_server()
|
||||||
|
try:
|
||||||
|
with pytest.raises(urllib.error.HTTPError) as e:
|
||||||
|
urllib.request.urlopen(_request(port, "/login"))
|
||||||
|
assert e.value.code == 503
|
||||||
|
req = _request(
|
||||||
|
port,
|
||||||
|
"/login",
|
||||||
|
method="POST",
|
||||||
|
body={"username": "mallory", "password": "longenough1", "password2": "longenough1"},
|
||||||
|
)
|
||||||
|
with pytest.raises(urllib.error.HTTPError) as e:
|
||||||
|
urllib.request.urlopen(req)
|
||||||
|
assert e.value.code == 503
|
||||||
|
assert (tmp_path / "users.json").read_text() == ""
|
||||||
|
finally:
|
||||||
|
server.shutdown()
|
||||||
|
server.server_close()
|
||||||
|
|
|
||||||
|
|
@ -87,7 +87,7 @@ def test_build_archinstall_config_includes_post_install_bootstrap(monkeypatch, t
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
for pkg in ("caddy", "avahi", "nss-mdns"):
|
for pkg in ("caddy", "avahi", "nss-mdns", "wireguard-tools"):
|
||||||
assert pkg in cfg["packages"]
|
assert pkg in cfg["packages"]
|
||||||
# Packaged units go in `services` (enabled before custom_commands runs);
|
# Packaged units go in `services` (enabled before custom_commands runs);
|
||||||
# our own units don't exist at that point, so they must be enabled from
|
# our own units don't exist at that point, so they must be enabled from
|
||||||
|
|
@ -226,3 +226,180 @@ def test_log_page_running_state_has_no_restart_button(monkeypatch, tmp_path):
|
||||||
html = app_module.app.test_client().get("/install/log").get_data(as_text=True)
|
html = app_module.app.test_client().get("/install/log").get_data(as_text=True)
|
||||||
assert "next-steps" not in html
|
assert "next-steps" not in html
|
||||||
assert "install_reboot" not in html and "restart now" not in html
|
assert "install_reboot" not in html and "restart now" not in html
|
||||||
|
|
||||||
|
|
||||||
|
def test_nonzero_exit_without_traceback_is_an_error():
|
||||||
|
import app as app_module
|
||||||
|
|
||||||
|
# OOM kill / signal: archinstall dies mid-pacstrap and prints nothing.
|
||||||
|
log = "Installing packages: ['base'\n"
|
||||||
|
assert app_module.parse_install_progress(log)["status"] == "running"
|
||||||
|
assert app_module.parse_install_progress(log, exit_code=-9)["status"] == "error"
|
||||||
|
assert app_module.parse_install_progress(log, exit_code=0)["status"] == "running"
|
||||||
|
|
||||||
|
|
||||||
|
class _FakeProc:
|
||||||
|
def __init__(self, code=None):
|
||||||
|
self.code = code
|
||||||
|
|
||||||
|
def poll(self):
|
||||||
|
return self.code
|
||||||
|
|
||||||
|
|
||||||
|
def _install_env(monkeypatch, tmp_path):
|
||||||
|
import app as app_module
|
||||||
|
|
||||||
|
monkeypatch.setattr(app_module, "STATE_DIR", tmp_path)
|
||||||
|
monkeypatch.setattr(app_module, "INSTALL_LOG", tmp_path / "install.log")
|
||||||
|
monkeypatch.setattr(app_module, "_install_proc", None)
|
||||||
|
monkeypatch.delenv("FURTKA_DRY_RUN", raising=False)
|
||||||
|
monkeypatch.setitem(app_module.settings, "boot_drive", "/dev/sda")
|
||||||
|
monkeypatch.setitem(app_module.settings, "username", "u")
|
||||||
|
monkeypatch.setitem(app_module.settings, "password", "pw12345678")
|
||||||
|
monkeypatch.setattr(app_module, "release_disk", lambda d: [f"released {d}"])
|
||||||
|
monkeypatch.setattr(app_module, "build_disk_config", lambda d: {"device": d})
|
||||||
|
return app_module
|
||||||
|
|
||||||
|
|
||||||
|
def test_install_run_refuses_second_concurrent_install(monkeypatch, tmp_path):
|
||||||
|
app_module = _install_env(monkeypatch, tmp_path)
|
||||||
|
spawned = []
|
||||||
|
monkeypatch.setattr(
|
||||||
|
app_module, "spawn_archinstall", lambda *a: spawned.append(a) or _FakeProc()
|
||||||
|
)
|
||||||
|
client = app_module.app.test_client()
|
||||||
|
assert client.post("/install/run").status_code == 302
|
||||||
|
assert client.post("/install/run").status_code == 302
|
||||||
|
assert len(spawned) == 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_install_run_disk_probe_failure_lands_in_log(monkeypatch, tmp_path):
|
||||||
|
app_module = _install_env(monkeypatch, tmp_path)
|
||||||
|
|
||||||
|
def boom(_):
|
||||||
|
raise RuntimeError("parted could not read /dev/sda")
|
||||||
|
|
||||||
|
monkeypatch.setattr(app_module, "build_disk_config", boom)
|
||||||
|
resp = app_module.app.test_client().post("/install/run")
|
||||||
|
assert resp.status_code == 302
|
||||||
|
log = (tmp_path / "install.log").read_text()
|
||||||
|
assert "Traceback (most recent call last)" in log
|
||||||
|
assert app_module.parse_install_progress(log)["status"] == "error"
|
||||||
|
|
||||||
|
|
||||||
|
def test_install_log_json_reports_crashed_archinstall(monkeypatch, tmp_path):
|
||||||
|
app_module = _install_env(monkeypatch, tmp_path)
|
||||||
|
(tmp_path / "install.log").write_text("Installing packages: ['base'\n")
|
||||||
|
monkeypatch.setattr(app_module, "_install_proc", _FakeProc(code=137))
|
||||||
|
data = app_module.app.test_client().get("/install/log.json").get_json()
|
||||||
|
assert data["progress"]["status"] == "error"
|
||||||
|
assert "exit code 137" in data["log"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_step2_rejects_disk_not_offered(monkeypatch):
|
||||||
|
import app as app_module
|
||||||
|
|
||||||
|
offered = [
|
||||||
|
{
|
||||||
|
"name": "/dev/sda",
|
||||||
|
"usable": True,
|
||||||
|
"size": "500 GB",
|
||||||
|
"type_label": "SSD",
|
||||||
|
"health_label": "Healthy",
|
||||||
|
"score": 27,
|
||||||
|
"reason": "",
|
||||||
|
"warning": "",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "/dev/sdb",
|
||||||
|
"usable": False,
|
||||||
|
"size": "8 GB",
|
||||||
|
"type_label": "USB",
|
||||||
|
"health_label": "Status unknown",
|
||||||
|
"score": 10,
|
||||||
|
"reason": "Too small",
|
||||||
|
"warning": "",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
monkeypatch.setattr(app_module, "list_scored_devices", lambda: offered)
|
||||||
|
monkeypatch.setitem(app_module.settings, "boot_drive", "")
|
||||||
|
client = app_module.app.test_client()
|
||||||
|
for bad in ("/dev/sdb", "/dev/nope", "/etc/passwd"):
|
||||||
|
resp = client.post("/install/step2", data={"boot_drive": bad})
|
||||||
|
assert resp.status_code == 200
|
||||||
|
assert app_module.settings["boot_drive"] == ""
|
||||||
|
resp = client.post("/install/step2", data={"boot_drive": "/dev/sda"})
|
||||||
|
assert resp.status_code == 302
|
||||||
|
assert app_module.settings["boot_drive"] == "/dev/sda"
|
||||||
|
|
||||||
|
|
||||||
|
def test_validate_step1_lowercases_names():
|
||||||
|
errors, values = validate_step1(
|
||||||
|
{
|
||||||
|
"hostname": "Furtka",
|
||||||
|
"username": "Daniel",
|
||||||
|
"password": "topsecretpw",
|
||||||
|
"password2": "topsecretpw",
|
||||||
|
"language": "de",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
assert errors == []
|
||||||
|
assert values["hostname"] == "furtka"
|
||||||
|
assert values["username"] == "daniel"
|
||||||
|
|
||||||
|
|
||||||
|
def test_validate_step1_rejects_reserved_usernames():
|
||||||
|
for name in ("root", "caddy", "docker", "nobody"):
|
||||||
|
errors, _ = validate_step1(
|
||||||
|
{
|
||||||
|
"hostname": "furtka",
|
||||||
|
"username": name,
|
||||||
|
"password": "topsecretpw",
|
||||||
|
"password2": "topsecretpw",
|
||||||
|
"language": "en",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
assert len(errors) == 1 and "reserved" in errors[0], name
|
||||||
|
|
||||||
|
|
||||||
|
def test_post_install_sets_wait_online_any(monkeypatch):
|
||||||
|
import base64
|
||||||
|
|
||||||
|
import app as app_module
|
||||||
|
|
||||||
|
cmds = app_module._post_install_commands("h", "u", "pw12345678")
|
||||||
|
hits = [c for c in cmds if "systemd-networkd-wait-online.service.d" in c]
|
||||||
|
assert len(hits) == 1
|
||||||
|
payload = hits[0].split("printf %s ")[1].split(" |")[0]
|
||||||
|
assert "--any" in base64.b64decode(payload).decode()
|
||||||
|
|
||||||
|
|
||||||
|
def test_wizard_pages_redirect_to_progress_while_installing(monkeypatch, tmp_path):
|
||||||
|
app_module = _install_env(monkeypatch, tmp_path)
|
||||||
|
monkeypatch.setattr(app_module, "_install_proc", _FakeProc(code=None))
|
||||||
|
client = app_module.app.test_client()
|
||||||
|
for path in ("/install/step1", "/install/step2", "/install/overview"):
|
||||||
|
resp = client.get(path)
|
||||||
|
assert resp.status_code == 302
|
||||||
|
assert resp.headers["Location"].endswith("/install/log")
|
||||||
|
|
||||||
|
|
||||||
|
def test_error_page_offers_retry(monkeypatch, tmp_path):
|
||||||
|
app_module = _install_env(monkeypatch, tmp_path)
|
||||||
|
(tmp_path / "install.log").write_text("Traceback (most recent call last)\nboom\n")
|
||||||
|
html = app_module.app.test_client().get("/install/log").get_data(as_text=True)
|
||||||
|
assert "Try again" in html
|
||||||
|
assert "next-steps" not in html
|
||||||
|
|
||||||
|
|
||||||
|
def test_detect_bootloader_by_firmware(tmp_path):
|
||||||
|
import app as app_module
|
||||||
|
|
||||||
|
efi = tmp_path / "efi"
|
||||||
|
assert app_module._detect_bootloader(efi) == "Grub" # BIOS / legacy
|
||||||
|
efi.mkdir()
|
||||||
|
assert app_module._detect_bootloader(efi) == "Systemd-boot" # no bitness file
|
||||||
|
(efi / "fw_platform_size").write_text("64\n")
|
||||||
|
assert app_module._detect_bootloader(efi) == "Systemd-boot"
|
||||||
|
(efi / "fw_platform_size").write_text("32\n")
|
||||||
|
assert app_module._detect_bootloader(efi) == "Limine"
|
||||||
|
|
|
||||||
|
|
@ -40,14 +40,15 @@ def test_load_users_returns_empty_when_missing(tmp_users_file):
|
||||||
assert auth.load_users() == {}
|
assert auth.load_users() == {}
|
||||||
|
|
||||||
|
|
||||||
def test_load_users_returns_empty_on_junk(tmp_users_file):
|
@pytest.mark.parametrize("content", ["{not json", "[]", "", "\x00\x00"])
|
||||||
tmp_users_file.write_text("{not json")
|
def test_load_users_fails_closed_on_corrupt_file(tmp_users_file, content):
|
||||||
assert auth.load_users() == {}
|
"""A damaged users.json must not read as "no admin yet" — that would
|
||||||
|
turn /login into an open create-admin form for anyone on the LAN."""
|
||||||
|
tmp_users_file.write_text(content)
|
||||||
def test_load_users_returns_empty_on_non_dict(tmp_users_file):
|
with pytest.raises(auth.UsersFileError):
|
||||||
tmp_users_file.write_text("[]")
|
auth.load_users()
|
||||||
assert auth.load_users() == {}
|
with pytest.raises(auth.UsersFileError):
|
||||||
|
auth.setup_needed()
|
||||||
|
|
||||||
|
|
||||||
def test_save_users_atomic_and_0600(tmp_users_file):
|
def test_save_users_atomic_and_0600(tmp_users_file):
|
||||||
|
|
|
||||||
|
|
@ -56,23 +56,27 @@ def _make_catalog_tarball(
|
||||||
*,
|
*,
|
||||||
apps: list[tuple[str, dict]] | None = None,
|
apps: list[tuple[str, dict]] | None = None,
|
||||||
extra_entries: list[tuple[str, bytes]] | None = None,
|
extra_entries: list[tuple[str, bytes]] | None = None,
|
||||||
|
compose_overrides: dict[str, bytes] | None = None,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Build a minimal valid catalog tarball.
|
"""Build a minimal valid catalog tarball.
|
||||||
|
|
||||||
`apps` is a list of (folder_name, manifest_dict). Each app folder gets
|
`apps` is a list of (folder_name, manifest_dict). Each app folder gets
|
||||||
a `manifest.json` + a stub `docker-compose.yaml` + `icon.svg`.
|
a `manifest.json` + a stub `docker-compose.yaml` + `icon.svg`.
|
||||||
|
`compose_overrides` (folder_name -> bytes) replaces that stub content
|
||||||
|
for specific apps — for testing catalog-side compose checks (e.g.
|
||||||
|
`internet.viable` + `privileged: true`) without needing a real image.
|
||||||
`extra_entries` lets tests inject malformed content (path-traversal,
|
`extra_entries` lets tests inject malformed content (path-traversal,
|
||||||
missing VERSION, ...) without rebuilding the helper.
|
missing VERSION, ...) without rebuilding the helper.
|
||||||
"""
|
"""
|
||||||
apps = apps if apps is not None else [("fileshare", _manifest())]
|
apps = apps if apps is not None else [("fileshare", _manifest())]
|
||||||
|
compose_overrides = compose_overrides or {}
|
||||||
buf = io.BytesIO()
|
buf = io.BytesIO()
|
||||||
with tarfile.open(fileobj=buf, mode="w:gz") as tf:
|
with tarfile.open(fileobj=buf, mode="w:gz") as tf:
|
||||||
entries: list[tuple[str, bytes]] = [("VERSION", f"{version}\n".encode())]
|
entries: list[tuple[str, bytes]] = [("VERSION", f"{version}\n".encode())]
|
||||||
for folder, m in apps:
|
for folder, m in apps:
|
||||||
entries.append((f"apps/{folder}/manifest.json", json.dumps(m).encode()))
|
entries.append((f"apps/{folder}/manifest.json", json.dumps(m).encode()))
|
||||||
entries.append(
|
compose = compose_overrides.get(folder, b"services:\n app:\n image: scratch\n")
|
||||||
(f"apps/{folder}/docker-compose.yaml", b"services:\n app:\n image: scratch\n")
|
entries.append((f"apps/{folder}/docker-compose.yaml", compose))
|
||||||
)
|
|
||||||
entries.append((f"apps/{folder}/icon.svg", b"<svg/>"))
|
entries.append((f"apps/{folder}/icon.svg", b"<svg/>"))
|
||||||
if extra_entries:
|
if extra_entries:
|
||||||
entries.extend(extra_entries)
|
entries.extend(extra_entries)
|
||||||
|
|
@ -266,6 +270,76 @@ def test_sync_catalog_refuses_tarball_with_invalid_manifest(catalog, monkeypatch
|
||||||
assert not catalog.catalog_dir().exists()
|
assert not catalog.catalog_dir().exists()
|
||||||
|
|
||||||
|
|
||||||
|
def test_sync_catalog_refuses_privileged_internet_viable_app(catalog, monkeypatch, tmp_path):
|
||||||
|
import hashlib
|
||||||
|
|
||||||
|
viable_manifest = dict(_manifest(), internet={"viable": True, "port": 445})
|
||||||
|
|
||||||
|
tarball_path = tmp_path / "tarball.tar.gz"
|
||||||
|
_make_catalog_tarball(
|
||||||
|
tarball_path,
|
||||||
|
"26.6",
|
||||||
|
apps=[("fileshare", viable_manifest)],
|
||||||
|
compose_overrides={
|
||||||
|
"fileshare": b"services:\n app:\n image: scratch\n privileged: true\n"
|
||||||
|
},
|
||||||
|
)
|
||||||
|
tarball_bytes = tarball_path.read_bytes()
|
||||||
|
sha = hashlib.sha256(tarball_bytes).hexdigest()
|
||||||
|
|
||||||
|
_stub_forgejo_release(monkeypatch, catalog, tag="26.6")
|
||||||
|
_stub_download(
|
||||||
|
monkeypatch,
|
||||||
|
catalog,
|
||||||
|
{
|
||||||
|
"https://forgejo.test.local/t.tar.gz": tarball_bytes,
|
||||||
|
"https://forgejo.test.local/t.tar.gz.sha256": (
|
||||||
|
f"{sha} furtka-apps-26.6.tar.gz\n".encode()
|
||||||
|
),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
with pytest.raises(catalog.CatalogError, match="must not run privileged"):
|
||||||
|
catalog.sync_catalog()
|
||||||
|
assert not catalog.catalog_dir().exists()
|
||||||
|
|
||||||
|
|
||||||
|
def test_sync_catalog_allows_privileged_app_that_is_not_internet_viable(
|
||||||
|
catalog, monkeypatch, tmp_path
|
||||||
|
):
|
||||||
|
"""privileged: true is only disqualifying for internet.viable apps —
|
||||||
|
home-assistant's real catalog entry runs privileged for USB/Bluetooth
|
||||||
|
access and is simply not marked viable."""
|
||||||
|
import hashlib
|
||||||
|
|
||||||
|
tarball_path = tmp_path / "tarball.tar.gz"
|
||||||
|
_make_catalog_tarball(
|
||||||
|
tarball_path,
|
||||||
|
"26.6",
|
||||||
|
apps=[("fileshare", _manifest())],
|
||||||
|
compose_overrides={
|
||||||
|
"fileshare": b"services:\n app:\n image: scratch\n privileged: true\n"
|
||||||
|
},
|
||||||
|
)
|
||||||
|
tarball_bytes = tarball_path.read_bytes()
|
||||||
|
sha = hashlib.sha256(tarball_bytes).hexdigest()
|
||||||
|
|
||||||
|
_stub_forgejo_release(monkeypatch, catalog, tag="26.6")
|
||||||
|
_stub_download(
|
||||||
|
monkeypatch,
|
||||||
|
catalog,
|
||||||
|
{
|
||||||
|
"https://forgejo.test.local/t.tar.gz": tarball_bytes,
|
||||||
|
"https://forgejo.test.local/t.tar.gz.sha256": (
|
||||||
|
f"{sha} furtka-apps-26.6.tar.gz\n".encode()
|
||||||
|
),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
catalog.sync_catalog()
|
||||||
|
assert catalog.catalog_dir().exists()
|
||||||
|
|
||||||
|
|
||||||
def test_sync_catalog_preserves_existing_catalog_on_failure(catalog, monkeypatch, tmp_path):
|
def test_sync_catalog_preserves_existing_catalog_on_failure(catalog, monkeypatch, tmp_path):
|
||||||
"""A failed sync must leave the previous live catalog intact so boxes
|
"""A failed sync must leave the previous live catalog intact so boxes
|
||||||
keep working until the next successful sync."""
|
keep working until the next successful sync."""
|
||||||
|
|
@ -349,3 +423,30 @@ def test_sync_catalog_failure_writes_error_state(catalog, monkeypatch):
|
||||||
state = catalog.read_state()
|
state = catalog.read_state()
|
||||||
assert state["stage"] == "error"
|
assert state["stage"] == "error"
|
||||||
assert "Network is unreachable" in state["error"]
|
assert "Network is unreachable" in state["error"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_sync_catalog_unexpected_error_lands_as_error_stage(catalog, monkeypatch):
|
||||||
|
"""Disk full / mid-body disconnect used to leave the stage at
|
||||||
|
'downloading' forever because only CatalogError was caught."""
|
||||||
|
_stub_forgejo_release(monkeypatch, catalog, tag="26.6")
|
||||||
|
|
||||||
|
def boom(*a, **kw):
|
||||||
|
raise OSError(28, "No space left on device")
|
||||||
|
|
||||||
|
monkeypatch.setattr(catalog._rc, "download", boom)
|
||||||
|
with pytest.raises(catalog.CatalogError, match="No space left"):
|
||||||
|
catalog.sync_catalog()
|
||||||
|
assert catalog.read_state()["stage"] == "error"
|
||||||
|
|
||||||
|
|
||||||
|
def test_release_download_wraps_socket_errors(tmp_path, monkeypatch):
|
||||||
|
from furtka import _release_common as rc
|
||||||
|
|
||||||
|
def reset(*a, **kw):
|
||||||
|
raise ConnectionResetError("reset by peer")
|
||||||
|
|
||||||
|
monkeypatch.setattr(rc.urllib.request, "urlopen", reset)
|
||||||
|
with pytest.raises(rc.ReleaseError, match="reset by peer"):
|
||||||
|
rc.download("https://x/y", tmp_path / "y")
|
||||||
|
with pytest.raises(rc.ReleaseError, match="reset by peer"):
|
||||||
|
rc.forgejo_api("x", "a/b", "/releases")
|
||||||
|
|
|
||||||
|
|
@ -63,6 +63,36 @@ def test_app_list_json_with_one_app(tmp_path, monkeypatch, capsys):
|
||||||
assert m["settings"][0]["name"] == "SMB_USER"
|
assert m["settings"][0]["name"] == "SMB_USER"
|
||||||
assert m["settings"][0]["required"] is True
|
assert m["settings"][0]["required"] is True
|
||||||
assert m["settings"][0]["default"] == "furtka"
|
assert m["settings"][0]["default"] == "furtka"
|
||||||
|
assert m["internet"] == {"viable": False, "port": None}
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_connect_bg_dispatches_to_run_connect(tmp_path, monkeypatch):
|
||||||
|
"""CLI `gateway connect-bg <url> <token> <name>` must call
|
||||||
|
gateway.run_connect(url, token, name) — the entry point the HTTP API
|
||||||
|
fires via systemd-run for POST /api/gateway/connect."""
|
||||||
|
_set_env(monkeypatch, tmp_path)
|
||||||
|
from furtka import gateway
|
||||||
|
|
||||||
|
called = []
|
||||||
|
monkeypatch.setattr(
|
||||||
|
gateway, "run_connect", lambda url, token, name: called.append((url, token, name))
|
||||||
|
)
|
||||||
|
rc = main(["gateway", "connect-bg", "https://gw.example.com", "reg-token", "my-box"])
|
||||||
|
assert rc == 0
|
||||||
|
assert called == [("https://gw.example.com", "reg-token", "my-box")]
|
||||||
|
|
||||||
|
|
||||||
|
def test_gateway_connect_bg_returns_1_on_failure(tmp_path, monkeypatch, capsys):
|
||||||
|
_set_env(monkeypatch, tmp_path)
|
||||||
|
from furtka import gateway
|
||||||
|
|
||||||
|
def boom(url, token, name):
|
||||||
|
raise RuntimeError("gateway unreachable")
|
||||||
|
|
||||||
|
monkeypatch.setattr(gateway, "run_connect", boom)
|
||||||
|
rc = main(["gateway", "connect-bg", "https://gw.example.com", "reg-token", "my-box"])
|
||||||
|
assert rc == 1
|
||||||
|
assert "gateway connect-bg failed" in capsys.readouterr().err
|
||||||
|
|
||||||
|
|
||||||
def test_reconcile_dry_run_empty(tmp_path, monkeypatch, capsys):
|
def test_reconcile_dry_run_empty(tmp_path, monkeypatch, capsys):
|
||||||
|
|
|
||||||
|
|
@ -1,47 +1,63 @@
|
||||||
|
import json
|
||||||
|
|
||||||
|
import drives
|
||||||
|
import pytest
|
||||||
from drives import (
|
from drives import (
|
||||||
get_drive_type_label,
|
MIN_DISK_GB,
|
||||||
|
_boot_device_from_cmdline,
|
||||||
|
classify_drive,
|
||||||
|
format_size,
|
||||||
get_drive_type_score,
|
get_drive_type_score,
|
||||||
get_size_score,
|
get_size_score,
|
||||||
parse_lsblk_output,
|
parse_lsblk_json,
|
||||||
parse_size_gb,
|
|
||||||
score_device,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
GB = 1024**3
|
||||||
def test_parse_size_gb_terabytes():
|
|
||||||
assert parse_size_gb("1T") == 1024.0
|
|
||||||
|
|
||||||
|
|
||||||
def test_parse_size_gb_gigabytes():
|
def _lsblk(*entries):
|
||||||
assert parse_size_gb("500G") == 500.0
|
"""Build lsblk -J output. Each entry: (name, size_gb, type, extra-dict)."""
|
||||||
|
devs = []
|
||||||
|
for name, size_gb, dev_type, *extra in entries:
|
||||||
|
d = {
|
||||||
|
"name": name,
|
||||||
|
"size": int(size_gb * GB),
|
||||||
|
"type": dev_type,
|
||||||
|
"ro": False,
|
||||||
|
"rm": False,
|
||||||
|
"tran": "sata",
|
||||||
|
"rota": True,
|
||||||
|
}
|
||||||
|
if extra:
|
||||||
|
d.update(extra[0])
|
||||||
|
devs.append(d)
|
||||||
|
return json.dumps({"blockdevices": devs})
|
||||||
|
|
||||||
|
|
||||||
def test_parse_size_gb_megabytes():
|
@pytest.fixture(autouse=True)
|
||||||
assert parse_size_gb("2048M") == 2.0
|
def _smart_passed(monkeypatch):
|
||||||
|
monkeypatch.setattr(drives, "_smart_status", lambda _: "passed")
|
||||||
|
|
||||||
|
|
||||||
def test_parse_size_gb_european_comma_decimal():
|
def _names(devices):
|
||||||
assert parse_size_gb("1,5T") == 1.5 * 1024
|
return [d["name"] for d in devices]
|
||||||
|
|
||||||
|
|
||||||
def test_parse_size_gb_empty_returns_none():
|
def test_classify_uses_transport_and_rotation():
|
||||||
assert parse_size_gb("") is None
|
assert classify_drive("nvme0n1", tran="nvme", rota=False) == "NVMe"
|
||||||
|
assert classify_drive("sda", tran="sata", rota=False) == "SSD"
|
||||||
|
assert classify_drive("sda", tran="sata", rota=True) == "HDD"
|
||||||
|
assert classify_drive("mmcblk0", tran="", rota=False) == "eMMC"
|
||||||
|
assert classify_drive("sdb", tran="usb", rota=False) == "USB"
|
||||||
|
assert classify_drive("sdc", tran="", rota=True, removable=True) == "USB"
|
||||||
|
# SD cards in a built-in reader are removable mmc — still eMMC/mmc class.
|
||||||
|
assert classify_drive("mmcblk1", tran="", rota=False, removable=True) == "eMMC"
|
||||||
|
|
||||||
|
|
||||||
def test_parse_size_gb_unknown_unit_returns_none():
|
def test_type_scores_rank_internal_over_usb():
|
||||||
assert parse_size_gb("500K") is None
|
assert get_drive_type_score("NVMe") > get_drive_type_score("SSD")
|
||||||
|
assert get_drive_type_score("SSD") > get_drive_type_score("HDD")
|
||||||
|
assert get_drive_type_score("HDD") > get_drive_type_score("USB")
|
||||||
def test_drive_type_score_nvme():
|
|
||||||
assert get_drive_type_score("/dev/nvme0n1") == 15
|
|
||||||
|
|
||||||
|
|
||||||
def test_drive_type_score_ssd():
|
|
||||||
assert get_drive_type_score("/dev/ssd0") == 10
|
|
||||||
|
|
||||||
|
|
||||||
def test_drive_type_score_hdd_fallback():
|
|
||||||
assert get_drive_type_score("/dev/sda") == 5
|
|
||||||
|
|
||||||
|
|
||||||
def test_size_score_bands():
|
def test_size_score_bands():
|
||||||
|
|
@ -51,67 +67,145 @@ def test_size_score_bands():
|
||||||
assert get_size_score(1024) == 10
|
assert get_size_score(1024) == 10
|
||||||
|
|
||||||
|
|
||||||
def test_score_device_sums_type_and_size(monkeypatch):
|
def test_format_size():
|
||||||
import drives
|
assert format_size(500 * GB) == "500 GB"
|
||||||
|
assert format_size(1024 * GB) == "1 TB"
|
||||||
monkeypatch.setattr(drives, "get_drive_health", lambda _: 10)
|
assert format_size(int(1.5 * 1024 * GB)) == "1.5 TB"
|
||||||
assert score_device("/dev/nvme0n1", 1024) == 15 + 10 + 10
|
assert format_size(int(7.5 * GB)) == "7.5 GB"
|
||||||
assert score_device("/dev/sda", 64) == 5 + 10 + 5
|
|
||||||
|
|
||||||
|
|
||||||
def test_parse_lsblk_drops_loop_and_rom(monkeypatch):
|
def test_drops_loop_rom_zram_and_emmc_boot_areas():
|
||||||
import drives
|
out = _lsblk(
|
||||||
|
("loop0", 2.5, "loop"),
|
||||||
monkeypatch.setattr(drives, "_smart_status", lambda _: "passed")
|
("sr0", 1, "rom"),
|
||||||
output = "loop0 2.5G loop\nsr0 1024M rom\nsda 500G disk\nnvme0n1 1T disk\n"
|
("zram0", 4, "disk"),
|
||||||
devices = parse_lsblk_output(output)
|
("mmcblk0boot0", 0.004, "disk"),
|
||||||
names = [d["name"] for d in devices]
|
("mmcblk0boot1", 0.004, "disk"),
|
||||||
assert names == ["/dev/nvme0n1", "/dev/sda"]
|
("mmcblk0rpmb", 0.004, "disk"),
|
||||||
|
("mmcblk0", 64, "disk", {"tran": "", "rota": False}),
|
||||||
|
)
|
||||||
|
assert _names(parse_lsblk_json(out)) == ["/dev/mmcblk0"]
|
||||||
|
|
||||||
|
|
||||||
def test_parse_lsblk_attaches_human_labels(monkeypatch):
|
def test_drops_empty_card_reader_slots_and_read_only_disks():
|
||||||
import drives
|
out = _lsblk(
|
||||||
|
("sdc", 0, "disk", {"rm": True, "tran": "usb"}),
|
||||||
monkeypatch.setattr(drives, "_smart_status", lambda _: "passed")
|
("sdd", 500, "disk", {"ro": True}),
|
||||||
output = "nvme0n1 1T disk\n"
|
("sda", 500, "disk"),
|
||||||
[dev] = parse_lsblk_output(output)
|
)
|
||||||
assert dev["type_label"] == "NVMe"
|
assert _names(parse_lsblk_json(out)) == ["/dev/sda"]
|
||||||
assert dev["health_label"] == "Healthy"
|
|
||||||
|
|
||||||
|
|
||||||
def test_parse_lsblk_surfaces_smart_warning(monkeypatch):
|
def test_ssd_beats_bigger_hdd():
|
||||||
import drives
|
# Regression: sdX SSDs used to be labelled HDD, so the 2 TB spinning disk
|
||||||
|
# won the recommendation over the 256 GB SSD.
|
||||||
|
out = _lsblk(
|
||||||
|
("sda", 2048, "disk", {"rota": True}),
|
||||||
|
("sdb", 256, "disk", {"rota": False}),
|
||||||
|
)
|
||||||
|
devices = parse_lsblk_json(out)
|
||||||
|
assert _names(devices) == ["/dev/sdb", "/dev/sda"]
|
||||||
|
assert [d["type_label"] for d in devices] == ["SSD", "HDD"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_usb_disk_ranked_after_internal():
|
||||||
|
out = _lsblk(
|
||||||
|
("sda", 32, "disk", {"tran": "usb", "rota": False, "rm": True}),
|
||||||
|
("mmcblk0", 32, "disk", {"tran": "", "rota": False}),
|
||||||
|
)
|
||||||
|
devices = parse_lsblk_json(out)
|
||||||
|
assert _names(devices) == ["/dev/mmcblk0", "/dev/sda"]
|
||||||
|
assert devices[1]["warning"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_too_small_disk_listed_but_unusable_and_last():
|
||||||
|
out = _lsblk(
|
||||||
|
("sda", MIN_DISK_GB - 1, "disk", {"rota": False}),
|
||||||
|
("sdb", 500, "disk"),
|
||||||
|
)
|
||||||
|
devices = parse_lsblk_json(out)
|
||||||
|
assert _names(devices) == ["/dev/sdb", "/dev/sda"]
|
||||||
|
assert devices[0]["usable"] is True
|
||||||
|
assert devices[1]["usable"] is False
|
||||||
|
assert str(MIN_DISK_GB) in devices[1]["reason"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_bios_warns_about_disks_over_2tb():
|
||||||
|
out = _lsblk(("sda", 4096, "disk"))
|
||||||
|
[bios] = parse_lsblk_json(out, uefi=False)
|
||||||
|
[efi] = parse_lsblk_json(out, uefi=True)
|
||||||
|
assert "2 TB" in bios["warning"]
|
||||||
|
assert efi["warning"] == ""
|
||||||
|
|
||||||
|
|
||||||
|
def test_surfaces_smart_warning(monkeypatch):
|
||||||
monkeypatch.setattr(drives, "_smart_status", lambda _: "failed")
|
monkeypatch.setattr(drives, "_smart_status", lambda _: "failed")
|
||||||
[dev] = parse_lsblk_output("sda 500G disk\n")
|
[dev] = parse_lsblk_json(_lsblk(("sda", 500, "disk")))
|
||||||
assert dev["health_label"] == "SMART warning"
|
assert dev["health_label"] == "SMART warning"
|
||||||
|
|
||||||
|
|
||||||
def test_drive_type_label_nvme_ssd_hdd():
|
def test_accepts_old_util_linux_string_flags():
|
||||||
assert get_drive_type_label("/dev/nvme0n1") == "NVMe"
|
out = json.dumps(
|
||||||
assert get_drive_type_label("/dev/ssd0") == "SSD"
|
{
|
||||||
assert get_drive_type_label("/dev/sda") == "HDD"
|
"blockdevices": [
|
||||||
|
{
|
||||||
|
"name": "sda",
|
||||||
|
"size": str(500 * GB),
|
||||||
|
"type": "disk",
|
||||||
|
"ro": "0",
|
||||||
|
"rm": "0",
|
||||||
|
"tran": "sata",
|
||||||
|
"rota": "0",
|
||||||
|
},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
)
|
||||||
|
[dev] = parse_lsblk_json(out)
|
||||||
|
assert dev["type_label"] == "SSD"
|
||||||
|
|
||||||
|
|
||||||
def test_parse_lsblk_handles_empty_output():
|
def test_handles_empty_and_garbage_output():
|
||||||
assert parse_lsblk_output("") == []
|
assert parse_lsblk_json("") == []
|
||||||
|
assert parse_lsblk_json("not json") == []
|
||||||
|
|
||||||
|
|
||||||
def test_parse_lsblk_drops_boot_usb(monkeypatch):
|
def test_drops_boot_usb():
|
||||||
import drives
|
out = _lsblk(
|
||||||
|
("sda", 500, "disk"),
|
||||||
monkeypatch.setattr(drives, "_smart_status", lambda _: "passed")
|
("sdb", 16, "disk", {"tran": "usb"}),
|
||||||
output = "sda 500G disk\nsdb 16G disk\nnvme0n1 1T disk\n"
|
("nvme0n1", 1024, "disk", {"tran": "nvme", "rota": False}),
|
||||||
devices = parse_lsblk_output(output, boot_disk="sdb")
|
)
|
||||||
names = [d["name"] for d in devices]
|
assert _names(parse_lsblk_json(out, boot_disk="sdb")) == ["/dev/nvme0n1", "/dev/sda"]
|
||||||
assert "/dev/sdb" not in names
|
|
||||||
assert names == ["/dev/nvme0n1", "/dev/sda"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_parse_lsblk_no_boot_disk_keeps_all(monkeypatch):
|
def test_boot_device_from_cmdline(monkeypatch):
|
||||||
import drives
|
calls = []
|
||||||
|
|
||||||
monkeypatch.setattr(drives, "_smart_status", lambda _: "passed")
|
class R:
|
||||||
output = "sda 500G disk\nsdb 16G disk\n"
|
returncode = 0
|
||||||
names = [d["name"] for d in parse_lsblk_output(output, boot_disk=None)]
|
stdout = "/dev/sdb1\n"
|
||||||
assert set(names) == {"/dev/sda", "/dev/sdb"}
|
|
||||||
|
monkeypatch.setattr(drives, "_run", lambda cmd, **_: calls.append(cmd) or R())
|
||||||
|
cmdline = "BOOT_IMAGE=/vmlinuz archisosearchuuid=2026-08-25-10-00-00-00 quiet"
|
||||||
|
assert _boot_device_from_cmdline(cmdline) == "/dev/sdb1"
|
||||||
|
assert calls[-1] == ["blkid", "-U", "2026-08-25-10-00-00-00"]
|
||||||
|
assert _boot_device_from_cmdline("archisolabel=FURTKA_2620") == "/dev/sdb1"
|
||||||
|
assert calls[-1] == ["blkid", "-L", "FURTKA_2620"]
|
||||||
|
assert _boot_device_from_cmdline("archisodevice=/dev/sr0") == "/dev/sr0"
|
||||||
|
assert _boot_device_from_cmdline("quiet splash") is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_boot_disk_whole_disk_iso(monkeypatch):
|
||||||
|
# dd-written stick: ISO filesystem on the whole disk, PKNAME empty.
|
||||||
|
class R:
|
||||||
|
def __init__(self, out):
|
||||||
|
self.returncode = 0
|
||||||
|
self.stdout = out
|
||||||
|
|
||||||
|
def fake_run(cmd, **_):
|
||||||
|
if cmd[0] == "findmnt":
|
||||||
|
return R("/dev/sdb\n")
|
||||||
|
return R("\n")
|
||||||
|
|
||||||
|
monkeypatch.setattr(drives, "_run", fake_run)
|
||||||
|
assert drives._boot_disk_name() == "sdb"
|
||||||
|
|
|
||||||
350
tests/test_gateway.py
Normal file
|
|
@ -0,0 +1,350 @@
|
||||||
|
"""Tests for furtka.gateway — the box-side register/rotate/deregister client.
|
||||||
|
|
||||||
|
Same shape as test_updater.py's network tests: monkeypatch
|
||||||
|
urllib.request.urlopen directly rather than standing up a real server.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import urllib.error
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from furtka import gateway
|
||||||
|
|
||||||
|
|
||||||
|
class _FakeResp:
|
||||||
|
def __init__(self, body: dict):
|
||||||
|
self._body = json.dumps(body).encode()
|
||||||
|
|
||||||
|
def __enter__(self):
|
||||||
|
return self
|
||||||
|
|
||||||
|
def __exit__(self, *a):
|
||||||
|
return False
|
||||||
|
|
||||||
|
def read(self):
|
||||||
|
return self._body
|
||||||
|
|
||||||
|
|
||||||
|
WG = {
|
||||||
|
"private_key": "cHJpdmF0ZS1rZXk=",
|
||||||
|
"address": "10.8.0.2/24",
|
||||||
|
"server_public_key": "c2VydmVyLXB1YmxpYy1rZXk=",
|
||||||
|
"endpoint": "gateway.example.com:51820",
|
||||||
|
"allowed_ips": "10.8.0.0/24",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def gw(tmp_path, monkeypatch):
|
||||||
|
monkeypatch.setenv("FURTKA_GATEWAY_CONFIG", str(tmp_path / "gateway.json"))
|
||||||
|
monkeypatch.setenv("FURTKA_GATEWAY_CONNECT_STATE", str(tmp_path / "gateway-connect-state.json"))
|
||||||
|
monkeypatch.setenv("FURTKA_GATEWAY_CONNECT_LOCK", str(tmp_path / "gateway-connect.lock"))
|
||||||
|
import importlib
|
||||||
|
|
||||||
|
from furtka import paths as p
|
||||||
|
|
||||||
|
importlib.reload(p)
|
||||||
|
importlib.reload(gateway)
|
||||||
|
return gateway
|
||||||
|
|
||||||
|
|
||||||
|
def test_load_config_returns_none_when_never_registered(gw):
|
||||||
|
assert gw.load_config() is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_register_saves_config(gw, monkeypatch):
|
||||||
|
calls = []
|
||||||
|
|
||||||
|
def fake_urlopen(req, timeout):
|
||||||
|
calls.append((req.full_url, json.loads(req.data)))
|
||||||
|
return _FakeResp({"box_id": "abc123", "box_token": "abc123.secret", "wg": WG})
|
||||||
|
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", fake_urlopen)
|
||||||
|
|
||||||
|
config = gw.register("https://gw.example.com/", "reg-token", "my-box")
|
||||||
|
|
||||||
|
assert config["gateway_url"] == "https://gw.example.com" # trailing slash stripped
|
||||||
|
assert config["box_id"] == "abc123"
|
||||||
|
assert config["box_token"] == "abc123.secret"
|
||||||
|
assert config["wg"] == WG
|
||||||
|
assert gw.load_config() == config
|
||||||
|
|
||||||
|
url, body = calls[0]
|
||||||
|
assert url == "https://gw.example.com/v1/boxes/register"
|
||||||
|
assert body == {"registration_token": "reg-token", "box_name": "my-box"}
|
||||||
|
|
||||||
|
|
||||||
|
def test_register_config_file_is_0600(gw, monkeypatch, tmp_path):
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"urllib.request.urlopen",
|
||||||
|
lambda req, timeout: _FakeResp({"box_id": "abc", "box_token": "abc.x", "wg": WG}),
|
||||||
|
)
|
||||||
|
gw.register("https://gw.example.com", "tok", "box")
|
||||||
|
from furtka.paths import gateway_config_file
|
||||||
|
|
||||||
|
assert oct(gateway_config_file().stat().st_mode)[-3:] == "600"
|
||||||
|
|
||||||
|
|
||||||
|
def test_register_raises_gateway_error_on_http_error(gw, monkeypatch):
|
||||||
|
def raising(req, timeout):
|
||||||
|
raise urllib.error.HTTPError(req.full_url, 401, "invalid registration token", {}, None)
|
||||||
|
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", raising)
|
||||||
|
|
||||||
|
with pytest.raises(gateway.GatewayError, match="HTTP 401"):
|
||||||
|
gw.register("https://gw.example.com", "bad-token", "my-box")
|
||||||
|
assert gw.load_config() is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_rotate_token_updates_stored_config(gw, monkeypatch):
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"urllib.request.urlopen",
|
||||||
|
lambda req, timeout: _FakeResp({"box_id": "abc", "box_token": "abc.old", "wg": WG}),
|
||||||
|
)
|
||||||
|
gw.register("https://gw.example.com", "tok", "box")
|
||||||
|
|
||||||
|
def fake_rotate(req, timeout):
|
||||||
|
assert req.headers.get("Authorization") == "Bearer abc.old"
|
||||||
|
assert req.full_url == "https://gw.example.com/v1/boxes/abc/rotate-token"
|
||||||
|
return _FakeResp({"box_token": "abc.new"})
|
||||||
|
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", fake_rotate)
|
||||||
|
|
||||||
|
new_token = gw.rotate_token()
|
||||||
|
|
||||||
|
assert new_token == "abc.new"
|
||||||
|
assert gw.load_config()["box_token"] == "abc.new"
|
||||||
|
|
||||||
|
|
||||||
|
def test_rotate_token_without_prior_registration_raises(gw):
|
||||||
|
with pytest.raises(gateway.GatewayError, match="not connected"):
|
||||||
|
gw.rotate_token()
|
||||||
|
|
||||||
|
|
||||||
|
def test_deregister_calls_gateway_and_clears_config(gw, monkeypatch):
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"urllib.request.urlopen",
|
||||||
|
lambda req, timeout: _FakeResp({"box_id": "abc", "box_token": "abc.x", "wg": WG}),
|
||||||
|
)
|
||||||
|
gw.register("https://gw.example.com", "tok", "box")
|
||||||
|
|
||||||
|
calls = []
|
||||||
|
|
||||||
|
def fake_deregister(req, timeout):
|
||||||
|
calls.append(req.full_url)
|
||||||
|
return _FakeResp({"status": "ok"})
|
||||||
|
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", fake_deregister)
|
||||||
|
|
||||||
|
gw.deregister()
|
||||||
|
|
||||||
|
assert calls == ["https://gw.example.com/v1/boxes/abc/deregister"]
|
||||||
|
assert gw.load_config() is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_deregister_when_never_registered_is_a_noop(gw, monkeypatch):
|
||||||
|
calls = []
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", lambda req, timeout: calls.append(1))
|
||||||
|
gw.deregister()
|
||||||
|
assert calls == []
|
||||||
|
|
||||||
|
|
||||||
|
def test_publish_route_requires_connection(gw):
|
||||||
|
with pytest.raises(gateway.GatewayError, match="not connected"):
|
||||||
|
gw.publish_route("vaultwarden", "vault.example.com", 8081)
|
||||||
|
|
||||||
|
|
||||||
|
def test_publish_route_posts_to_routes_endpoint(gw, monkeypatch):
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"urllib.request.urlopen",
|
||||||
|
lambda req, timeout: _FakeResp({"box_id": "abc", "box_token": "abc.x", "wg": WG}),
|
||||||
|
)
|
||||||
|
gw.register("https://gw.example.com", "tok", "box")
|
||||||
|
|
||||||
|
def fake_publish(req, timeout):
|
||||||
|
assert req.full_url == "https://gw.example.com/v1/routes"
|
||||||
|
assert req.headers.get("Authorization") == "Bearer abc.x"
|
||||||
|
assert json.loads(req.data) == {
|
||||||
|
"app_name": "vaultwarden",
|
||||||
|
"subdomain": "vault.example.com",
|
||||||
|
"port": 8081,
|
||||||
|
}
|
||||||
|
return _FakeResp({"route_id": "r1", "public_url": "https://vault.example.com/"})
|
||||||
|
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", fake_publish)
|
||||||
|
|
||||||
|
result = gw.publish_route("vaultwarden", "vault.example.com", 8081)
|
||||||
|
|
||||||
|
assert result == {"route_id": "r1", "public_url": "https://vault.example.com/"}
|
||||||
|
|
||||||
|
|
||||||
|
def test_unpublish_route_requires_connection(gw):
|
||||||
|
with pytest.raises(gateway.GatewayError, match="not connected"):
|
||||||
|
gw.unpublish_route("r1")
|
||||||
|
|
||||||
|
|
||||||
|
def test_unpublish_route_calls_delete_endpoint(gw, monkeypatch):
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"urllib.request.urlopen",
|
||||||
|
lambda req, timeout: _FakeResp({"box_id": "abc", "box_token": "abc.x", "wg": WG}),
|
||||||
|
)
|
||||||
|
gw.register("https://gw.example.com", "tok", "box")
|
||||||
|
|
||||||
|
calls = []
|
||||||
|
|
||||||
|
def fake_delete(req, timeout):
|
||||||
|
calls.append((req.full_url, req.get_method(), req.headers.get("Authorization")))
|
||||||
|
return _FakeResp({"status": "ok"})
|
||||||
|
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", fake_delete)
|
||||||
|
|
||||||
|
gw.unpublish_route("r1")
|
||||||
|
|
||||||
|
assert calls == [("https://gw.example.com/v1/routes/r1", "DELETE", "Bearer abc.x")]
|
||||||
|
|
||||||
|
|
||||||
|
def test_write_and_read_state_round_trip(gw):
|
||||||
|
gw.write_state("registering")
|
||||||
|
s = gw.read_state()
|
||||||
|
assert s["stage"] == "registering"
|
||||||
|
assert "updated_at" in s
|
||||||
|
|
||||||
|
|
||||||
|
def test_read_state_missing_file_returns_empty_dict(gw):
|
||||||
|
assert gw.read_state() == {}
|
||||||
|
|
||||||
|
|
||||||
|
def test_acquire_lock_contention(gw):
|
||||||
|
first = gw.acquire_lock()
|
||||||
|
try:
|
||||||
|
with pytest.raises(gateway.GatewayError, match="already in progress"):
|
||||||
|
gw.acquire_lock()
|
||||||
|
finally:
|
||||||
|
first.close()
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_connect_happy_path(gw, monkeypatch):
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"urllib.request.urlopen",
|
||||||
|
lambda req, timeout: _FakeResp({"box_id": "abc", "box_token": "abc.x", "wg": WG}),
|
||||||
|
)
|
||||||
|
tunnel_calls = []
|
||||||
|
monkeypatch.setattr(
|
||||||
|
gw.wireguard,
|
||||||
|
"set_tunnel_enabled",
|
||||||
|
lambda enabled, wg=None: tunnel_calls.append((enabled, wg)),
|
||||||
|
)
|
||||||
|
|
||||||
|
gw.run_connect("https://gw.example.com", "tok", "my-box")
|
||||||
|
|
||||||
|
assert tunnel_calls == [(True, WG)]
|
||||||
|
assert gw.read_state()["stage"] == "done"
|
||||||
|
assert gw.load_config()["box_id"] == "abc"
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_connect_registration_failure_writes_error_state(gw, monkeypatch):
|
||||||
|
def raising(req, timeout):
|
||||||
|
raise urllib.error.HTTPError(req.full_url, 401, "invalid registration token", {}, None)
|
||||||
|
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", raising)
|
||||||
|
|
||||||
|
gw.run_connect("https://gw.example.com", "bad-tok", "my-box")
|
||||||
|
|
||||||
|
state = gw.read_state()
|
||||||
|
assert state["stage"] == "error"
|
||||||
|
assert "401" in state["error"]
|
||||||
|
assert gw.load_config() is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_connect_tunnel_failure_writes_error_state(gw, monkeypatch):
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"urllib.request.urlopen",
|
||||||
|
lambda req, timeout: _FakeResp({"box_id": "abc", "box_token": "abc.x", "wg": WG}),
|
||||||
|
)
|
||||||
|
|
||||||
|
def failing_tunnel(enabled, wg=None):
|
||||||
|
raise gw.wireguard.WireguardError("systemctl failed: bad config")
|
||||||
|
|
||||||
|
monkeypatch.setattr(gw.wireguard, "set_tunnel_enabled", failing_tunnel)
|
||||||
|
|
||||||
|
gw.run_connect("https://gw.example.com", "tok", "my-box")
|
||||||
|
|
||||||
|
state = gw.read_state()
|
||||||
|
assert state["stage"] == "error"
|
||||||
|
assert "bad config" in state["error"]
|
||||||
|
# Registration itself succeeded — config is still saved even though the
|
||||||
|
# tunnel failed to come up, so a retry doesn't need to re-register.
|
||||||
|
assert gw.load_config()["box_id"] == "abc"
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_connect_retry_after_tunnel_failure_reuses_registration(gw, monkeypatch):
|
||||||
|
register_calls = []
|
||||||
|
|
||||||
|
def urlopen(req, timeout):
|
||||||
|
register_calls.append(req.full_url)
|
||||||
|
return _FakeResp({"box_id": "abc", "box_token": "abc.x", "wg": WG})
|
||||||
|
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", urlopen)
|
||||||
|
|
||||||
|
def failing_tunnel(enabled, wg=None):
|
||||||
|
raise gw.wireguard.WireguardError("systemctl failed: unit missing")
|
||||||
|
|
||||||
|
monkeypatch.setattr(gw.wireguard, "set_tunnel_enabled", failing_tunnel)
|
||||||
|
gw.run_connect("https://gw.example.com", "tok", "my-box")
|
||||||
|
assert gw.read_state()["stage"] == "error"
|
||||||
|
|
||||||
|
tunnel_calls = []
|
||||||
|
monkeypatch.setattr(
|
||||||
|
gw.wireguard,
|
||||||
|
"set_tunnel_enabled",
|
||||||
|
lambda enabled, wg=None: tunnel_calls.append((enabled, wg)),
|
||||||
|
)
|
||||||
|
gw.run_connect("https://gw.example.com/", "tok", "my-box")
|
||||||
|
|
||||||
|
# Registered exactly once; the retry only brought the tunnel up.
|
||||||
|
assert register_calls == ["https://gw.example.com/v1/boxes/register"]
|
||||||
|
assert tunnel_calls == [(True, WG)]
|
||||||
|
assert gw.read_state()["stage"] == "done"
|
||||||
|
assert gw.load_config()["box_id"] == "abc"
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_connect_refuses_a_different_gateway_while_registered(gw, monkeypatch):
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"urllib.request.urlopen",
|
||||||
|
lambda req, timeout: _FakeResp({"box_id": "abc", "box_token": "abc.x", "wg": WG}),
|
||||||
|
)
|
||||||
|
gw.register("https://gw.example.com", "tok", "box")
|
||||||
|
|
||||||
|
def must_not_call(req, timeout):
|
||||||
|
raise AssertionError("must not register with a second gateway")
|
||||||
|
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", must_not_call)
|
||||||
|
monkeypatch.setattr(gw.wireguard, "set_tunnel_enabled", lambda enabled, wg=None: None)
|
||||||
|
|
||||||
|
gw.run_connect("https://other.example.com", "tok", "box")
|
||||||
|
|
||||||
|
state = gw.read_state()
|
||||||
|
assert state["stage"] == "error"
|
||||||
|
assert "disconnect first" in state["error"]
|
||||||
|
assert gw.load_config()["gateway_url"] == "https://gw.example.com"
|
||||||
|
|
||||||
|
|
||||||
|
def test_deregister_failure_keeps_local_config_for_retry(gw, monkeypatch):
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"urllib.request.urlopen",
|
||||||
|
lambda req, timeout: _FakeResp({"box_id": "abc", "box_token": "abc.x", "wg": WG}),
|
||||||
|
)
|
||||||
|
gw.register("https://gw.example.com", "tok", "box")
|
||||||
|
|
||||||
|
def raising(req, timeout):
|
||||||
|
raise urllib.error.URLError("connection refused")
|
||||||
|
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", raising)
|
||||||
|
|
||||||
|
with pytest.raises(gateway.GatewayError):
|
||||||
|
gw.deregister()
|
||||||
|
# Local config must survive so the caller can retry later.
|
||||||
|
assert gw.load_config() is not None
|
||||||
|
|
@ -113,7 +113,7 @@ def test_set_force_enable_writes_both_snippets_and_reloads(tmp_path):
|
||||||
|
|
||||||
result = https.set_force_https(True, reload_caddy=fake_reload, **p)
|
result = https.set_force_https(True, reload_caddy=fake_reload, **p)
|
||||||
assert result is True
|
assert result is True
|
||||||
assert p["snippet"].read_text() == https.REDIRECT_CONTENT
|
assert p["snippet"].read_text() == https._redirect_snippet_content("testbox")
|
||||||
written = p["https_snippet"].read_text()
|
written = p["https_snippet"].read_text()
|
||||||
assert "testbox.local, testbox" in written
|
assert "testbox.local, testbox" in written
|
||||||
assert "tls internal" in written
|
assert "tls internal" in written
|
||||||
|
|
@ -135,7 +135,7 @@ def test_set_force_disable_removes_both_snippets(tmp_path):
|
||||||
p = _paths(tmp_path)
|
p = _paths(tmp_path)
|
||||||
p["snippet_dir"].mkdir()
|
p["snippet_dir"].mkdir()
|
||||||
p["https_snippet_dir"].mkdir()
|
p["https_snippet_dir"].mkdir()
|
||||||
p["snippet"].write_text(https.REDIRECT_CONTENT)
|
p["snippet"].write_text(https._redirect_snippet_content("testbox"))
|
||||||
p["https_snippet"].write_text("furtka.local { tls internal }\n")
|
p["https_snippet"].write_text("furtka.local { tls internal }\n")
|
||||||
|
|
||||||
result = https.set_force_https(False, reload_caddy=lambda: None, **p)
|
result = https.set_force_https(False, reload_caddy=lambda: None, **p)
|
||||||
|
|
@ -199,10 +199,16 @@ def test_systemctl_missing_raises_and_rolls_back(tmp_path):
|
||||||
assert not p["https_snippet"].exists()
|
assert not p["https_snippet"].exists()
|
||||||
|
|
||||||
|
|
||||||
def test_redirect_snippet_content_is_caddy_redir_directive():
|
def test_redirect_snippet_only_covers_cert_names_and_is_temporary():
|
||||||
# Lock the exact directive. A regression here silently stops the
|
# Lock the exact directives. A regression here silently stops the
|
||||||
# redirect from taking effect even though the file-swap looks fine.
|
# redirect from taking effect even though the file-swap looks fine.
|
||||||
assert https.REDIRECT_CONTENT.strip() == "redir https://{host}{uri} permanent"
|
# Only the names the tls-internal block has a cert for are redirected
|
||||||
|
# (an IP would hit a failing TLS handshake), and 302 so switching HTTPS
|
||||||
|
# off isn't stuck in browser caches like the old 301 was.
|
||||||
|
assert https._redirect_snippet_content("mybox") == (
|
||||||
|
"@furtka_https_host host mybox.local mybox\n"
|
||||||
|
"redir @furtka_https_host https://{host}{uri} 302\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_https_snippet_content_has_tls_internal_and_routes(tmp_path):
|
def test_https_snippet_content_has_tls_internal_and_routes(tmp_path):
|
||||||
|
|
|
||||||
|
|
@ -478,3 +478,35 @@ def test_parse_hook_output_furtka_json_rejects_bad_payload(runner):
|
||||||
def test_parse_hook_output_furtka_json_invalid_json(runner):
|
def test_parse_hook_output_furtka_json_invalid_json(runner):
|
||||||
with pytest.raises(runner.InstallRunnerError, match="invalid FURTKA_JSON"):
|
with pytest.raises(runner.InstallRunnerError, match="invalid FURTKA_JSON"):
|
||||||
runner._parse_hook_output("FURTKA_JSON: {not json}\n")
|
runner._parse_hook_output("FURTKA_JSON: {not json}\n")
|
||||||
|
|
||||||
|
|
||||||
|
def test_clear_stale_state_resets_abandoned_install(runner):
|
||||||
|
import time
|
||||||
|
|
||||||
|
runner.write_state("pulling_image", app="fileshare")
|
||||||
|
# Fresh state: could still be the runner starting up — leave it alone.
|
||||||
|
assert runner.clear_stale_state() is False
|
||||||
|
assert runner.read_state()["stage"] == "pulling_image"
|
||||||
|
# Two minutes later with nobody holding the lock: interrupted.
|
||||||
|
assert runner.clear_stale_state(now=time.time() + 120) is True
|
||||||
|
state = runner.read_state()
|
||||||
|
assert state["stage"] == "error"
|
||||||
|
assert state["app"] == "fileshare"
|
||||||
|
assert "interrupted" in state["error"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_clear_stale_state_keeps_running_install(runner):
|
||||||
|
import time
|
||||||
|
|
||||||
|
runner.write_state("pulling_image", app="fileshare")
|
||||||
|
fh = runner.acquire_lock()
|
||||||
|
try:
|
||||||
|
assert runner.clear_stale_state(now=time.time() + 3600) is False
|
||||||
|
assert runner.read_state()["stage"] == "pulling_image"
|
||||||
|
finally:
|
||||||
|
fh.close()
|
||||||
|
|
||||||
|
|
||||||
|
def test_read_state_tolerates_non_object(runner):
|
||||||
|
runner.state_path().write_text("[1, 2]")
|
||||||
|
assert runner.read_state() == {}
|
||||||
|
|
|
||||||
|
|
@ -462,3 +462,58 @@ def test_install_plan_skips_already_installed(tmp_path, fake_dirs, monkeypatch):
|
||||||
)
|
)
|
||||||
installer.install_plan(plan)
|
installer.install_plan(plan)
|
||||||
assert calls == ["a"]
|
assert calls == ["a"]
|
||||||
|
|
||||||
|
|
||||||
|
# --- hardening: app names, validate-before-write, .env quoting --------------
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("bad", ["/", ".", "..", "../catalog", "a/b", "", "UPPER"])
|
||||||
|
def test_remove_refuses_non_app_names(fake_dirs, bad):
|
||||||
|
apps, _ = fake_dirs
|
||||||
|
(apps / "fileshare").mkdir()
|
||||||
|
with pytest.raises(installer.InstallError, match="not a valid app name"):
|
||||||
|
installer.remove(bad)
|
||||||
|
assert (apps / "fileshare").exists()
|
||||||
|
assert apps.exists()
|
||||||
|
|
||||||
|
|
||||||
|
def test_update_env_refuses_non_app_names(fake_dirs):
|
||||||
|
with pytest.raises(installer.InstallError, match="not a valid app name"):
|
||||||
|
installer.update_env("..", {"X": "1"})
|
||||||
|
|
||||||
|
|
||||||
|
def test_rejected_path_setting_never_reaches_env(tmp_path, fake_dirs):
|
||||||
|
media = tmp_path / "media"
|
||||||
|
media.mkdir()
|
||||||
|
src = _write_app_source(tmp_path, "jellyfin", PATH_MANIFEST)
|
||||||
|
installer.install_from(src, settings={"MEDIA_PATH": str(media)})
|
||||||
|
env = apps_dir() / "jellyfin" / ".env"
|
||||||
|
with pytest.raises(installer.InstallError, match="system path"):
|
||||||
|
installer.update_env("jellyfin", {"MEDIA_PATH": "/etc"})
|
||||||
|
assert "/etc" not in env.read_text()
|
||||||
|
assert f"MEDIA_PATH={media}" in env.read_text()
|
||||||
|
|
||||||
|
|
||||||
|
def test_newline_in_setting_is_rejected(tmp_path, fake_dirs):
|
||||||
|
m = dict(VALID_MANIFEST, settings=[{"name": "PW", "label": "PW", "type": "password"}])
|
||||||
|
src = _write_app_source(tmp_path, "fileshare", m)
|
||||||
|
with pytest.raises(installer.InstallError, match="line breaks"):
|
||||||
|
installer.install_from(src, settings={"PW": "abc\nCOMPOSE_PROJECT_NAME=x"})
|
||||||
|
env = apps_dir() / "fileshare" / ".env"
|
||||||
|
assert not env.exists() or "COMPOSE_PROJECT_NAME" not in env.read_text()
|
||||||
|
|
||||||
|
|
||||||
|
def test_dollar_values_are_single_quoted_and_round_trip(tmp_path):
|
||||||
|
env = tmp_path / ".env"
|
||||||
|
values = {"PW": "pa$word", "B": "has space", "C": "it's $5", "D": "plain"}
|
||||||
|
installer.write_env(env, values)
|
||||||
|
text = env.read_text()
|
||||||
|
assert "PW='pa$word'" in text
|
||||||
|
assert "D=plain" in text
|
||||||
|
assert installer.read_env_values(env) == values
|
||||||
|
|
||||||
|
|
||||||
|
def test_manifest_name_must_be_app_name(tmp_path, fake_dirs):
|
||||||
|
src = _write_app_source(tmp_path, "evil", dict(VALID_MANIFEST, name="../evil"))
|
||||||
|
with pytest.raises(installer.InstallError, match="lowercase"):
|
||||||
|
installer.install_from(src)
|
||||||
|
|
|
||||||
|
|
@ -292,3 +292,57 @@ def test_requires_rejects_empty_hook_string(tmp_path):
|
||||||
path = _write_app(tmp_path, "z2m", payload)
|
path = _write_app(tmp_path, "z2m", payload)
|
||||||
with pytest.raises(ManifestError, match="non-empty string"):
|
with pytest.raises(ManifestError, match="non-empty string"):
|
||||||
load_manifest(path)
|
load_manifest(path)
|
||||||
|
|
||||||
|
|
||||||
|
def test_internet_optional_defaults_non_viable(tmp_path):
|
||||||
|
path = _write_app(tmp_path, "fileshare", VALID_MANIFEST)
|
||||||
|
m = load_manifest(path)
|
||||||
|
assert m.internet.viable is False
|
||||||
|
assert m.internet.port is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_internet_viable_parsed(tmp_path):
|
||||||
|
payload = dict(VALID_MANIFEST, internet={"viable": True, "port": 445})
|
||||||
|
path = _write_app(tmp_path, "fileshare", payload)
|
||||||
|
m = load_manifest(path)
|
||||||
|
assert m.internet.viable is True
|
||||||
|
assert m.internet.port == 445
|
||||||
|
|
||||||
|
|
||||||
|
def test_internet_non_viable_ignores_port(tmp_path):
|
||||||
|
# A non-viable app doesn't need a port at all — and if one is present
|
||||||
|
# anyway (e.g. a stale field left behind), it's simply ignored rather
|
||||||
|
# than validated, since it has no effect either way.
|
||||||
|
payload = dict(VALID_MANIFEST, internet={"viable": False, "port": 9999})
|
||||||
|
path = _write_app(tmp_path, "fileshare", payload)
|
||||||
|
m = load_manifest(path)
|
||||||
|
assert m.internet.viable is False
|
||||||
|
assert m.internet.port is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_internet_viable_requires_port(tmp_path):
|
||||||
|
payload = dict(VALID_MANIFEST, internet={"viable": True})
|
||||||
|
path = _write_app(tmp_path, "fileshare", payload)
|
||||||
|
with pytest.raises(ManifestError, match="internet.port must be an integer"):
|
||||||
|
load_manifest(path)
|
||||||
|
|
||||||
|
|
||||||
|
def test_internet_port_must_be_declared(tmp_path):
|
||||||
|
payload = dict(VALID_MANIFEST, internet={"viable": True, "port": 9999})
|
||||||
|
path = _write_app(tmp_path, "fileshare", payload)
|
||||||
|
with pytest.raises(ManifestError, match="must be one of the declared ports"):
|
||||||
|
load_manifest(path)
|
||||||
|
|
||||||
|
|
||||||
|
def test_internet_non_object_rejected(tmp_path):
|
||||||
|
payload = dict(VALID_MANIFEST, internet=True)
|
||||||
|
path = _write_app(tmp_path, "fileshare", payload)
|
||||||
|
with pytest.raises(ManifestError, match="internet must be an object"):
|
||||||
|
load_manifest(path)
|
||||||
|
|
||||||
|
|
||||||
|
def test_internet_port_must_be_int_not_bool(tmp_path):
|
||||||
|
payload = dict(VALID_MANIFEST, internet={"viable": True, "port": True})
|
||||||
|
path = _write_app(tmp_path, "fileshare", payload)
|
||||||
|
with pytest.raises(ManifestError, match="internet.port must be an integer"):
|
||||||
|
load_manifest(path)
|
||||||
|
|
|
||||||
|
|
@ -463,3 +463,107 @@ def test_check_update_raises_when_no_releases_published(updater, monkeypatch):
|
||||||
monkeypatch.setattr(updater, "_forgejo_api", lambda path: [])
|
monkeypatch.setattr(updater, "_forgejo_api", lambda path: [])
|
||||||
with pytest.raises(updater.UpdateError, match="no releases"):
|
with pytest.raises(updater.UpdateError, match="no releases"):
|
||||||
updater.check_update()
|
updater.check_update()
|
||||||
|
|
||||||
|
|
||||||
|
def test_apply_update_rolls_back_on_oserror_and_restores_caddyfile(tmp_path, updater, monkeypatch):
|
||||||
|
"""A non-UpdateError after the symlink flip (disk full writing the
|
||||||
|
Caddyfile) used to leave the new version live with no rollback."""
|
||||||
|
versions = updater.versions_dir()
|
||||||
|
versions.mkdir(parents=True)
|
||||||
|
(versions / "26.0-alpha").mkdir()
|
||||||
|
current = updater.current_symlink()
|
||||||
|
current.symlink_to(versions / "26.0-alpha")
|
||||||
|
caddyfile = tmp_path / "etc_caddy" / "Caddyfile"
|
||||||
|
caddyfile.parent.mkdir()
|
||||||
|
caddyfile.write_text("# old routes\n")
|
||||||
|
|
||||||
|
tar = tmp_path / "t.tar.gz"
|
||||||
|
_make_tarball(tar, "26.1-alpha")
|
||||||
|
|
||||||
|
def full_disk(_source):
|
||||||
|
caddyfile.write_text("# half-written new routes\n")
|
||||||
|
raise OSError(28, "No space left on device")
|
||||||
|
|
||||||
|
monkeypatch.setattr(updater, "_refresh_caddyfile", full_disk)
|
||||||
|
monkeypatch.setattr(updater, "_run", lambda cmd: None)
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
monkeypatch.setattr(subprocess, "run", lambda *a, **kw: None)
|
||||||
|
|
||||||
|
with pytest.raises(updater.UpdateError, match="rolled back"):
|
||||||
|
updater.apply_update(tar, "26.1-alpha")
|
||||||
|
assert current.resolve() == (versions / "26.0-alpha").resolve()
|
||||||
|
assert caddyfile.read_text() == "# old routes\n"
|
||||||
|
assert updater.read_state()["stage"] == "rolled_back"
|
||||||
|
|
||||||
|
|
||||||
|
def test_swap_symlink_replaces_existing_link(tmp_path, updater):
|
||||||
|
a, b = tmp_path / "a", tmp_path / "b"
|
||||||
|
a.mkdir()
|
||||||
|
b.mkdir()
|
||||||
|
link = tmp_path / "current"
|
||||||
|
link.symlink_to(a)
|
||||||
|
updater._swap_symlink(link, b)
|
||||||
|
assert link.resolve() == b.resolve()
|
||||||
|
assert not (tmp_path / "current.new").exists()
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_update_writes_error_stage_on_download_failure(updater, monkeypatch):
|
||||||
|
class _Check:
|
||||||
|
update_available = True
|
||||||
|
latest = "26.1-alpha"
|
||||||
|
current = "26.0-alpha"
|
||||||
|
tarball_url = "http://x/t.tar.gz"
|
||||||
|
sha256_url = "http://x/t.sha256"
|
||||||
|
|
||||||
|
def fake_check():
|
||||||
|
return _Check()
|
||||||
|
|
||||||
|
monkeypatch.setattr(updater, "check_update", fake_check)
|
||||||
|
|
||||||
|
def boom(url, dest):
|
||||||
|
raise OSError(28, "No space left on device")
|
||||||
|
|
||||||
|
monkeypatch.setattr(updater, "_download", boom)
|
||||||
|
with pytest.raises(updater.UpdateError, match="No space left"):
|
||||||
|
updater.run_update()
|
||||||
|
state = updater.read_state()
|
||||||
|
assert state["stage"] == "error"
|
||||||
|
assert "No space left" in state["reason"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_health_check_survives_read_timeout(updater, monkeypatch):
|
||||||
|
def slow(url, timeout):
|
||||||
|
raise TimeoutError("timed out")
|
||||||
|
|
||||||
|
monkeypatch.setattr("urllib.request.urlopen", slow)
|
||||||
|
monkeypatch.setattr(updater.time, "sleep", lambda _s: None)
|
||||||
|
assert updater._health_check("http://127.0.0.1:7000/api/apps", deadline_s=0.05) is False
|
||||||
|
|
||||||
|
|
||||||
|
def test_refresh_caddyfile_migrates_legacy_301_redirect(updater, tmp_path):
|
||||||
|
from furtka import https
|
||||||
|
|
||||||
|
snippet_dir = tmp_path / "etc_caddy" / "furtka.d"
|
||||||
|
snippet_dir.mkdir(parents=True)
|
||||||
|
(tmp_path / "etc_caddy" / "furtka-https.d").mkdir()
|
||||||
|
(tmp_path / "etc_caddy" / "furtka-https.d" / "https.caddyfile").write_text("x\n")
|
||||||
|
redirect = snippet_dir / "redirect.caddyfile"
|
||||||
|
redirect.write_text(https.LEGACY_REDIRECT_CONTENT)
|
||||||
|
src = tmp_path / "Caddyfile.src"
|
||||||
|
src.write_text("# caddy\n")
|
||||||
|
updater._refresh_caddyfile(src)
|
||||||
|
assert redirect.read_text() == https._redirect_snippet_content("testbox")
|
||||||
|
|
||||||
|
|
||||||
|
def test_refresh_caddyfile_leaves_custom_redirect_alone(updater, tmp_path):
|
||||||
|
snippet_dir = tmp_path / "etc_caddy" / "furtka.d"
|
||||||
|
snippet_dir.mkdir(parents=True)
|
||||||
|
(tmp_path / "etc_caddy" / "furtka-https.d").mkdir()
|
||||||
|
(tmp_path / "etc_caddy" / "furtka-https.d" / "https.caddyfile").write_text("x\n")
|
||||||
|
redirect = snippet_dir / "redirect.caddyfile"
|
||||||
|
redirect.write_text("# hand-edited\n")
|
||||||
|
src = tmp_path / "Caddyfile.src"
|
||||||
|
src.write_text("# caddy\n")
|
||||||
|
updater._refresh_caddyfile(src)
|
||||||
|
assert redirect.read_text() == "# hand-edited\n"
|
||||||
|
|
|
||||||
204
tests/test_wireguard.py
Normal file
|
|
@ -0,0 +1,204 @@
|
||||||
|
"""Tests for furtka.wireguard — tunnel-config write/remove + systemctl toggle.
|
||||||
|
|
||||||
|
Same shape as test_https.py: stub the systemctl call so we assert the conf
|
||||||
|
file is written/removed and that a reload failure rolls the conf file back
|
||||||
|
to its pre-call state.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from furtka import wireguard
|
||||||
|
|
||||||
|
WG = {
|
||||||
|
"private_key": "cHJpdmF0ZS1rZXk=",
|
||||||
|
"address": "10.8.0.2/24",
|
||||||
|
"server_public_key": "c2VydmVyLXB1YmxpYy1rZXk=",
|
||||||
|
"endpoint": "gateway.example.com:51820",
|
||||||
|
"allowed_ips": "10.8.0.0/24",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_conf_content_shape():
|
||||||
|
content = wireguard._conf_content(WG)
|
||||||
|
assert "[Interface]" in content
|
||||||
|
assert "PrivateKey = cHJpdmF0ZS1rZXk=" in content
|
||||||
|
assert "Address = 10.8.0.2/24" in content
|
||||||
|
assert "[Peer]" in content
|
||||||
|
assert "PublicKey = c2VydmVyLXB1YmxpYy1rZXk=" in content
|
||||||
|
assert "Endpoint = gateway.example.com:51820" in content
|
||||||
|
assert "AllowedIPs = 10.8.0.0/24" in content
|
||||||
|
assert "PersistentKeepalive = 25" in content
|
||||||
|
|
||||||
|
|
||||||
|
def test_conf_content_omits_preshared_key_when_absent():
|
||||||
|
# WG has no "preshared_key" key at all — the v14-gateway shape.
|
||||||
|
content = wireguard._conf_content(WG)
|
||||||
|
assert "PresharedKey" not in content
|
||||||
|
|
||||||
|
|
||||||
|
def test_conf_content_includes_preshared_key_when_present():
|
||||||
|
# v15-gateway shape (see furtka-gateway's wgeasy_v15.py) — the server
|
||||||
|
# enforces this even if the client's own conf omits it, so dropping it
|
||||||
|
# here would break the handshake silently.
|
||||||
|
wg = {**WG, "preshared_key": "cHJlc2hhcmVkLWtleQ=="}
|
||||||
|
content = wireguard._conf_content(wg)
|
||||||
|
assert "PresharedKey = cHJlc2hhcmVkLWtleQ==" in content
|
||||||
|
# Must sit between PublicKey and Endpoint, inside [Peer].
|
||||||
|
peer_section = content.split("[Peer]\n", 1)[1]
|
||||||
|
assert (
|
||||||
|
peer_section.index("PublicKey")
|
||||||
|
< peer_section.index("PresharedKey")
|
||||||
|
< peer_section.index("Endpoint")
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_enable_requires_wg_config(tmp_path):
|
||||||
|
with pytest.raises(ValueError, match="wg config is required"):
|
||||||
|
wireguard.set_tunnel_enabled(True, conf_path=tmp_path / "furtka-gw.conf")
|
||||||
|
|
||||||
|
|
||||||
|
def test_enable_surfaces_clean_error_on_unreadable_conf_dir(tmp_path, monkeypatch):
|
||||||
|
# Simulated rather than via a 0o000 directory: CI runs as root, which
|
||||||
|
# ignores directory permissions.
|
||||||
|
def denied(self, *a, **kw):
|
||||||
|
raise PermissionError(13, "Permission denied", str(self))
|
||||||
|
|
||||||
|
monkeypatch.setattr(Path, "mkdir", denied)
|
||||||
|
|
||||||
|
def must_not_reload(action):
|
||||||
|
raise AssertionError("systemctl must not run when the conf can't be written")
|
||||||
|
|
||||||
|
conf_path = tmp_path / "restricted" / "furtka-gw.conf"
|
||||||
|
with pytest.raises(wireguard.WireguardError, match="could not access"):
|
||||||
|
wireguard.set_tunnel_enabled(True, wg=WG, conf_path=conf_path, reload=must_not_reload)
|
||||||
|
|
||||||
|
|
||||||
|
def test_default_conf_path_uses_env_override(monkeypatch, tmp_path):
|
||||||
|
monkeypatch.setenv("FURTKA_WIREGUARD_CONF", str(tmp_path / "custom.conf"))
|
||||||
|
assert wireguard.default_conf_path() == tmp_path / "custom.conf"
|
||||||
|
|
||||||
|
|
||||||
|
def test_default_conf_path_default_when_unset(monkeypatch):
|
||||||
|
monkeypatch.delenv("FURTKA_WIREGUARD_CONF", raising=False)
|
||||||
|
assert wireguard.default_conf_path() == wireguard.DEFAULT_CONF_PATH
|
||||||
|
|
||||||
|
|
||||||
|
def test_enable_writes_conf_and_calls_reload(tmp_path):
|
||||||
|
conf_path = tmp_path / "furtka-gw.conf"
|
||||||
|
calls = []
|
||||||
|
|
||||||
|
def fake_reload(action):
|
||||||
|
calls.append(action)
|
||||||
|
|
||||||
|
result = wireguard.set_tunnel_enabled(True, wg=WG, conf_path=conf_path, reload=fake_reload)
|
||||||
|
|
||||||
|
assert result is True
|
||||||
|
assert calls == ["enable"]
|
||||||
|
content = conf_path.read_text()
|
||||||
|
assert "PrivateKey = cHJpdmF0ZS1rZXk=" in content
|
||||||
|
assert oct(conf_path.stat().st_mode)[-3:] == "600"
|
||||||
|
|
||||||
|
|
||||||
|
def test_disable_removes_conf_and_calls_reload(tmp_path):
|
||||||
|
conf_path = tmp_path / "furtka-gw.conf"
|
||||||
|
conf_path.write_text(wireguard._conf_content(WG))
|
||||||
|
calls = []
|
||||||
|
|
||||||
|
result = wireguard.set_tunnel_enabled(
|
||||||
|
False, conf_path=conf_path, reload=lambda action: calls.append(action)
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result is False
|
||||||
|
assert calls == ["disable"]
|
||||||
|
assert not conf_path.exists()
|
||||||
|
|
||||||
|
|
||||||
|
def test_disable_is_idempotent_when_already_off(tmp_path):
|
||||||
|
conf_path = tmp_path / "furtka-gw.conf"
|
||||||
|
result = wireguard.set_tunnel_enabled(False, conf_path=conf_path, reload=lambda action: None)
|
||||||
|
assert result is False
|
||||||
|
assert not conf_path.exists()
|
||||||
|
|
||||||
|
|
||||||
|
def test_reload_failure_rolls_back_enable(tmp_path):
|
||||||
|
conf_path = tmp_path / "furtka-gw.conf"
|
||||||
|
|
||||||
|
def failing_reload(action):
|
||||||
|
raise subprocess.CalledProcessError(1, ["systemctl"], stderr="bad config")
|
||||||
|
|
||||||
|
with pytest.raises(wireguard.WireguardError, match="systemctl failed: bad config"):
|
||||||
|
wireguard.set_tunnel_enabled(True, wg=WG, conf_path=conf_path, reload=failing_reload)
|
||||||
|
# No conf existed before this call, so none should exist after rollback.
|
||||||
|
assert not conf_path.exists()
|
||||||
|
|
||||||
|
|
||||||
|
def test_reload_failure_rolls_back_disable(tmp_path):
|
||||||
|
conf_path = tmp_path / "furtka-gw.conf"
|
||||||
|
original = wireguard._conf_content(WG)
|
||||||
|
conf_path.write_text(original)
|
||||||
|
|
||||||
|
def failing_reload(action):
|
||||||
|
raise subprocess.CalledProcessError(1, ["systemctl"], stderr="bad config")
|
||||||
|
|
||||||
|
with pytest.raises(wireguard.WireguardError):
|
||||||
|
wireguard.set_tunnel_enabled(False, conf_path=conf_path, reload=failing_reload)
|
||||||
|
assert conf_path.read_text() == original
|
||||||
|
|
||||||
|
|
||||||
|
def test_systemctl_missing_raises_and_rolls_back(tmp_path):
|
||||||
|
conf_path = tmp_path / "furtka-gw.conf"
|
||||||
|
|
||||||
|
def missing_systemctl(action):
|
||||||
|
raise FileNotFoundError(2, "No such file", "systemctl")
|
||||||
|
|
||||||
|
with pytest.raises(wireguard.WireguardError, match="systemctl not available"):
|
||||||
|
wireguard.set_tunnel_enabled(True, wg=WG, conf_path=conf_path, reload=missing_systemctl)
|
||||||
|
assert not conf_path.exists()
|
||||||
|
|
||||||
|
|
||||||
|
def test_status_not_configured(tmp_path):
|
||||||
|
s = wireguard.status(conf_path=tmp_path / "does-not-exist.conf")
|
||||||
|
assert s == {"configured": False, "latest_handshake": None}
|
||||||
|
|
||||||
|
|
||||||
|
def test_status_survives_unreadable_conf_path(tmp_path, monkeypatch):
|
||||||
|
"""Regression: an inaccessible parent directory raises PermissionError
|
||||||
|
even for a path that doesn't exist yet — confirmed by actually hitting
|
||||||
|
this against a real box's /etc/wireguard/ as a non-root user, which
|
||||||
|
crashed the whole /api/gateway/status request with a raw traceback.
|
||||||
|
A read-only status check must degrade to "not configured", never 500.
|
||||||
|
"""
|
||||||
|
|
||||||
|
# Simulated rather than via a 0o000 directory: CI runs as root, which
|
||||||
|
# ignores directory permissions.
|
||||||
|
def denied(self):
|
||||||
|
raise PermissionError(13, "Permission denied", str(self))
|
||||||
|
|
||||||
|
monkeypatch.setattr(Path, "is_file", denied)
|
||||||
|
|
||||||
|
s = wireguard.status(conf_path=tmp_path / "restricted" / "furtka-gw.conf")
|
||||||
|
assert s == {"configured": False, "latest_handshake": None}
|
||||||
|
|
||||||
|
|
||||||
|
def test_status_configured_reports_handshake(tmp_path):
|
||||||
|
conf_path = tmp_path / "furtka-gw.conf"
|
||||||
|
conf_path.write_text(wireguard._conf_content(WG))
|
||||||
|
|
||||||
|
s = wireguard.status(conf_path=conf_path, wg_show=lambda: "1234567890")
|
||||||
|
|
||||||
|
assert s == {"configured": True, "latest_handshake": "1234567890"}
|
||||||
|
|
||||||
|
|
||||||
|
def test_status_configured_but_wg_tools_missing(tmp_path):
|
||||||
|
conf_path = tmp_path / "furtka-gw.conf"
|
||||||
|
conf_path.write_text(wireguard._conf_content(WG))
|
||||||
|
|
||||||
|
def missing_wg():
|
||||||
|
raise FileNotFoundError(2, "No such file", "wg")
|
||||||
|
|
||||||
|
s = wireguard.status(conf_path=conf_path, wg_show=missing_wg)
|
||||||
|
|
||||||
|
assert s == {"configured": True, "latest_handshake": None}
|
||||||
|
|
@ -8,6 +8,8 @@ import os
|
||||||
import re
|
import re
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
|
import threading
|
||||||
|
import traceback
|
||||||
from datetime import UTC
|
from datetime import UTC
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
@ -76,6 +78,35 @@ settings = {
|
||||||
HOSTNAME_RE = re.compile(r"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$")
|
HOSTNAME_RE = re.compile(r"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$")
|
||||||
USERNAME_RE = re.compile(r"^[a-z_][a-z0-9_-]{0,31}$")
|
USERNAME_RE = re.compile(r"^[a-z_][a-z0-9_-]{0,31}$")
|
||||||
|
|
||||||
|
# Accounts that already exist on the installed system (base + the packages
|
||||||
|
# we install). Picking one of these either fails user creation mid-install
|
||||||
|
# (root) or makes the admin collide with a service account (caddy, docker…).
|
||||||
|
RESERVED_USERNAMES = frozenset(
|
||||||
|
{
|
||||||
|
"root",
|
||||||
|
"bin",
|
||||||
|
"daemon",
|
||||||
|
"mail",
|
||||||
|
"ftp",
|
||||||
|
"http",
|
||||||
|
"nobody",
|
||||||
|
"dbus",
|
||||||
|
"git",
|
||||||
|
"uuidd",
|
||||||
|
"avahi",
|
||||||
|
"caddy",
|
||||||
|
"docker",
|
||||||
|
"polkitd",
|
||||||
|
"rtkit",
|
||||||
|
"systemd-coredump",
|
||||||
|
"systemd-journal-remote",
|
||||||
|
"systemd-network",
|
||||||
|
"systemd-oom",
|
||||||
|
"systemd-resolve",
|
||||||
|
"systemd-timesync",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
# Ordered phase markers for the install progress bar. Each tuple is
|
# Ordered phase markers for the install progress bar. Each tuple is
|
||||||
# (substring to search for in the archinstall log, progress percent when
|
# (substring to search for in the archinstall log, progress percent when
|
||||||
# reached, user-facing label). Pick the furthest phase whose marker is
|
# reached, user-facing label). Pick the furthest phase whose marker is
|
||||||
|
|
@ -108,7 +139,13 @@ PROGRESS_ERROR_HINTS = [
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
def parse_install_progress(log):
|
def parse_install_progress(log, exit_code=None):
|
||||||
|
"""Progress dict from the install log.
|
||||||
|
|
||||||
|
`exit_code` is archinstall's return code once the process has ended
|
||||||
|
(None while running or unknown). A non-zero exit is an error even when
|
||||||
|
the log has no Traceback — OOM kills and signals print nothing.
|
||||||
|
"""
|
||||||
percent = 2
|
percent = 2
|
||||||
phase = "Starting up…"
|
phase = "Starting up…"
|
||||||
for marker, pct, label in PROGRESS_PHASES:
|
for marker, pct, label in PROGRESS_PHASES:
|
||||||
|
|
@ -118,7 +155,7 @@ def parse_install_progress(log):
|
||||||
|
|
||||||
if percent >= 100:
|
if percent >= 100:
|
||||||
status = "done"
|
status = "done"
|
||||||
elif any(m in log for m in PROGRESS_ERROR_MARKERS):
|
elif any(m in log for m in PROGRESS_ERROR_MARKERS) or exit_code not in (None, 0):
|
||||||
status = "error"
|
status = "error"
|
||||||
phase = "Installation failed — open Show details below"
|
phase = "Installation failed — open Show details below"
|
||||||
for marker, hint in PROGRESS_ERROR_HINTS:
|
for marker, hint in PROGRESS_ERROR_HINTS:
|
||||||
|
|
@ -127,24 +164,39 @@ def parse_install_progress(log):
|
||||||
break
|
break
|
||||||
else:
|
else:
|
||||||
status = "running"
|
status = "running"
|
||||||
|
if percent == 18:
|
||||||
|
# archinstall waits for NTP time sync with no timeout. Only a hint:
|
||||||
|
# it usually clears on its own within a minute.
|
||||||
|
phase = (
|
||||||
|
"Syncing time and packages — if this takes more than a few "
|
||||||
|
"minutes, check that the network cable is plugged in"
|
||||||
|
)
|
||||||
|
|
||||||
return {"percent": percent, "phase": phase, "status": status}
|
return {"percent": percent, "phase": phase, "status": status}
|
||||||
|
|
||||||
|
|
||||||
def validate_step1(form):
|
def validate_step1(form):
|
||||||
errors = []
|
errors = []
|
||||||
|
# Lowercase instead of rejecting "Furtka" / "Daniel" — Linux needs
|
||||||
|
# lowercase, people type names the way they write them.
|
||||||
values = {
|
values = {
|
||||||
"hostname": form.get("hostname", "").strip(),
|
"hostname": form.get("hostname", "").strip().lower(),
|
||||||
"username": form.get("username", "").strip(),
|
"username": form.get("username", "").strip().lower(),
|
||||||
"password": form.get("password", ""),
|
"password": form.get("password", ""),
|
||||||
"language": form.get("language", ""),
|
"language": form.get("language", ""),
|
||||||
}
|
}
|
||||||
password2 = form.get("password2", "")
|
password2 = form.get("password2", "")
|
||||||
|
|
||||||
if not HOSTNAME_RE.match(values["hostname"]):
|
if not HOSTNAME_RE.match(values["hostname"]):
|
||||||
errors.append("Hostname must be lowercase letters, digits, hyphens (max 63 chars).")
|
errors.append(
|
||||||
|
"The server name can only use letters, digits and hyphens (no spaces, max 63)."
|
||||||
|
)
|
||||||
if not USERNAME_RE.match(values["username"]):
|
if not USERNAME_RE.match(values["username"]):
|
||||||
errors.append("Username must start with a letter or underscore, lowercase only.")
|
errors.append(
|
||||||
|
"The username must start with a letter and can only use letters, digits, - and _."
|
||||||
|
)
|
||||||
|
elif values["username"] in RESERVED_USERNAMES:
|
||||||
|
errors.append(f"“{values['username']}” is reserved by the system — please pick another.")
|
||||||
if len(values["password"]) < 8:
|
if len(values["password"]) < 8:
|
||||||
errors.append("Password must be at least 8 characters.")
|
errors.append("Password must be at least 8 characters.")
|
||||||
if values["password"] != password2:
|
if values["password"] != password2:
|
||||||
|
|
@ -438,6 +490,16 @@ def _post_install_commands(hostname, admin_username, admin_password):
|
||||||
# Initial status.json so Caddy doesn't 404 before furtka-status fires.
|
# Initial status.json so Caddy doesn't 404 before furtka-status fires.
|
||||||
_write_file_cmd("/var/lib/furtka/status.json", _read_asset("www/status.json")),
|
_write_file_cmd("/var/lib/furtka/status.json", _read_asset("www/status.json")),
|
||||||
nss_sed,
|
nss_sed,
|
||||||
|
# The installed system inherits the live ISO's networkd config
|
||||||
|
# (DHCP on every Ethernet + Wi-Fi link) but not its wait-online
|
||||||
|
# drop-in, so a board with a second, unplugged NIC stalled boot for
|
||||||
|
# up to 2 minutes before network-online.target. Any one link is
|
||||||
|
# enough for a home server.
|
||||||
|
_write_file_cmd(
|
||||||
|
"/etc/systemd/system/systemd-networkd-wait-online.service.d/any-interface.conf",
|
||||||
|
"[Service]\nExecStart=\n"
|
||||||
|
"ExecStart=/usr/lib/systemd/systemd-networkd-wait-online --any\n",
|
||||||
|
),
|
||||||
# Resource manager bootstrap: extract tarball → versions/<ver>/,
|
# Resource manager bootstrap: extract tarball → versions/<ver>/,
|
||||||
# symlink current, install wrapper, systemctl-link unit files.
|
# symlink current, install wrapper, systemctl-link unit files.
|
||||||
*_resource_manager_commands(),
|
*_resource_manager_commands(),
|
||||||
|
|
@ -453,10 +515,20 @@ def _post_install_commands(hostname, admin_username, admin_password):
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
def _detect_bootloader():
|
def _detect_bootloader(efi_dir=Path("/sys/firmware/efi")):
|
||||||
# systemd-boot is UEFI-only; on BIOS/legacy it trips HardwareIncompatibilityError
|
# systemd-boot is UEFI-only; on BIOS/legacy it trips HardwareIncompatibilityError
|
||||||
# inside archinstall. /sys/firmware/efi exists iff we were booted via UEFI.
|
# inside archinstall. /sys/firmware/efi exists iff we were booted via UEFI.
|
||||||
return "Systemd-boot" if Path("/sys/firmware/efi").exists() else "Grub"
|
if not efi_dir.exists():
|
||||||
|
return "Grub"
|
||||||
|
# 64-bit CPU behind 32-bit UEFI (Atom Bay Trail / Cherry Trail mini-PCs
|
||||||
|
# and tablets): Arch ships no ia32 systemd-boot, and archinstall's GRUB
|
||||||
|
# path hardcodes --target=x86_64-efi. Its Limine path installs both
|
||||||
|
# BOOTIA32.EFI and BOOTX64.EFI and picks the entry by firmware bitness.
|
||||||
|
try:
|
||||||
|
bitness = (efi_dir / "fw_platform_size").read_text().strip()
|
||||||
|
except OSError:
|
||||||
|
bitness = "64"
|
||||||
|
return "Limine" if bitness == "32" else "Systemd-boot"
|
||||||
|
|
||||||
|
|
||||||
def build_archinstall_config(s):
|
def build_archinstall_config(s):
|
||||||
|
|
@ -487,6 +559,9 @@ def build_archinstall_config(s):
|
||||||
"caddy",
|
"caddy",
|
||||||
"avahi",
|
"avahi",
|
||||||
"nss-mdns",
|
"nss-mdns",
|
||||||
|
# furtka-gateway tunnel — furtka/wireguard.py drives
|
||||||
|
# wg-quick@furtka-gw.service, which ships in this package.
|
||||||
|
"wireguard-tools",
|
||||||
# Resource manager runtime — pure-stdlib Python, no pip needed
|
# Resource manager runtime — pure-stdlib Python, no pip needed
|
||||||
# because we expose the package via PYTHONPATH in /usr/local/bin/furtka.
|
# because we expose the package via PYTHONPATH in /usr/local/bin/furtka.
|
||||||
"python",
|
"python",
|
||||||
|
|
@ -570,6 +645,16 @@ def spawn_archinstall(config_path, creds_path, log_path):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@app.before_request
|
||||||
|
def _stay_on_progress_while_installing():
|
||||||
|
# While archinstall runs, the wizard pages would let a second browser
|
||||||
|
# (or Back) edit settings that no longer apply — show the progress.
|
||||||
|
running = _install_proc is not None and _install_proc.poll() is None
|
||||||
|
if running and request.endpoint in ("install_step_1", "install_step_2", "install_overview"):
|
||||||
|
return redirect(url_for("install_log_view"))
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
@app.route("/")
|
@app.route("/")
|
||||||
def home():
|
def home():
|
||||||
return redirect(url_for("install_step_1"))
|
return redirect(url_for("install_step_1"))
|
||||||
|
|
@ -594,32 +679,89 @@ def install_step_1():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# Size/type of the disk picked in step 2, for the confirm page (re-probing
|
||||||
|
# would re-run smartctl on every disk).
|
||||||
|
_selected_drive: dict = {}
|
||||||
|
|
||||||
|
|
||||||
@app.route("/install/step2", methods=["GET", "POST"])
|
@app.route("/install/step2", methods=["GET", "POST"])
|
||||||
def install_step_2():
|
def install_step_2():
|
||||||
|
drives = list_scored_devices()
|
||||||
|
error = ""
|
||||||
if request.method == "POST":
|
if request.method == "POST":
|
||||||
boot_drive = request.form.get("boot_drive", "").strip()
|
boot_drive = request.form.get("boot_drive", "").strip()
|
||||||
if boot_drive:
|
# Only accept a disk we actually offered — never a free-form path.
|
||||||
|
picked = next((d for d in drives if d["name"] == boot_drive and d["usable"]), None)
|
||||||
|
if picked:
|
||||||
settings["boot_drive"] = boot_drive
|
settings["boot_drive"] = boot_drive
|
||||||
|
_selected_drive.clear()
|
||||||
|
_selected_drive.update(picked)
|
||||||
return redirect(url_for("install_overview"))
|
return redirect(url_for("install_overview"))
|
||||||
|
error = "Please pick one of the disks below."
|
||||||
return render_template(
|
return render_template(
|
||||||
"install/step2.html",
|
"install/step2.html",
|
||||||
drives=list_scored_devices(),
|
drives=drives,
|
||||||
selected=settings.get("boot_drive", ""),
|
selected=settings.get("boot_drive", ""),
|
||||||
|
error=error,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.route("/install/overview")
|
@app.route("/install/overview")
|
||||||
def install_overview():
|
def install_overview():
|
||||||
|
if not settings["boot_drive"] or not settings["username"]:
|
||||||
|
return redirect(url_for("install_step_1"))
|
||||||
masked = {**settings, "password": "•" * 8 if settings["password"] else ""}
|
masked = {**settings, "password": "•" * 8 if settings["password"] else ""}
|
||||||
return render_template("install/overview.html", settings=masked)
|
drive = _selected_drive if _selected_drive.get("name") == settings["boot_drive"] else None
|
||||||
|
language = LANGUAGES.get(settings["language"], {}).get("label", settings["language"])
|
||||||
|
return render_template(
|
||||||
|
"install/overview.html", settings=masked, drive=drive, language_label=language
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# The running archinstall process, so a second click (double-submit, Back +
|
||||||
|
# Install again, a second browser) can't start another install on the same
|
||||||
|
# disk, and so the progress page can see an exit without a Traceback.
|
||||||
|
_install_proc = None
|
||||||
|
_install_lock = threading.Lock()
|
||||||
|
|
||||||
|
|
||||||
|
def _install_exit_code():
|
||||||
|
return None if _install_proc is None else _install_proc.poll()
|
||||||
|
|
||||||
|
|
||||||
|
def _read_install_log():
|
||||||
|
log = INSTALL_LOG.read_text(errors="replace") if INSTALL_LOG.exists() else ""
|
||||||
|
code = _install_exit_code()
|
||||||
|
if code not in (None, 0):
|
||||||
|
log += f"\n\narchinstall stopped unexpectedly (exit code {code}).\n"
|
||||||
|
return log, code
|
||||||
|
|
||||||
|
|
||||||
@app.route("/install/run", methods=["POST"])
|
@app.route("/install/run", methods=["POST"])
|
||||||
def install_run():
|
def install_run():
|
||||||
if not settings["boot_drive"] or not settings["username"] or not settings["password"]:
|
if not settings["boot_drive"] or not settings["username"] or not settings["password"]:
|
||||||
return redirect(url_for("install_step_1"))
|
return redirect(url_for("install_step_1"))
|
||||||
config_path, creds_path = write_install_files(settings, STATE_DIR)
|
with _install_lock:
|
||||||
|
if _install_proc is not None and _install_proc.poll() is None:
|
||||||
|
return redirect(url_for("install_log_view"))
|
||||||
|
return _start_install()
|
||||||
|
|
||||||
|
|
||||||
|
def _start_install():
|
||||||
|
global _install_proc
|
||||||
|
STATE_DIR.mkdir(parents=True, exist_ok=True)
|
||||||
INSTALL_LOG.write_bytes(b"")
|
INSTALL_LOG.write_bytes(b"")
|
||||||
|
try:
|
||||||
|
config_path, creds_path = write_install_files(settings, STATE_DIR)
|
||||||
|
except Exception:
|
||||||
|
# archinstall's disk probe raises on disks it can't parse (broken
|
||||||
|
# GPT, odd card readers). Put the traceback where the progress page
|
||||||
|
# finds it instead of a bare "Internal Server Error".
|
||||||
|
with INSTALL_LOG.open("a") as fh:
|
||||||
|
fh.write(
|
||||||
|
f"Could not read the layout of {settings['boot_drive']}.\n" + traceback.format_exc()
|
||||||
|
)
|
||||||
|
return redirect(url_for("install_log_view"))
|
||||||
if os.environ.get("FURTKA_DRY_RUN") == "1":
|
if os.environ.get("FURTKA_DRY_RUN") == "1":
|
||||||
INSTALL_LOG.write_text(
|
INSTALL_LOG.write_text(
|
||||||
f"DRY RUN: would exec archinstall --config {config_path} "
|
f"DRY RUN: would exec archinstall --config {config_path} "
|
||||||
|
|
@ -631,33 +773,33 @@ def install_run():
|
||||||
# while those hold the partitions open (first hardware bench, 26.19).
|
# while those hold the partitions open (first hardware bench, 26.19).
|
||||||
with INSTALL_LOG.open("a") as fh:
|
with INSTALL_LOG.open("a") as fh:
|
||||||
fh.write("\n".join(release_disk(settings["boot_drive"])) + "\n\n")
|
fh.write("\n".join(release_disk(settings["boot_drive"])) + "\n\n")
|
||||||
spawn_archinstall(config_path, creds_path, INSTALL_LOG)
|
_install_proc = spawn_archinstall(config_path, creds_path, INSTALL_LOG)
|
||||||
return redirect(url_for("install_log_view"))
|
return redirect(url_for("install_log_view"))
|
||||||
|
|
||||||
|
|
||||||
@app.route("/install/log")
|
@app.route("/install/log")
|
||||||
def install_log_view():
|
def install_log_view():
|
||||||
log = INSTALL_LOG.read_text() if INSTALL_LOG.exists() else ""
|
log, code = _read_install_log()
|
||||||
return render_template(
|
return render_template(
|
||||||
"install/log.html",
|
"install/log.html",
|
||||||
log=log,
|
log=log,
|
||||||
progress=parse_install_progress(log),
|
progress=parse_install_progress(log, code),
|
||||||
hostname=settings["hostname"],
|
hostname=settings["hostname"],
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@app.route("/install/log.json")
|
@app.route("/install/log.json")
|
||||||
def install_log_json():
|
def install_log_json():
|
||||||
log = INSTALL_LOG.read_text() if INSTALL_LOG.exists() else ""
|
log, code = _read_install_log()
|
||||||
return jsonify(log=log, progress=parse_install_progress(log))
|
return jsonify(log=log, progress=parse_install_progress(log, code))
|
||||||
|
|
||||||
|
|
||||||
@app.route("/install/reboot", methods=["POST"])
|
@app.route("/install/reboot", methods=["POST"])
|
||||||
def install_reboot():
|
def install_reboot():
|
||||||
# Only allow rebooting once the install has actually finished — we don't
|
# Only allow rebooting once the install has actually finished — we don't
|
||||||
# want a panicked click during install to reboot mid-pacstrap.
|
# want a panicked click during install to reboot mid-pacstrap.
|
||||||
log = INSTALL_LOG.read_text() if INSTALL_LOG.exists() else ""
|
log, code = _read_install_log()
|
||||||
if parse_install_progress(log)["status"] != "done":
|
if parse_install_progress(log, code)["status"] != "done":
|
||||||
return redirect(url_for("install_log_view"))
|
return redirect(url_for("install_log_view"))
|
||||||
# Delay reboot a few seconds so the browser can finish fetching CSS / assets
|
# Delay reboot a few seconds so the browser can finish fetching CSS / assets
|
||||||
# for the rebooting page before the Flask server (and network) go away.
|
# for the rebooting page before the Flask server (and network) go away.
|
||||||
|
|
|
||||||
|
|
@ -1,55 +1,89 @@
|
||||||
|
import json
|
||||||
|
import re
|
||||||
import subprocess
|
import subprocess
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
# Smallest disk we offer as an install target. The base system plus Docker
|
||||||
|
# needs ~6 GB; the rest is headroom for images and app data.
|
||||||
|
MIN_DISK_GB = 16
|
||||||
|
|
||||||
|
# MBR (what archinstall lays out on BIOS boxes) can't address past 2 TiB.
|
||||||
|
MBR_LIMIT_GB = 2048
|
||||||
|
|
||||||
|
# Block devices lsblk reports as TYPE=disk that are never install targets:
|
||||||
|
# compressed RAM swap and the eMMC hardware boot / RPMB areas (4 MB, usually
|
||||||
|
# read-only) that show up next to mmcblk0 on every eMMC mini-PC and laptop.
|
||||||
|
_PSEUDO_DISK_RE = re.compile(r"^(zram\d+|mmcblk\d+boot\d+|mmcblk\d+rpmb)$")
|
||||||
|
|
||||||
|
_SUBPROCESS_TIMEOUT = 15
|
||||||
|
|
||||||
|
|
||||||
|
def _run(cmd, timeout=_SUBPROCESS_TIMEOUT):
|
||||||
|
"""subprocess.run with a timeout; None when the tool is missing or hangs."""
|
||||||
|
try:
|
||||||
|
return subprocess.run(cmd, capture_output=True, text=True, timeout=timeout)
|
||||||
|
except (FileNotFoundError, subprocess.TimeoutExpired):
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _parent_disk(device):
|
||||||
|
result = _run(["lsblk", "-no", "PKNAME", device])
|
||||||
|
if result is None or result.returncode != 0:
|
||||||
|
return None
|
||||||
|
lines = [line.strip() for line in result.stdout.splitlines() if line.strip()]
|
||||||
|
return lines[0] if lines else None
|
||||||
|
|
||||||
|
|
||||||
|
def _boot_device_from_cmdline(cmdline):
|
||||||
|
"""Resolve the boot partition from archiso's kernel args, or None."""
|
||||||
|
args = dict(arg.split("=", 1) for arg in cmdline.split() if "=" in arg)
|
||||||
|
if args.get("archisodevice", "").startswith("/dev/"):
|
||||||
|
return args["archisodevice"]
|
||||||
|
if args.get("archisosearchuuid"):
|
||||||
|
cmd = ["blkid", "-U", args["archisosearchuuid"]]
|
||||||
|
elif args.get("archisolabel"):
|
||||||
|
cmd = ["blkid", "-L", args["archisolabel"]]
|
||||||
|
else:
|
||||||
|
return None
|
||||||
|
result = _run(cmd)
|
||||||
|
if result is None or result.returncode != 0:
|
||||||
|
return None
|
||||||
|
return result.stdout.strip() or None
|
||||||
|
|
||||||
|
|
||||||
def _boot_disk_name():
|
def _boot_disk_name():
|
||||||
"""Return the parent disk name of the live-ISO boot media (e.g. "sdb"), or None.
|
"""Return the parent disk name of the live-ISO boot media (e.g. "sdb"), or None.
|
||||||
|
|
||||||
On a normal box `/run/archiso/bootmnt` does not exist and we return None,
|
On bare metal booted from USB this is the stick we booted from — we want
|
||||||
leaving the device list untouched. On bare metal booted from USB this is
|
to filter it out so the user can't accidentally pick it as the install
|
||||||
the stick we booted from — we want to filter it out so the user can't
|
target. Primary source is the mount behind /run/archiso/bootmnt; when
|
||||||
accidentally pick it as the install target.
|
that's gone (copytoram unmounts it) fall back to the UUID/label archiso
|
||||||
|
put on the kernel command line.
|
||||||
"""
|
"""
|
||||||
|
partition = None
|
||||||
|
result = _run(["findmnt", "-no", "SOURCE", "/run/archiso/bootmnt"])
|
||||||
|
if result is not None and result.returncode == 0:
|
||||||
|
partition = result.stdout.strip() or None
|
||||||
|
if partition is None:
|
||||||
try:
|
try:
|
||||||
result = subprocess.run(
|
partition = _boot_device_from_cmdline(Path("/proc/cmdline").read_text())
|
||||||
["findmnt", "-no", "SOURCE", "/run/archiso/bootmnt"],
|
except OSError:
|
||||||
capture_output=True,
|
partition = None
|
||||||
text=True,
|
if partition is None:
|
||||||
)
|
|
||||||
except FileNotFoundError:
|
|
||||||
return None
|
return None
|
||||||
if result.returncode != 0:
|
# A stick written with dd has the ISO filesystem on the whole disk, where
|
||||||
return None
|
# PKNAME is empty — the device itself is then the disk.
|
||||||
partition = result.stdout.strip()
|
return _parent_disk(partition) or Path(partition).name
|
||||||
if not partition:
|
|
||||||
return None
|
|
||||||
try:
|
|
||||||
parent = subprocess.run(
|
|
||||||
["lsblk", "-no", "PKNAME", partition],
|
|
||||||
capture_output=True,
|
|
||||||
text=True,
|
|
||||||
)
|
|
||||||
except FileNotFoundError:
|
|
||||||
return None
|
|
||||||
if parent.returncode != 0:
|
|
||||||
return None
|
|
||||||
name = parent.stdout.strip().splitlines()[0] if parent.stdout.strip() else ""
|
|
||||||
return name or None
|
|
||||||
|
|
||||||
|
|
||||||
def _smart_status(device):
|
def _smart_status(device):
|
||||||
try:
|
result = _run(["smartctl", "-H", device])
|
||||||
result = subprocess.run(
|
if result is None:
|
||||||
["smartctl", "-H", device],
|
|
||||||
capture_output=True,
|
|
||||||
)
|
|
||||||
output = result.stdout.decode()
|
|
||||||
if "PASSED" in output:
|
|
||||||
return "passed"
|
|
||||||
elif "FAILED" in output:
|
|
||||||
return "failed"
|
|
||||||
return "unknown"
|
return "unknown"
|
||||||
except Exception as e:
|
if "PASSED" in result.stdout:
|
||||||
print(f"Error checking SMART status for {device}: {e}")
|
return "passed"
|
||||||
|
if "FAILED" in result.stdout:
|
||||||
|
return "failed"
|
||||||
return "unknown"
|
return "unknown"
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -60,40 +94,33 @@ _HEALTH_LABEL = {
|
||||||
"unknown": "Status unknown",
|
"unknown": "Status unknown",
|
||||||
}
|
}
|
||||||
|
|
||||||
|
_TYPE_SCORE = {"NVMe": 15, "SSD": 10, "eMMC": 8, "HDD": 5, "USB": 0}
|
||||||
|
|
||||||
|
|
||||||
def get_drive_health(device):
|
def get_drive_health(device):
|
||||||
return _HEALTH_SCORE[_smart_status(device)]
|
return _HEALTH_SCORE[_smart_status(device)]
|
||||||
|
|
||||||
|
|
||||||
def get_drive_type_score(device):
|
def classify_drive(name, tran="", rota=None, removable=False):
|
||||||
name = device.lower()
|
"""Human label for a disk: NVMe, SSD, eMMC, HDD or USB.
|
||||||
if "nvme" in name:
|
|
||||||
return 15
|
|
||||||
if "ssd" in name:
|
|
||||||
return 10
|
|
||||||
return 5
|
|
||||||
|
|
||||||
|
Uses lsblk's transport and rotational flags — the kernel name alone
|
||||||
def get_drive_type_label(device):
|
can't tell an SSD from a spinning disk (both are sdX).
|
||||||
name = device.lower()
|
"""
|
||||||
if "nvme" in name:
|
tran = (tran or "").lower()
|
||||||
|
if tran == "usb" or (removable and not name.startswith("mmcblk")):
|
||||||
|
return "USB"
|
||||||
|
if tran == "nvme" or name.startswith("nvme"):
|
||||||
return "NVMe"
|
return "NVMe"
|
||||||
if "ssd" in name:
|
if tran == "mmc" or name.startswith("mmcblk"):
|
||||||
|
return "eMMC"
|
||||||
|
if rota is False:
|
||||||
return "SSD"
|
return "SSD"
|
||||||
return "HDD"
|
return "HDD"
|
||||||
|
|
||||||
|
|
||||||
def parse_size_gb(size_str):
|
def get_drive_type_score(type_label):
|
||||||
size_str = size_str.strip().upper().replace(",", ".")
|
return _TYPE_SCORE.get(type_label, 5)
|
||||||
if not size_str:
|
|
||||||
return None
|
|
||||||
if size_str.endswith("T"):
|
|
||||||
return float(size_str[:-1]) * 1024
|
|
||||||
if size_str.endswith("G"):
|
|
||||||
return float(size_str[:-1])
|
|
||||||
if size_str.endswith("M"):
|
|
||||||
return float(size_str[:-1]) / 1024
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def get_size_score(size_gb):
|
def get_size_score(size_gb):
|
||||||
|
|
@ -106,61 +133,98 @@ def get_size_score(size_gb):
|
||||||
return 10
|
return 10
|
||||||
|
|
||||||
|
|
||||||
def score_device(device, size_gb):
|
def format_size(size_bytes):
|
||||||
return get_drive_type_score(device) + get_drive_health(device) + get_size_score(size_gb)
|
gb = size_bytes / 1024**3
|
||||||
|
if gb >= 1024:
|
||||||
|
return f"{gb / 1024:.1f} TB".replace(".0 ", " ")
|
||||||
|
if gb >= 10:
|
||||||
|
return f"{gb:.0f} GB"
|
||||||
|
return f"{gb:.1f} GB"
|
||||||
|
|
||||||
|
|
||||||
def parse_lsblk_output(output, boot_disk=None):
|
def _flag(value):
|
||||||
"""Parse `lsblk -dn -o NAME,SIZE,TYPE` output into scored device dicts.
|
# util-linux ≥2.37 emits JSON booleans; older builds emit "0"/"1".
|
||||||
|
if isinstance(value, bool):
|
||||||
|
return value
|
||||||
|
return str(value).strip() in ("1", "true")
|
||||||
|
|
||||||
Keeps only TYPE=disk so the live ISO's own squashfs (loop) and the boot
|
|
||||||
CD-ROM (rom) don't show up as install targets. If `boot_disk` is given,
|
def parse_lsblk_json(output, boot_disk=None, uefi=True):
|
||||||
that disk is also dropped — it's the USB stick the live ISO booted from
|
"""Parse `lsblk -J -d -b -o NAME,SIZE,TYPE,RO,RM,TRAN,ROTA` into device dicts.
|
||||||
on bare metal, where it appears as TYPE=disk and would otherwise be a
|
|
||||||
valid-looking install target.
|
Keeps only real, writable, non-empty TYPE=disk devices (drops the live
|
||||||
|
ISO's loop/rom, zram, eMMC boot areas, empty card-reader slots) and the
|
||||||
|
USB stick we booted from. Disks too small to install on stay in the list
|
||||||
|
with `usable=False` and a reason so the user sees why they're greyed out.
|
||||||
|
Sorted best-first; unusable disks last.
|
||||||
"""
|
"""
|
||||||
|
try:
|
||||||
|
entries = json.loads(output or "{}").get("blockdevices", [])
|
||||||
|
except json.JSONDecodeError:
|
||||||
|
return []
|
||||||
devices = []
|
devices = []
|
||||||
for line in output.strip().split("\n"):
|
for e in entries:
|
||||||
if not line:
|
name = e.get("name") or ""
|
||||||
|
if e.get("type") != "disk" or not name:
|
||||||
continue
|
continue
|
||||||
parts = line.split()
|
if _PSEUDO_DISK_RE.match(name) or (boot_disk and name == boot_disk):
|
||||||
if len(parts) < 3:
|
|
||||||
continue
|
continue
|
||||||
name, size, dev_type = parts[0], parts[1], parts[2]
|
try:
|
||||||
if dev_type != "disk":
|
size_bytes = int(e.get("size") or 0)
|
||||||
continue
|
except (TypeError, ValueError):
|
||||||
if boot_disk and name == boot_disk:
|
size_bytes = 0
|
||||||
|
if size_bytes <= 0 or _flag(e.get("ro", False)):
|
||||||
continue
|
continue
|
||||||
|
size_gb = size_bytes / 1024**3
|
||||||
|
type_label = classify_drive(
|
||||||
|
name,
|
||||||
|
tran=e.get("tran") or "",
|
||||||
|
rota=_flag(e.get("rota")) if e.get("rota") is not None else None,
|
||||||
|
removable=_flag(e.get("rm", False)),
|
||||||
|
)
|
||||||
device = f"/dev/{name}"
|
device = f"/dev/{name}"
|
||||||
size_gb = parse_size_gb(size)
|
usable = size_gb >= MIN_DISK_GB
|
||||||
status = _smart_status(device)
|
status = _smart_status(device) if usable else "unknown"
|
||||||
score = get_drive_type_score(device) + _HEALTH_SCORE[status] + get_size_score(size_gb)
|
warning = ""
|
||||||
|
if not uefi and size_gb > MBR_LIMIT_GB:
|
||||||
|
warning = (
|
||||||
|
"This computer starts in legacy (BIOS) mode, which can only use "
|
||||||
|
"the first 2 TB of this disk. Switch the firmware to UEFI to use all of it."
|
||||||
|
)
|
||||||
|
elif type_label == "USB":
|
||||||
|
warning = (
|
||||||
|
"This is a USB drive — it works, but an internal disk is faster and more reliable."
|
||||||
|
)
|
||||||
devices.append(
|
devices.append(
|
||||||
{
|
{
|
||||||
"name": device,
|
"name": device,
|
||||||
"size": size,
|
"size": format_size(size_bytes),
|
||||||
"type_label": get_drive_type_label(device),
|
"size_gb": size_gb,
|
||||||
|
"type_label": type_label,
|
||||||
"health_label": _HEALTH_LABEL[status],
|
"health_label": _HEALTH_LABEL[status],
|
||||||
"score": score,
|
"score": get_drive_type_score(type_label)
|
||||||
|
+ _HEALTH_SCORE[status]
|
||||||
|
+ get_size_score(size_gb),
|
||||||
|
"usable": usable,
|
||||||
|
"reason": "" if usable else f"Too small — Furtka needs at least {MIN_DISK_GB} GB",
|
||||||
|
"warning": warning,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
devices.sort(key=lambda d: d["score"], reverse=True)
|
devices.sort(key=lambda d: (d["usable"], d["score"]), reverse=True)
|
||||||
return devices
|
return devices
|
||||||
|
|
||||||
|
|
||||||
def list_scored_devices():
|
def list_scored_devices():
|
||||||
"""Return [{name, size, score}, ...] for all physical disks, highest score first."""
|
"""Return [{name, size, score, usable, ...}, ...] for all physical disks, best first."""
|
||||||
try:
|
result = _run(["lsblk", "-J", "-d", "-b", "-o", "NAME,SIZE,TYPE,RO,RM,TRAN,ROTA"])
|
||||||
result = subprocess.run(
|
if result is None or result.returncode != 0:
|
||||||
["lsblk", "-dn", "-o", "NAME,SIZE,TYPE"],
|
print(f"Error listing devices: {result.stderr if result else 'lsblk unavailable'}")
|
||||||
capture_output=True,
|
|
||||||
text=True,
|
|
||||||
check=True,
|
|
||||||
)
|
|
||||||
except subprocess.CalledProcessError as e:
|
|
||||||
print(f"Error listing devices: {e}")
|
|
||||||
return []
|
return []
|
||||||
return parse_lsblk_output(result.stdout, boot_disk=_boot_disk_name())
|
return parse_lsblk_json(
|
||||||
|
result.stdout,
|
||||||
|
boot_disk=_boot_disk_name(),
|
||||||
|
uefi=Path("/sys/firmware/efi").exists(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
|
|
@ -168,11 +232,11 @@ def main():
|
||||||
if not devices:
|
if not devices:
|
||||||
print("No storage devices found.")
|
print("No storage devices found.")
|
||||||
return
|
return
|
||||||
print(f"\n{'Device':<20} {'Size':<10} {'Score'}")
|
print(f"\n{'Device':<20} {'Size':<10} {'Type':<6} {'Score'}")
|
||||||
print("-" * 40)
|
print("-" * 46)
|
||||||
for d in devices:
|
for d in devices:
|
||||||
print(f"{d['name']:<20} {d['size']:<10} {d['score']}")
|
note = "" if d["usable"] else f" ({d['reason']})"
|
||||||
print(f"\nBest drive for boot: {devices[0]['name']} (score {devices[0]['score']})")
|
print(f"{d['name']:<20} {d['size']:<10} {d['type_label']:<6} {d['score']}{note}")
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|
|
||||||
1
webinstaller/static/favicon.svg
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><style>svg{color:#c03a28}@media (prefers-color-scheme:dark){svg{color:#ff6b56}}</style><path fill="currentColor" fill-rule="evenodd" d="M5 60V27a27 27 0 0 1 54 0v33Z M19.5 60V26A10 10 0 0 1 29.5 16H46v10H32a2.5 2.5 0 0 0-2.5 2.5V32H46v10H29.5v18Z"/></svg>
|
||||||
|
After Width: | Height: | Size: 316 B |
|
|
@ -190,9 +190,17 @@ select:focus {
|
||||||
background: var(--bg-card);
|
background: var(--bg-card);
|
||||||
border: 1px solid var(--border);
|
border: 1px solid var(--border);
|
||||||
border-radius: 8px;
|
border-radius: 8px;
|
||||||
|
flex-wrap: wrap;
|
||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
transition: border-color 120ms, background 120ms;
|
transition: border-color 120ms, background 120ms;
|
||||||
}
|
}
|
||||||
|
.drive-disabled { cursor: not-allowed; opacity: 0.6; }
|
||||||
|
.drive-disabled:hover { border-color: var(--border); }
|
||||||
|
.drive .drive-note {
|
||||||
|
flex-basis: 100%;
|
||||||
|
font-size: 0.82rem;
|
||||||
|
color: var(--fg-muted);
|
||||||
|
}
|
||||||
.drive:hover { border-color: color-mix(in srgb, var(--accent) 50%, var(--border)); }
|
.drive:hover { border-color: color-mix(in srgb, var(--accent) 50%, var(--border)); }
|
||||||
.drive input[type="radio"] {
|
.drive input[type="radio"] {
|
||||||
accent-color: var(--accent);
|
accent-color: var(--accent);
|
||||||
|
|
|
||||||
|
|
@ -4,6 +4,7 @@
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
<title>{% block title %}Furtka Installer{% endblock %}</title>
|
<title>{% block title %}Furtka Installer{% endblock %}</title>
|
||||||
|
<link rel="icon" type="image/svg+xml" href="{{ url_for('static', filename='favicon.svg') }}">
|
||||||
<link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">
|
<link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">
|
||||||
{% block head_extra %}{% endblock %}
|
{% block head_extra %}{% endblock %}
|
||||||
</head>
|
</head>
|
||||||
|
|
@ -11,12 +12,8 @@
|
||||||
<header class="site-header">
|
<header class="site-header">
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<a href="{{ url_for('install_step_1') }}" class="site-title" aria-label="Furtka Installer — restart">
|
<a href="{{ url_for('install_step_1') }}" class="site-title" aria-label="Furtka Installer — restart">
|
||||||
<svg class="gate-mark" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
<svg class="gate-mark" width="24" height="24" viewBox="0 0 64 64" aria-hidden="true">
|
||||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
|
<path fill="currentColor" fill-rule="evenodd" d="M5 60V27a27 27 0 0 1 54 0v33Z M19.5 60V26A10 10 0 0 1 29.5 16H46v10H32a2.5 2.5 0 0 0-2.5 2.5V32H46v10H29.5v18Z"/>
|
||||||
<path d="M4 20 V12 A9 9 0 0 1 20 12 V20"/>
|
|
||||||
<line x1="12" y1="5" x2="12" y2="20"/>
|
|
||||||
<line x1="3" y1="20" x2="21" y2="20"/>
|
|
||||||
<line x1="15" y1="12" x2="15" y2="14.5"/>
|
|
||||||
</svg>
|
</svg>
|
||||||
<span class="wordmark">Furtka<span class="sep">·</span>Installer</span>
|
<span class="wordmark">Furtka<span class="sep">·</span>Installer</span>
|
||||||
</a>
|
</a>
|
||||||
|
|
|
||||||
|
|
@ -18,10 +18,23 @@
|
||||||
</h1>
|
</h1>
|
||||||
<p class="lede" id="install-lede">
|
<p class="lede" id="install-lede">
|
||||||
{% if progress.status == "done" %}Installation finished. Two more steps and Furtka is running from its own disk.
|
{% if progress.status == "done" %}Installation finished. Two more steps and Furtka is running from its own disk.
|
||||||
{% elif progress.status == "error" %}Something went wrong. Open the details below and share them so we can help.
|
{% elif progress.status == "error" %}{{ progress.phase }}.
|
||||||
{% else %}This takes a few minutes. Don't close this page or power off the machine.{% endif %}
|
{% else %}This takes 5–20 minutes, depending on your internet speed. Don't power off the machine — it's fine to close this page and come back.{% endif %}
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
{% if progress.status == "error" %}
|
||||||
|
<p>Your settings are kept, so you can simply try again. If it fails the same way twice,
|
||||||
|
open <em>Show details</em> below — the last lines of the log say what went wrong.</p>
|
||||||
|
<form method="post" action="{{ url_for('install_run') }}"
|
||||||
|
onsubmit="this.querySelector('button').disabled = true;">
|
||||||
|
<div class="actions">
|
||||||
|
<button type="submit" class="btn btn-primary">Try again</button>
|
||||||
|
<a href="{{ url_for('install_step_2') }}" class="btn btn-link">Pick a different disk</a>
|
||||||
|
<a href="{{ url_for('install_step_1') }}" class="btn btn-link">Change settings</a>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
{% if progress.status == "done" %}
|
{% if progress.status == "done" %}
|
||||||
{# The USB-stick step has to be read *before* the click: the machine reboots
|
{# The USB-stick step has to be read *before* the click: the machine reboots
|
||||||
3 s after it, and most BIOSes boot the stick before the disk — so the
|
3 s after it, and most BIOSes boot the stick before the disk — so the
|
||||||
|
|
@ -43,7 +56,7 @@
|
||||||
<div class="progress" role="progressbar" aria-valuemin="0" aria-valuemax="100" aria-valuenow="{{ progress.percent }}">
|
<div class="progress" role="progressbar" aria-valuemin="0" aria-valuemax="100" aria-valuenow="{{ progress.percent }}">
|
||||||
<div id="progress-bar" class="progress-bar{% if progress.status == 'error' %} progress-bar-error{% endif %}{% if progress.status == 'done' %} progress-bar-done{% endif %}" style="width: {{ progress.percent }}%;"></div>
|
<div id="progress-bar" class="progress-bar{% if progress.status == 'error' %} progress-bar-error{% endif %}{% if progress.status == 'done' %} progress-bar-done{% endif %}" style="width: {{ progress.percent }}%;"></div>
|
||||||
</div>
|
</div>
|
||||||
<p class="progress-phase"><span id="progress-phase">{{ progress.phase }}</span> · <span id="progress-percent">{{ progress.percent }}</span>%</p>
|
<p class="progress-phase" aria-live="polite"><span id="progress-phase">{{ progress.phase }}</span> · <span id="progress-percent">{{ progress.percent }}</span>%</p>
|
||||||
|
|
||||||
<details class="log-details">
|
<details class="log-details">
|
||||||
<summary>Show details</summary>
|
<summary>Show details</summary>
|
||||||
|
|
@ -59,17 +72,7 @@
|
||||||
var phaseEl = document.getElementById('progress-phase');
|
var phaseEl = document.getElementById('progress-phase');
|
||||||
var percentEl = document.getElementById('progress-percent');
|
var percentEl = document.getElementById('progress-percent');
|
||||||
var logEl = document.getElementById('install-log');
|
var logEl = document.getElementById('install-log');
|
||||||
var headingEl = document.getElementById('install-heading');
|
var failures = 0;
|
||||||
var ledeEl = document.getElementById('install-lede');
|
|
||||||
|
|
||||||
var HEADINGS = {
|
|
||||||
done: 'Furtka is ready',
|
|
||||||
error: 'Installation hit a snag',
|
|
||||||
};
|
|
||||||
var LEDES = {
|
|
||||||
done: 'Installation finished. Remove the USB / eject the installer image, then reboot.',
|
|
||||||
error: 'Something went wrong. Open the details below and share them so we can help.',
|
|
||||||
};
|
|
||||||
|
|
||||||
function tick() {
|
function tick() {
|
||||||
fetch('{{ url_for("install_log_json") }}', { cache: 'no-store' })
|
fetch('{{ url_for("install_log_json") }}', { cache: 'no-store' })
|
||||||
|
|
@ -77,6 +80,7 @@
|
||||||
.then(function (data) {
|
.then(function (data) {
|
||||||
var p = data.progress;
|
var p = data.progress;
|
||||||
bar.style.width = p.percent + '%';
|
bar.style.width = p.percent + '%';
|
||||||
|
bar.parentNode.setAttribute('aria-valuenow', p.percent);
|
||||||
phaseEl.textContent = p.phase;
|
phaseEl.textContent = p.phase;
|
||||||
percentEl.textContent = p.percent;
|
percentEl.textContent = p.percent;
|
||||||
if (logEl.textContent !== data.log) {
|
if (logEl.textContent !== data.log) {
|
||||||
|
|
@ -84,21 +88,23 @@
|
||||||
logEl.textContent = data.log || '(waiting for install to start)';
|
logEl.textContent = data.log || '(waiting for install to start)';
|
||||||
if (atBottom) logEl.scrollTop = logEl.scrollHeight;
|
if (atBottom) logEl.scrollTop = logEl.scrollHeight;
|
||||||
}
|
}
|
||||||
if (p.status === 'done') {
|
if (p.status === 'done' || p.status === 'error') {
|
||||||
// Reload so the server-rendered Done state (with the
|
// Reload so the server-rendered Done / error state (with
|
||||||
// Reboot button) replaces the running-state markup.
|
// its Reboot or Try-again buttons) replaces the
|
||||||
|
// running-state markup.
|
||||||
window.location.reload();
|
window.location.reload();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (p.status === 'error') {
|
failures = 0;
|
||||||
bar.classList.add('progress-bar-error');
|
|
||||||
headingEl.textContent = HEADINGS.error;
|
|
||||||
ledeEl.textContent = LEDES.error;
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
setTimeout(tick, 3000);
|
setTimeout(tick, 3000);
|
||||||
})
|
})
|
||||||
.catch(function () { setTimeout(tick, 3000); });
|
.catch(function () {
|
||||||
|
failures += 1;
|
||||||
|
if (failures >= 2) {
|
||||||
|
phaseEl.textContent = 'Lost connection to the installer — retrying…';
|
||||||
|
}
|
||||||
|
setTimeout(tick, 3000);
|
||||||
|
});
|
||||||
}
|
}
|
||||||
setTimeout(tick, 3000);
|
setTimeout(tick, 3000);
|
||||||
})();
|
})();
|
||||||
|
|
|
||||||
|
|
@ -5,27 +5,27 @@
|
||||||
|
|
||||||
{% block content %}
|
{% block content %}
|
||||||
<h1>Confirm install</h1>
|
<h1>Confirm install</h1>
|
||||||
<p class="lede">Review the settings below. Continuing will <strong>wipe <code>{{ settings.boot_drive }}</code></strong> and install Furtka.</p>
|
<p class="lede">Check the settings below. Continuing will <strong>erase <code>{{ settings.boot_drive }}</code></strong> and install Furtka on it.</p>
|
||||||
|
|
||||||
<div class="alert alert-warn">
|
<div class="alert alert-warn" role="alert">
|
||||||
This is destructive. All existing data on the selected boot drive will be lost.
|
Everything currently on this disk will be deleted and can't be recovered.
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="summary">
|
<div class="summary">
|
||||||
<table>
|
<table>
|
||||||
{% for k, v in settings.items() %}
|
<tr><td>Server name</td><td>{{ settings.hostname }} <span class="hint">(http://{{ settings.hostname }}.local)</span></td></tr>
|
||||||
<tr>
|
<tr><td>Username</td><td>{{ settings.username }}</td></tr>
|
||||||
<td>{{ k.replace('_', ' ') }}</td>
|
<tr><td>Password</td><td>{{ settings.password }}</td></tr>
|
||||||
<td>{{ v }}</td>
|
<tr><td>Language</td><td>{{ language_label }}</td></tr>
|
||||||
</tr>
|
<tr><td>Disk</td><td>{{ settings.boot_drive }}{% if drive %} — {{ drive.size }} {{ drive.type_label }}{% endif %}</td></tr>
|
||||||
{% endfor %}
|
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<form method="post" action="{{ url_for('install_run') }}">
|
<form method="post" action="{{ url_for('install_run') }}"
|
||||||
|
onsubmit="this.querySelector('button').disabled = true; this.querySelector('button').textContent = 'Starting…';">
|
||||||
<div class="actions">
|
<div class="actions">
|
||||||
<button type="submit" class="btn btn-danger">Install — wipe drive and proceed</button>
|
<button type="submit" class="btn btn-danger">Erase disk and install</button>
|
||||||
<a href="{{ url_for('install_step_1') }}" class="btn btn-link">← Start over</a>
|
<a href="{{ url_for('install_step_2') }}" class="btn btn-link">← Back</a>
|
||||||
</div>
|
</div>
|
||||||
</form>
|
</form>
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
|
|
||||||
|
|
@ -10,5 +10,7 @@
|
||||||
<p class="muted">If the installer does come back anyway, your BIOS is set to boot from USB before the disk. Press the one-time boot menu key at startup (often <kbd>F11</kbd>, <kbd>F12</kbd>, or <kbd>Esc</kbd> — it flashes briefly on screen) and pick the internal disk, or change the boot order in BIOS settings.</p>
|
<p class="muted">If the installer does come back anyway, your BIOS is set to boot from USB before the disk. Press the one-time boot menu key at startup (often <kbd>F11</kbd>, <kbd>F12</kbd>, or <kbd>Esc</kbd> — it flashes briefly on screen) and pick the internal disk, or change the boot order in BIOS settings.</p>
|
||||||
<p>When the machine comes back up (~1 minute), open Furtka in your browser:</p>
|
<p>When the machine comes back up (~1 minute), open Furtka in your browser:</p>
|
||||||
<p><a href="http://{{ hostname }}.local" class="btn btn-primary">http://{{ hostname }}.local</a></p>
|
<p><a href="http://{{ hostname }}.local" class="btn btn-primary">http://{{ hostname }}.local</a></p>
|
||||||
<p class="muted">If that doesn't resolve, your network may not support mDNS — use the IP address shown on the machine's console instead.</p>
|
<p class="muted">If that address doesn't open (some Android phones and older Windows PCs can't look up <code>.local</code> names),
|
||||||
|
use the IP address instead: it's shown on the machine's screen, or look for a device called
|
||||||
|
<strong>{{ hostname }}</strong> in your router's list of connected devices. The address may differ from the one the installer used.</p>
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
|
|
||||||
|
|
@ -4,11 +4,11 @@
|
||||||
{% block step_indicator %}<span class="step-indicator">Step 1 of 3</span>{% endblock %}
|
{% block step_indicator %}<span class="step-indicator">Step 1 of 3</span>{% endblock %}
|
||||||
|
|
||||||
{% block content %}
|
{% block content %}
|
||||||
<h1>Account & hostname</h1>
|
<h1>Name & account</h1>
|
||||||
<p class="lede">Set the server name and your administrator account.</p>
|
<p class="lede">Set the server name and your administrator account.</p>
|
||||||
|
|
||||||
{% if errors %}
|
{% if errors %}
|
||||||
<div class="alert alert-error">
|
<div class="alert alert-error" role="alert">
|
||||||
<strong>Please fix the following:</strong>
|
<strong>Please fix the following:</strong>
|
||||||
<ul>
|
<ul>
|
||||||
{% for e in errors %}<li>{{ e }}</li>{% endfor %}
|
{% for e in errors %}<li>{{ e }}</li>{% endfor %}
|
||||||
|
|
@ -18,19 +18,19 @@
|
||||||
|
|
||||||
<form method="post" action="{{ url_for('install_step_1') }}">
|
<form method="post" action="{{ url_for('install_step_1') }}">
|
||||||
<div class="field">
|
<div class="field">
|
||||||
<label for="hostname">Hostname</label>
|
<label for="hostname">Server name</label>
|
||||||
<input type="text" id="hostname" name="hostname" required value="{{ values.hostname }}" autocomplete="off" />
|
<input type="text" id="hostname" name="hostname" required value="{{ values.hostname }}" autocomplete="off" autocapitalize="off" spellcheck="false" aria-describedby="hostname-hint" />
|
||||||
<span class="hint">The name your server shows up as on your home network. Lowercase letters, numbers, and dashes only.</span>
|
<span class="hint" id="hostname-hint">You'll open your server at <strong>http://<span id="hostname-preview">{{ values.hostname or "furtka" }}</span>.local</strong>. Letters, numbers and dashes only.</span>
|
||||||
</div>
|
</div>
|
||||||
<div class="field">
|
<div class="field">
|
||||||
<label for="username">Admin username</label>
|
<label for="username">Admin username</label>
|
||||||
<input type="text" id="username" name="username" required value="{{ values.username }}" autocomplete="username" />
|
<input type="text" id="username" name="username" required value="{{ values.username }}" autocomplete="username" autocapitalize="off" spellcheck="false" aria-describedby="username-hint" />
|
||||||
<span class="hint">Your login name on the server. You'll use this to sign in after installation.</span>
|
<span class="hint" id="username-hint">Your login name on the server. You'll use this to sign in after installation.</span>
|
||||||
</div>
|
</div>
|
||||||
<div class="field">
|
<div class="field">
|
||||||
<label for="password">Password</label>
|
<label for="password">Password</label>
|
||||||
<input type="password" id="password" name="password" required autocomplete="new-password" />
|
<input type="password" id="password" name="password" required minlength="8" autocomplete="new-password" aria-describedby="password-hint" />
|
||||||
<span class="hint">At least 8 characters.</span>
|
<span class="hint" id="password-hint">At least 8 characters. This one password is used for the web login and for the server itself (SSH / console), so pick a good one.</span>
|
||||||
</div>
|
</div>
|
||||||
<div class="field">
|
<div class="field">
|
||||||
<label for="password2">Confirm password</label>
|
<label for="password2">Confirm password</label>
|
||||||
|
|
@ -38,15 +38,25 @@
|
||||||
</div>
|
</div>
|
||||||
<div class="field">
|
<div class="field">
|
||||||
<label for="language">Language</label>
|
<label for="language">Language</label>
|
||||||
<select id="language" name="language">
|
<select id="language" name="language" aria-describedby="language-hint">
|
||||||
{% for code, lang in languages.items() %}
|
{% for code, lang in languages.items() %}
|
||||||
<option value="{{ code }}" {% if code == values.language %}selected{% endif %}>{{ lang.label }}</option>
|
<option value="{{ code }}" {% if code == values.language %}selected{% endif %}>{{ lang.label }}</option>
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
</select>
|
</select>
|
||||||
|
<span class="hint" id="language-hint">Language and keyboard layout of the installed server. The Furtka pages themselves are in English for now.</span>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="actions">
|
<div class="actions">
|
||||||
<button type="submit" class="btn btn-primary">Next — pick boot drive</button>
|
<button type="submit" class="btn btn-primary">Next — pick a disk</button>
|
||||||
</div>
|
</div>
|
||||||
</form>
|
</form>
|
||||||
|
<script>
|
||||||
|
(function () {
|
||||||
|
var input = document.getElementById('hostname');
|
||||||
|
var preview = document.getElementById('hostname-preview');
|
||||||
|
input.addEventListener('input', function () {
|
||||||
|
preview.textContent = input.value.trim().toLowerCase() || 'furtka';
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
</script>
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
|
|
||||||
|
|
@ -1,39 +1,53 @@
|
||||||
{% extends "base.html" %}
|
{% extends "base.html" %}
|
||||||
|
|
||||||
{% block title %}Step 2 — Boot drive · Furtka Installer{% endblock %}
|
{% block title %}Step 2 — Disk · Furtka Installer{% endblock %}
|
||||||
{% block step_indicator %}<span class="step-indicator">Step 2 of 3</span>{% endblock %}
|
{% block step_indicator %}<span class="step-indicator">Step 2 of 3</span>{% endblock %}
|
||||||
|
|
||||||
{% block content %}
|
{% block content %}
|
||||||
<h1>Boot drive</h1>
|
<h1>Pick a disk</h1>
|
||||||
<p class="lede">Pick the disk Furtka will install onto. We pre-select the drive that looks fastest and healthiest.</p>
|
<p class="lede">Choose the disk Furtka will be installed on. <strong>Everything on it will be erased.</strong> We pre-select the one that looks fastest and healthiest.</p>
|
||||||
|
|
||||||
{% if not drives %}
|
{% set usable = drives | selectattr("usable") | list %}
|
||||||
<div class="alert alert-error">
|
{% set pick = selected if (selected and usable | selectattr("name", "equalto", selected) | list) else (usable[0].name if usable else "") %}
|
||||||
No physical disks detected. The live ISO can't see any install targets — check your BIOS / SATA controller.
|
|
||||||
|
{% if error %}
|
||||||
|
<div class="alert alert-error" role="alert">{{ error }}</div>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if not usable %}
|
||||||
|
<div class="alert alert-error" role="alert">
|
||||||
|
{% if drives %}
|
||||||
|
None of the disks in this computer is big enough for Furtka (it needs at least 16 GB).
|
||||||
|
{% else %}
|
||||||
|
No disk found to install onto. Check that the disk is connected, and in the BIOS/UEFI settings
|
||||||
|
that the SATA mode is "AHCI" rather than "RAID" or "Intel RST" — Linux can't see disks in RAID mode.
|
||||||
|
{% endif %}
|
||||||
</div>
|
</div>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
<form method="post" action="{{ url_for('install_step_2') }}">
|
<form method="post" action="{{ url_for('install_step_2') }}">
|
||||||
<div class="drive-list">
|
<div class="drive-list">
|
||||||
{% for d in drives %}
|
{% for d in drives %}
|
||||||
<label class="drive">
|
<label class="drive{% if not d.usable %} drive-disabled{% endif %}">
|
||||||
<input type="radio" name="boot_drive" value="{{ d.name }}"
|
<input type="radio" name="boot_drive" value="{{ d.name }}"
|
||||||
{% if (selected and d.name == selected) or (not selected and loop.first) %}checked{% endif %} />
|
{% if not d.usable %}disabled{% elif d.name == pick %}checked{% endif %} />
|
||||||
<span class="name">{{ d.name }}</span>
|
<span class="name">{{ d.name }}</span>
|
||||||
{% if not selected and loop.first %}
|
{% if not selected and d.usable and loop.first %}
|
||||||
<span class="badge-recommended">Recommended</span>
|
<span class="badge-recommended">Recommended</span>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
<span class="meta">
|
<span class="meta">
|
||||||
<span class="chip">{{ d.size }}</span>
|
<span class="chip">{{ d.size }}</span>
|
||||||
<span class="chip">{{ d.type_label }}</span>
|
<span class="chip">{{ d.type_label }}</span>
|
||||||
<span class="chip">{{ d.health_label }}</span>
|
{% if d.usable %}<span class="chip">{{ d.health_label }}</span>{% endif %}
|
||||||
</span>
|
</span>
|
||||||
|
{% if d.reason %}<span class="drive-note">{{ d.reason }}</span>{% endif %}
|
||||||
|
{% if d.warning %}<span class="drive-note">{{ d.warning }}</span>{% endif %}
|
||||||
</label>
|
</label>
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="actions">
|
<div class="actions">
|
||||||
<button type="submit" class="btn btn-primary" {% if not drives %}disabled{% endif %}>Next — review</button>
|
<button type="submit" class="btn btn-primary" {% if not usable %}disabled{% endif %}>Next — review</button>
|
||||||
<a href="{{ url_for('install_step_1') }}" class="btn btn-link">← Back</a>
|
<a href="{{ url_for('install_step_1') }}" class="btn btn-link">← Back</a>
|
||||||
</div>
|
</div>
|
||||||
</form>
|
</form>
|
||||||
|
|
|
||||||
|
|
@ -356,6 +356,214 @@ main.container {
|
||||||
.cta--primary { animation: none; }
|
.cta--primary { animation: none; }
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.cta-row {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.9rem 1.1rem;
|
||||||
|
}
|
||||||
|
.cta--ghost {
|
||||||
|
color: var(--fg);
|
||||||
|
border: 1px solid var(--border);
|
||||||
|
background: var(--card-bg);
|
||||||
|
-webkit-backdrop-filter: blur(10px);
|
||||||
|
backdrop-filter: blur(10px);
|
||||||
|
}
|
||||||
|
.cta--ghost:hover {
|
||||||
|
border-color: var(--accent);
|
||||||
|
color: var(--accent);
|
||||||
|
transform: translateY(-2px);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ── How it works (home) ─────────────────────────────────── */
|
||||||
|
|
||||||
|
.how-steps {
|
||||||
|
list-style: none;
|
||||||
|
counter-reset: how;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(auto-fit, minmax(14rem, 1fr));
|
||||||
|
gap: 1rem;
|
||||||
|
}
|
||||||
|
.how-step {
|
||||||
|
counter-increment: how;
|
||||||
|
position: relative;
|
||||||
|
background: var(--card-bg);
|
||||||
|
border: 1px solid var(--card-border);
|
||||||
|
border-radius: 1rem;
|
||||||
|
padding: 1.4rem 1.5rem 1.5rem;
|
||||||
|
-webkit-backdrop-filter: blur(10px);
|
||||||
|
backdrop-filter: blur(10px);
|
||||||
|
}
|
||||||
|
.how-step::before {
|
||||||
|
content: counter(how, decimal-leading-zero);
|
||||||
|
display: block;
|
||||||
|
font-family: var(--font-mono);
|
||||||
|
font-weight: 600;
|
||||||
|
font-size: 2.4rem;
|
||||||
|
line-height: 1;
|
||||||
|
letter-spacing: -0.04em;
|
||||||
|
margin-bottom: 0.9rem;
|
||||||
|
background-image: linear-gradient(135deg, var(--accent), var(--fg-muted));
|
||||||
|
-webkit-background-clip: text;
|
||||||
|
background-clip: text;
|
||||||
|
-webkit-text-fill-color: transparent;
|
||||||
|
}
|
||||||
|
.how-step h3 { margin: 0 0 0.35rem; font-size: 1.15rem; letter-spacing: -0.01em; }
|
||||||
|
.how-step p { margin: 0; color: var(--fg-muted); font-size: 0.98rem; line-height: 1.5; }
|
||||||
|
.how-step strong { color: var(--fg); font-weight: 600; }
|
||||||
|
|
||||||
|
/* ── Download band (home, before the closer) ─────────────── */
|
||||||
|
|
||||||
|
.dl-band {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: space-between;
|
||||||
|
gap: 1.25rem 2rem;
|
||||||
|
margin-block: 4.5rem 0;
|
||||||
|
padding: 2rem;
|
||||||
|
border-radius: 1.25rem;
|
||||||
|
border: 1px solid color-mix(in srgb, var(--accent) 45%, var(--border));
|
||||||
|
background:
|
||||||
|
radial-gradient(120% 140% at 0% 0%, color-mix(in srgb, var(--accent) 14%, transparent), transparent 60%),
|
||||||
|
var(--card-bg);
|
||||||
|
-webkit-backdrop-filter: blur(10px);
|
||||||
|
backdrop-filter: blur(10px);
|
||||||
|
}
|
||||||
|
.dl-band h2 { margin: 0 0 0.3rem; font-size: 1.5rem; letter-spacing: -0.02em; }
|
||||||
|
.dl-band p { margin: 0; color: var(--fg-muted); max-width: 26rem; }
|
||||||
|
|
||||||
|
/* ── Download page ───────────────────────────────────────── */
|
||||||
|
|
||||||
|
.dl-hero { padding-block: 1rem 1rem; }
|
||||||
|
.dl-hero h1 {
|
||||||
|
font-size: clamp(2.4rem, 7vw, 4rem);
|
||||||
|
line-height: 1;
|
||||||
|
letter-spacing: -0.035em;
|
||||||
|
margin: 0 0 1rem;
|
||||||
|
}
|
||||||
|
.dl-hero .lede {
|
||||||
|
font-size: clamp(1.05rem, 1.6vw, 1.2rem);
|
||||||
|
color: var(--fg-muted);
|
||||||
|
max-width: 36rem;
|
||||||
|
margin: 0 0 2rem;
|
||||||
|
}
|
||||||
|
.dl-card {
|
||||||
|
padding: 1.75rem;
|
||||||
|
border-radius: 1.25rem;
|
||||||
|
border: 1px solid color-mix(in srgb, var(--accent) 45%, var(--border));
|
||||||
|
background:
|
||||||
|
radial-gradient(120% 140% at 100% 0%, color-mix(in srgb, var(--accent) 12%, transparent), transparent 60%),
|
||||||
|
var(--card-bg);
|
||||||
|
}
|
||||||
|
.dl-card .cta svg { flex: none; }
|
||||||
|
.dl-meta {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
gap: 0.75rem 2rem;
|
||||||
|
margin: 1.5rem 0 0;
|
||||||
|
}
|
||||||
|
.dl-meta div { min-width: 0; }
|
||||||
|
.dl-meta dt {
|
||||||
|
font-size: 0.7rem;
|
||||||
|
font-weight: 500;
|
||||||
|
letter-spacing: 0.14em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--fg-muted);
|
||||||
|
}
|
||||||
|
.dl-meta dd { margin: 0.15rem 0 0; overflow-wrap: anywhere; }
|
||||||
|
.mono { font-family: var(--font-mono); font-size: 0.92em; }
|
||||||
|
.dl-host { margin: 1.25rem 0 0; font-size: 0.85rem; color: var(--fg-muted); }
|
||||||
|
.dl-alpha {
|
||||||
|
margin: 1.5rem 0 0;
|
||||||
|
padding: 0.9rem 1.1rem;
|
||||||
|
border-left: 3px solid var(--accent);
|
||||||
|
background: var(--bg-subtle);
|
||||||
|
border-radius: 0 0.6rem 0.6rem 0;
|
||||||
|
font-size: 0.95rem;
|
||||||
|
max-width: 40rem;
|
||||||
|
}
|
||||||
|
.dl-section { margin-top: 3.5rem; }
|
||||||
|
.dl-needs { margin: 0; padding-left: 1.2rem; max-width: 40rem; }
|
||||||
|
.dl-needs li { margin-bottom: 0.55rem; }
|
||||||
|
.dl-needs li::marker { color: var(--accent); }
|
||||||
|
.dl-steps {
|
||||||
|
list-style: none;
|
||||||
|
counter-reset: dl;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 1rem;
|
||||||
|
}
|
||||||
|
.step-card {
|
||||||
|
counter-increment: dl;
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: 2.6rem 1fr;
|
||||||
|
gap: 0 1rem;
|
||||||
|
padding: 1.3rem 1.4rem;
|
||||||
|
border: 1px solid var(--card-border);
|
||||||
|
border-radius: 1rem;
|
||||||
|
background: var(--card-bg);
|
||||||
|
}
|
||||||
|
.step-card::before {
|
||||||
|
content: counter(dl);
|
||||||
|
grid-row: span 2;
|
||||||
|
display: grid;
|
||||||
|
place-items: center;
|
||||||
|
width: 2.6rem;
|
||||||
|
height: 2.6rem;
|
||||||
|
border-radius: 999px;
|
||||||
|
background: linear-gradient(135deg, var(--accent), var(--accent-hover));
|
||||||
|
color: #fff;
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.step-card h2 { margin: 0.35rem 0 0.4rem; font-size: 1.15rem; letter-spacing: -0.01em; }
|
||||||
|
.step-body { min-width: 0; color: var(--fg-muted); }
|
||||||
|
.step-body p { margin: 0 0 0.7rem; }
|
||||||
|
.step-body p:last-child { margin: 0; }
|
||||||
|
.step-body strong { color: var(--fg); font-weight: 600; }
|
||||||
|
.step-body a, .dl-older a, .dl-alpha a { color: var(--accent); }
|
||||||
|
kbd {
|
||||||
|
font-family: var(--font-mono);
|
||||||
|
font-size: 0.85em;
|
||||||
|
padding: 0.05rem 0.4rem;
|
||||||
|
border: 1px solid var(--border);
|
||||||
|
border-bottom-width: 2px;
|
||||||
|
border-radius: 0.3rem;
|
||||||
|
background: var(--bg);
|
||||||
|
color: var(--fg);
|
||||||
|
}
|
||||||
|
.download pre {
|
||||||
|
margin: 0.4rem 0 0;
|
||||||
|
padding: 0.85rem 1rem;
|
||||||
|
border-radius: 0.6rem;
|
||||||
|
background: var(--bg-subtle);
|
||||||
|
border: 1px solid var(--border);
|
||||||
|
overflow-x: auto;
|
||||||
|
font-size: 0.85rem;
|
||||||
|
line-height: 1.55;
|
||||||
|
color: var(--fg);
|
||||||
|
}
|
||||||
|
.download code { font-family: var(--font-mono); }
|
||||||
|
.download :not(pre) > code {
|
||||||
|
padding: 0.05rem 0.3rem;
|
||||||
|
border-radius: 0.3rem;
|
||||||
|
background: var(--bg-subtle);
|
||||||
|
font-size: 0.9em;
|
||||||
|
}
|
||||||
|
.dl-hash code { overflow-wrap: anywhere; white-space: pre-wrap; }
|
||||||
|
.dl-cmds .c { color: var(--fg-muted); }
|
||||||
|
.dl-muted { color: var(--fg-muted); }
|
||||||
|
.dl-older { margin-top: 3rem; }
|
||||||
|
@media (max-width: 30rem) {
|
||||||
|
.dl-card, .dl-band { padding: 1.35rem; }
|
||||||
|
.step-card { grid-template-columns: 1fr; }
|
||||||
|
.step-card::before { grid-row: auto; margin-bottom: 0.6rem; }
|
||||||
|
}
|
||||||
|
|
||||||
/* ── Intro paragraph (home, between hero and feature grids) ─ */
|
/* ── Intro paragraph (home, between hero and feature grids) ─ */
|
||||||
|
|
||||||
.intro {
|
.intro {
|
||||||
|
|
@ -485,6 +693,16 @@ main.container {
|
||||||
.poll-bar { height: 0.45rem; border-radius: 999px; background: var(--bg-subtle); overflow: hidden; display: none; }
|
.poll-bar { height: 0.45rem; border-radius: 999px; background: var(--bg-subtle); overflow: hidden; display: none; }
|
||||||
.poll-bar i { display: block; height: 100%; width: 0; background: var(--accent); transition: width 500ms ease; }
|
.poll-bar i { display: block; height: 100%; width: 0; background: var(--accent); transition: width 500ms ease; }
|
||||||
.poll--voted .poll-bar { display: block; }
|
.poll--voted .poll-bar { display: block; }
|
||||||
|
.poll-bar--final { display: block; }
|
||||||
|
.poll-result {
|
||||||
|
margin: 1.5rem 0 0;
|
||||||
|
padding: 1rem 1.2rem;
|
||||||
|
border-left: 3px solid var(--accent);
|
||||||
|
background: var(--bg-subtle);
|
||||||
|
border-radius: 0 0.6rem 0.6rem 0;
|
||||||
|
max-width: 40rem;
|
||||||
|
}
|
||||||
|
.poll-result strong { color: var(--accent); }
|
||||||
.poll-count { margin: 0; min-height: 1.4em; font-size: 0.85rem; color: var(--fg-muted); font-variant-numeric: tabular-nums; }
|
.poll-count { margin: 0; min-height: 1.4em; font-size: 0.85rem; color: var(--fg-muted); font-variant-numeric: tabular-nums; }
|
||||||
.poll-status { margin: 1.25rem 0 0; min-height: 1.5em; color: var(--fg-muted); }
|
.poll-status { margin: 1.25rem 0 0; min-height: 1.5em; color: var(--fg-muted); }
|
||||||
.poll-note { margin-top: 1rem; max-width: var(--measure); font-size: 0.85rem; color: var(--fg-muted); }
|
.poll-note { margin-top: 1rem; max-width: var(--measure); font-size: 0.85rem; color: var(--fg-muted); }
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,11 @@
|
||||||
---
|
---
|
||||||
title: "Furtka"
|
title: "Furtka"
|
||||||
description: "Offenes Heimserver-Betriebssystem — einfach genug für alle."
|
description: "Offenes Heimserver-Betriebssystem — einfach genug für alle."
|
||||||
status: "<span class=\"mono\">26.20-alpha</span> — in Arbeit"
|
status_text: "in Arbeit"
|
||||||
|
cta_download: "ISO herunterladen"
|
||||||
|
cta_source: "Quellcode"
|
||||||
poll_link: "/de/logo/"
|
poll_link: "/de/logo/"
|
||||||
poll_text: "Wir suchen ein Logo — hilf uns beim Aussuchen"
|
poll_text: "Abgestimmt — das ist unser neues Logo"
|
||||||
# features_today / features_next müssen index-parallel zu content/_index.md bleiben.
|
# features_today / features_next müssen index-parallel zu content/_index.md bleiben.
|
||||||
intro: |
|
intro: |
|
||||||
**Furtka** ist ein offenes Heimserver-Betriebssystem.
|
**Furtka** ist ein offenes Heimserver-Betriebssystem.
|
||||||
|
|
@ -12,6 +14,16 @@ intro: |
|
||||||
Apps, eigenem Namen im Netz, eigenen Daten.
|
Apps, eigenem Namen im Netz, eigenen Daten.
|
||||||
|
|
||||||
Das Ziel ist einfach: **dein Vater soll das einrichten können.**
|
Das Ziel ist einfach: **dein Vater soll das einrichten können.**
|
||||||
|
steps_label: "So funktioniert's"
|
||||||
|
steps:
|
||||||
|
- title: "Herunterladen"
|
||||||
|
body: "Installer holen und auf einen USB-Stick schreiben."
|
||||||
|
- title: "Installieren"
|
||||||
|
body: "Computer vom Stick starten und dem Assistenten folgen — im Browser auf Handy oder Laptop."
|
||||||
|
- title: "Loslegen"
|
||||||
|
body: "**http://furtka.local** öffnen und Apps mit einem Klick installieren."
|
||||||
|
band_title: "Lust, es auszuprobieren?"
|
||||||
|
band_text: "Kostenlos und quelloffen (AGPL-3.0). Läuft auf 64-Bit-PCs, auch auf alten."
|
||||||
features_today_label: "Was heute schon geht"
|
features_today_label: "Was heute schon geht"
|
||||||
features_today:
|
features_today:
|
||||||
- "Vom USB-Stick booten und Furtka auf die Festplatte einrichten"
|
- "Vom USB-Stick booten und Furtka auf die Festplatte einrichten"
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,11 @@
|
||||||
---
|
---
|
||||||
title: "Furtka"
|
title: "Furtka"
|
||||||
description: "Open-source home server OS — simple enough for everyone."
|
description: "Open-source home server OS — simple enough for everyone."
|
||||||
status: "<span class=\"mono\">26.20-alpha</span> — work in progress"
|
status_text: "work in progress"
|
||||||
|
cta_download: "Download ISO"
|
||||||
|
cta_source: "Source code"
|
||||||
poll_link: "/logo/"
|
poll_link: "/logo/"
|
||||||
poll_text: "We're picking a logo — help us choose"
|
poll_text: "The vote is in — meet our new logo"
|
||||||
# Keep features_today / features_next index-aligned with content/_index.de.md.
|
# Keep features_today / features_next index-aligned with content/_index.de.md.
|
||||||
intro: |
|
intro: |
|
||||||
**Furtka** is an open-source home server OS.
|
**Furtka** is an open-source home server OS.
|
||||||
|
|
@ -12,6 +14,16 @@ intro: |
|
||||||
your own name on the network, your own data.
|
your own name on the network, your own data.
|
||||||
|
|
||||||
The goal is simple: **your dad should be able to set this up.**
|
The goal is simple: **your dad should be able to set this up.**
|
||||||
|
steps_label: "How it works"
|
||||||
|
steps:
|
||||||
|
- title: "Download"
|
||||||
|
body: "Get the installer and write it to a USB stick."
|
||||||
|
- title: "Install"
|
||||||
|
body: "Start the computer from the stick and follow the wizard — in the browser on your phone or laptop."
|
||||||
|
- title: "Use"
|
||||||
|
body: "Open **http://furtka.local** and install apps with one click."
|
||||||
|
band_title: "Ready to try it?"
|
||||||
|
band_text: "Free and open source (AGPL-3.0). Runs on 64-bit PCs, old ones included."
|
||||||
features_today_label: "What works today"
|
features_today_label: "What works today"
|
||||||
features_today:
|
features_today:
|
||||||
- "Boot from USB stick and install Furtka onto the hard drive"
|
- "Boot from USB stick and install Furtka onto the hard drive"
|
||||||
|
|
|
||||||
40
website/content/download.de.md
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
---
|
||||||
|
title: "Furtka herunterladen"
|
||||||
|
description: "Der Furtka-Installer als ISO-Datei: auf einen USB-Stick schreiben, den Computer davon starten und den Heimserver im Browser einrichten."
|
||||||
|
translationKey: "download"
|
||||||
|
url: /de/download/
|
||||||
|
type: download
|
||||||
|
button: "ISO herunterladen"
|
||||||
|
released: "Veröffentlicht"
|
||||||
|
size_label: "Größe"
|
||||||
|
alpha: "Furtka ist **Alpha-Software**: Dinge ändern sich und manches geht kaputt. Installiere es auf einem Computer, dessen Festplatte du nicht brauchst, und sichere alles Wichtige."
|
||||||
|
host_note: "Die Datei kommt von unserem Forgejo-Server (forgejo.sourcegate.online)."
|
||||||
|
need_label: "Was du brauchst"
|
||||||
|
needs:
|
||||||
|
- "Einen **64-Bit-PC** (x86-64) — ein alter Laptop oder Desktop reicht. UEFI- und ältere BIOS-Rechner funktionieren beide."
|
||||||
|
- "Eine Festplatte mit **mindestens 16 GB** für Furtka. **Sie wird komplett gelöscht.**"
|
||||||
|
- "Einen **USB-Stick** mit mindestens 2 GB (wird ebenfalls gelöscht)."
|
||||||
|
- "Ein **Netzwerkkabel** mit Internetzugang — der Installer lädt Pakete herunter, und WLAN wird nicht automatisch eingerichtet."
|
||||||
|
- "Ein **zweites Gerät mit Browser** (Handy oder Laptop) im selben Netzwerk."
|
||||||
|
steps_label: "So installierst du Furtka"
|
||||||
|
steps:
|
||||||
|
- title: "ISO auf einen USB-Stick schreiben"
|
||||||
|
body: |
|
||||||
|
Nimm [balenaEtcher](https://etcher.balena.io/) (Windows, macOS, Linux) oder [Rufus](https://rufus.ie/) unter Windows — wenn Rufus fragt, wähle den **DD-Abbild-Modus**. Unter Linux geht auch `dd` (ersetze `/dev/sdX` durch deinen Stick — lieber zweimal prüfen):
|
||||||
|
|
||||||
|
```
|
||||||
|
sudo dd if={iso} of=/dev/sdX bs=4M status=progress oflag=sync
|
||||||
|
```
|
||||||
|
- title: "Computer vom Stick starten"
|
||||||
|
body: "Stick und Netzwerkkabel einstecken, Computer einschalten und die Taste fürs Bootmenü drücken (oft <kbd>F11</kbd>, <kbd>F12</kbd> oder <kbd>Esc</kbd> — sie wird kurz am Bildschirm angezeigt). Den USB-Stick auswählen. Startet der Computer nicht davon, schalte **Secure Boot** in den Firmware-Einstellungen aus."
|
||||||
|
- title: "Installer von einem anderen Gerät öffnen"
|
||||||
|
body: "Nach kurzer Zeit zeigt der Bildschirm eine Adresse an — meist **http://proksi.local:5000**, dazu die IP-Adresse als Ausweichweg. Öffne sie im Browser auf Handy oder Laptop."
|
||||||
|
- title: "Durch den Assistenten klicken"
|
||||||
|
body: "Drei Seiten: ein Name für deinen Server mit Benutzername und Passwort, die Festplatte und eine letzte Kontrolle. Danach lädt der Installer alles herunter und richtet es ein."
|
||||||
|
- title: "Stick raus, neu starten, fertig"
|
||||||
|
body: "Wenn der Assistent es sagt, den USB-Stick abziehen und neu starten. Dein Server ist dann unter **http://<name>.local** erreichbar — zum Beispiel http://furtka.local."
|
||||||
|
verify_label: "Download prüfen (optional)"
|
||||||
|
verify_intro: "Vergleiche die Prüfsumme der heruntergeladenen Datei mit dieser:"
|
||||||
|
verify_missing: "Für die ISO dieses Releases ist noch keine Prüfsumme veröffentlicht — künftige Releases bringen eine mit."
|
||||||
|
older: "Alle Releases und Änderungen"
|
||||||
|
---
|
||||||
40
website/content/download.md
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
---
|
||||||
|
title: "Download Furtka"
|
||||||
|
description: "The Furtka installer as an ISO file: write it to a USB stick, start your computer from it, and set up your home server in the browser."
|
||||||
|
translationKey: "download"
|
||||||
|
url: /download/
|
||||||
|
type: download
|
||||||
|
button: "Download ISO"
|
||||||
|
released: "Released"
|
||||||
|
size_label: "Size"
|
||||||
|
alpha: "Furtka is **alpha software**: things change and some will break. Install it on a computer whose disk you don't need, and keep a backup of anything important."
|
||||||
|
host_note: "The file is served from our Forgejo server (forgejo.sourcegate.online)."
|
||||||
|
need_label: "What you need"
|
||||||
|
needs:
|
||||||
|
- "A **64-bit PC** (x86-64) — an old laptop or desktop is fine. Both UEFI and older BIOS computers work."
|
||||||
|
- "A disk of **at least 16 GB** for Furtka. **It will be erased completely.**"
|
||||||
|
- "A **USB stick** with at least 2 GB (also erased)."
|
||||||
|
- "A **network cable** with internet access — the installer downloads packages, and Wi-Fi isn't set up automatically."
|
||||||
|
- "A **second device with a browser** (phone or laptop) on the same network."
|
||||||
|
steps_label: "How to install"
|
||||||
|
steps:
|
||||||
|
- title: "Write the ISO to a USB stick"
|
||||||
|
body: |
|
||||||
|
Use [balenaEtcher](https://etcher.balena.io/) (Windows, macOS, Linux) or [Rufus](https://rufus.ie/) on Windows — if Rufus asks, pick **DD image mode**. On Linux you can also use `dd` (replace `/dev/sdX` with your stick — double-check it):
|
||||||
|
|
||||||
|
```
|
||||||
|
sudo dd if={iso} of=/dev/sdX bs=4M status=progress oflag=sync
|
||||||
|
```
|
||||||
|
- title: "Start the computer from the stick"
|
||||||
|
body: "Plug in the stick and the network cable, switch the computer on and press the one-time boot menu key (often <kbd>F11</kbd>, <kbd>F12</kbd> or <kbd>Esc</kbd> — it flashes briefly on screen). Pick the USB stick. If the computer refuses to start from it, switch off **Secure Boot** in the firmware settings."
|
||||||
|
- title: "Open the installer from another device"
|
||||||
|
body: "After a short while the screen shows an address — usually **http://proksi.local:5000**, plus the IP address as a fallback. Open it in a browser on your phone or laptop."
|
||||||
|
- title: "Click through the wizard"
|
||||||
|
body: "Three pages: a name for your server with your username and password, the disk to install on, and a last check. Then the installer downloads and sets everything up."
|
||||||
|
- title: "Pull the stick, restart, done"
|
||||||
|
body: "When the wizard says so, remove the USB stick and restart. Your server comes up at **http://<name>.local** — for example http://furtka.local."
|
||||||
|
verify_label: "Check the download (optional)"
|
||||||
|
verify_intro: "Compare the checksum of the file you downloaded with this one:"
|
||||||
|
verify_missing: "This release has no published checksum for the ISO yet — future releases include one."
|
||||||
|
older: "All releases and changelogs"
|
||||||
|
---
|
||||||
|
|
@ -1,6 +1,11 @@
|
||||||
---
|
---
|
||||||
title: "Welches Logo?"
|
title: "Unser neues Logo"
|
||||||
description: "Zwei Vorschläge für das Furtka-Zeichen. Wähl das, das dir besser gefällt — ein Klick genügt."
|
description: "Zwei Vorschläge für das Furtka-Zeichen, und ihr habt gewählt. So ist die Abstimmung ausgegangen — und so sähe jedes Zeichen überall aus, wo es funktionieren müsste."
|
||||||
|
closed: true
|
||||||
|
result: "Die Abstimmung ist beendet — **M hat mit 29 von 42 Stimmen gewonnen** (R: 13). Danke an alle, die abgestimmt haben! M ist jetzt das Furtka-Logo."
|
||||||
|
final:
|
||||||
|
m: 29
|
||||||
|
r: 13
|
||||||
translationKey: "logo"
|
translationKey: "logo"
|
||||||
layout: single
|
layout: single
|
||||||
type: poll
|
type: poll
|
||||||
|
|
@ -17,7 +22,7 @@ r:
|
||||||
title: "R — Fenster, Rad und F"
|
title: "R — Fenster, Rad und F"
|
||||||
text: "Ein Bogenfenster mit einem Speichenrad dahinter; in der oberen rechten Scheibe wird die Speiche zum F."
|
text: "Ein Bogenfenster mit einem Speichenrad dahinter; in der oberen rechten Scheibe wird die Speiche zum F."
|
||||||
show:
|
show:
|
||||||
intro: "Noch unentschieden? Hier ist jedes Zeichen überall dort, wo es funktionieren muss."
|
intro: "Beide Zeichen überall dort, wo sie hätten funktionieren müssen."
|
||||||
sizes: "Groß und klein"
|
sizes: "Groß und klein"
|
||||||
sizes_text: "Vom Poster bis zum 16-Pixel-Symbol im Browser-Tab. Unter 32 Pixeln wechseln beide auf eine vereinfachte Zeichnung — M verliert nichts, R behält Fenster, Kreuz und Nabe."
|
sizes_text: "Vom Poster bis zum 16-Pixel-Symbol im Browser-Tab. Unter 32 Pixeln wechseln beide auf eine vereinfachte Zeichnung — M verliert nichts, R behält Fenster, Kreuz und Nabe."
|
||||||
name: "Mit dem Namen"
|
name: "Mit dem Namen"
|
||||||
|
|
@ -48,6 +53,6 @@ labels:
|
||||||
*Furtka* ist polnisch für die kleine Gartenpforte — die Tür im Zaun, durch
|
*Furtka* ist polnisch für die kleine Gartenpforte — die Tür im Zaun, durch
|
||||||
die man hineinkommt, ohne das große Tor aufzumachen. Beide Zeichen spielen
|
die man hineinkommt, ohne das große Tor aufzumachen. Beide Zeichen spielen
|
||||||
damit: das eine zeichnet den Buchstaben ins Tor, das andere schaut durchs
|
damit: das eine zeichnet den Buchstaben ins Tor, das andere schaut durchs
|
||||||
Tor auf ein Rad. Stimm direkt hier ab — oder scroll erst weiter und sieh
|
Tor auf ein Rad. Unten stehen beide mit dem Endergebnis — und jedes Zeichen
|
||||||
beide Zeichen überall, wo sie funktionieren müssen, vom Poster bis zum
|
überall dort, wo es hätte funktionieren müssen, vom Poster bis zum winzigen
|
||||||
winzigen Symbol im Browser-Tab.
|
Symbol im Browser-Tab.
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,11 @@
|
||||||
---
|
---
|
||||||
title: "Which logo?"
|
title: "Our new logo"
|
||||||
description: "Two proposals for the Furtka mark. Pick the one you like better — it takes one click."
|
description: "Two proposals for the Furtka mark, and you picked one. Here is how the vote ended — and each mark everywhere it would have had to work."
|
||||||
|
closed: true
|
||||||
|
result: "The vote is closed — **M won with 29 of 42 votes** (R: 13). Thank you to everyone who voted! M is now the Furtka logo."
|
||||||
|
final:
|
||||||
|
m: 29
|
||||||
|
r: 13
|
||||||
translationKey: "logo"
|
translationKey: "logo"
|
||||||
url: /logo/
|
url: /logo/
|
||||||
layout: single
|
layout: single
|
||||||
|
|
@ -18,7 +23,7 @@ r:
|
||||||
title: "R — window, wheel and F"
|
title: "R — window, wheel and F"
|
||||||
text: "An arched window with a wheel of spokes behind it; in the top-right pane the spoke becomes an F."
|
text: "An arched window with a wheel of spokes behind it; in the top-right pane the spoke becomes an F."
|
||||||
show:
|
show:
|
||||||
intro: "Not sure yet? Here is each mark everywhere it would have to work."
|
intro: "Both marks everywhere they would have had to work."
|
||||||
sizes: "Big and small"
|
sizes: "Big and small"
|
||||||
sizes_text: "From a poster to the 16-pixel icon in a browser tab. Below 32 pixels both marks switch to a simplified drawing — M drops nothing, R keeps the window, the cross and the hub."
|
sizes_text: "From a poster to the 16-pixel icon in a browser tab. Below 32 pixels both marks switch to a simplified drawing — M drops nothing, R keeps the window, the cross and the hub."
|
||||||
name: "With the name"
|
name: "With the name"
|
||||||
|
|
@ -49,5 +54,5 @@ labels:
|
||||||
*Furtka* is Polish for a small garden gate — the little door in the fence
|
*Furtka* is Polish for a small garden gate — the little door in the fence
|
||||||
that lets you in without opening the whole thing. Both marks play with that:
|
that lets you in without opening the whole thing. Both marks play with that:
|
||||||
one draws the letter into the gate, the other looks through the gate at a
|
one draws the letter into the gate, the other looks through the gate at a
|
||||||
wheel. Vote right here — or scroll on first and see both marks everywhere
|
wheel. Below are both, with the final count — and each mark everywhere it
|
||||||
they would have to work, from a poster to the tiny icon in a browser tab.
|
would have had to work, from a poster to the tiny icon in a browser tab.
|
||||||
|
|
|
||||||
|
|
@ -6,8 +6,13 @@ enableRobotsTXT = true
|
||||||
|
|
||||||
[params]
|
[params]
|
||||||
description = "Open-source home server OS — simple enough for everyone."
|
description = "Open-source home server OS — simple enough for everyone."
|
||||||
version = "26.20-alpha"
|
version = "26.21-alpha"
|
||||||
contactEmail = "hallo@furtka.org"
|
contactEmail = "hallo@furtka.org"
|
||||||
|
# Forgejo repo the download page reads its latest release (ISO asset,
|
||||||
|
# size, date, checksum) from at build time. `version` above is only the
|
||||||
|
# fallback when that lookup fails.
|
||||||
|
forgejoURL = "https://forgejo.sourcegate.online"
|
||||||
|
repoPath = "daniel/furtka"
|
||||||
|
|
||||||
[markup.goldmark.renderer]
|
[markup.goldmark.renderer]
|
||||||
unsafe = true
|
unsafe = true
|
||||||
|
|
@ -32,5 +37,12 @@ enableRobotsTXT = true
|
||||||
[build]
|
[build]
|
||||||
writeStats = true
|
writeStats = true
|
||||||
|
|
||||||
|
# The release lookup must be fresh on every build — Hugo's default keeps
|
||||||
|
# remote resources cached forever, which would pin the download page to
|
||||||
|
# whatever release existed on the first build.
|
||||||
|
[caches]
|
||||||
|
[caches.getresource]
|
||||||
|
maxAge = 0
|
||||||
|
|
||||||
[minify]
|
[minify]
|
||||||
minifyOutput = true
|
minifyOutput = true
|
||||||
|
|
|
||||||
63
website/layouts/download/single.html
Normal file
|
|
@ -0,0 +1,63 @@
|
||||||
|
{{ define "main" }}
|
||||||
|
{{- $r := partialCached "release.html" . "release" -}}
|
||||||
|
{{- $file := path.Base $r.url -}}
|
||||||
|
<article class="download">
|
||||||
|
<header class="dl-hero">
|
||||||
|
<p class="status-chip"><span class="mono">{{ $r.version }}</span></p>
|
||||||
|
<h1>{{ .Title }}</h1>
|
||||||
|
<p class="lede">{{ .Description }}</p>
|
||||||
|
|
||||||
|
<div class="dl-card">
|
||||||
|
<a class="cta cta--primary" href="{{ $r.url }}" download>
|
||||||
|
<svg aria-hidden="true" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.2" stroke-linecap="round" stroke-linejoin="round"><path d="M12 3v12"/><path d="m7 10 5 5 5-5"/><path d="M5 21h14"/></svg>
|
||||||
|
{{ .Params.button }}
|
||||||
|
</a>
|
||||||
|
<dl class="dl-meta">
|
||||||
|
<div><dt>ISO</dt><dd class="mono">{{ $file }}</dd></div>
|
||||||
|
{{ with $r.size }}<div><dt>{{ $.Params.size_label }}</dt><dd>{{ lang.FormatNumber 1 (div (float .) 1e9) }} GB</dd></div>{{ end }}
|
||||||
|
{{ with $r.date }}<div><dt>{{ $.Params.released }}</dt><dd>{{ time.Format ":date_long" . }}</dd></div>{{ end }}
|
||||||
|
</dl>
|
||||||
|
<p class="dl-host">{{ .Params.host_note }}</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<p class="dl-alpha">{{ .Params.alpha | markdownify }}</p>
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<section class="dl-section">
|
||||||
|
<p class="section-eyebrow">{{ .Params.need_label }}</p>
|
||||||
|
<ul class="dl-needs">
|
||||||
|
{{ range .Params.needs }}<li>{{ . | markdownify }}</li>{{ end }}
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="dl-section">
|
||||||
|
<p class="section-eyebrow">{{ .Params.steps_label }}</p>
|
||||||
|
<ol class="dl-steps">
|
||||||
|
{{ range .Params.steps }}
|
||||||
|
<li class="step-card">
|
||||||
|
<h2>{{ .title }}</h2>
|
||||||
|
<div class="step-body">{{ replace .body "{iso}" $file | markdownify }}</div>
|
||||||
|
</li>
|
||||||
|
{{ end }}
|
||||||
|
</ol>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="dl-section">
|
||||||
|
<p class="section-eyebrow">{{ .Params.verify_label }}</p>
|
||||||
|
{{ with $r.sha256 }}
|
||||||
|
<p>{{ $.Params.verify_intro }}</p>
|
||||||
|
<pre class="dl-hash"><code>{{ . }}</code></pre>
|
||||||
|
<pre class="dl-cmds"><code><span class="c"># Linux</span>
|
||||||
|
sha256sum {{ $file }}
|
||||||
|
<span class="c"># macOS</span>
|
||||||
|
shasum -a 256 {{ $file }}
|
||||||
|
<span class="c"># Windows (PowerShell)</span>
|
||||||
|
Get-FileHash {{ $file }}</code></pre>
|
||||||
|
{{ else }}
|
||||||
|
<p class="dl-muted">{{ $.Params.verify_missing }}</p>
|
||||||
|
{{ end }}
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<p class="dl-older"><a href="{{ $r.all }}">{{ .Params.older }} →</a></p>
|
||||||
|
</article>
|
||||||
|
{{ end }}
|
||||||
|
|
@ -1,19 +1,20 @@
|
||||||
{{ define "main" }}
|
{{ define "main" }}
|
||||||
|
{{- $r := partialCached "release.html" . "release" -}}
|
||||||
|
{{- $dl := "download/" | relLangURL -}}
|
||||||
<article class="home">
|
<article class="home">
|
||||||
<header class="hero">
|
<header class="hero">
|
||||||
{{ with .Params.status }}
|
<p class="status-chip reveal"><span class="mono">{{ $r.version }}</span> — {{ .Params.status_text }}</p>
|
||||||
<p class="status-chip reveal">{{ . | safeHTML }}</p>
|
|
||||||
{{ end }}
|
|
||||||
<h1 class="reveal">{{ .Title }}</h1>
|
<h1 class="reveal">{{ .Title }}</h1>
|
||||||
{{ with site.Params.description }}<p class="lede reveal">{{ . }}</p>{{ end }}
|
{{ with site.Params.description }}<p class="lede reveal">{{ . }}</p>{{ end }}
|
||||||
<p class="cta-row reveal">
|
<p class="cta-row reveal">
|
||||||
<a class="cta cta--primary" href="https://forgejo.sourcegate.online/daniel/furtka/releases">
|
<a class="cta cta--primary" href="{{ $dl }}">
|
||||||
{{ if eq site.Language.Lang "de" }}Neuestes Release{{ else }}Latest release{{ end }}
|
{{ .Params.cta_download }}
|
||||||
<span aria-hidden="true">→</span>
|
<span aria-hidden="true">→</span>
|
||||||
</a>
|
</a>
|
||||||
|
<a class="cta cta--ghost" href="{{ site.Params.forgejoURL }}/{{ site.Params.repoPath }}">{{ .Params.cta_source }}</a>
|
||||||
</p>
|
</p>
|
||||||
{{ with .Params.poll_link }}
|
{{ with .Params.poll_link }}
|
||||||
<p class="reveal"><a class="home-poll" href="{{ . }}">{{ partial "mark-m.html" (dict "class" "" "id" "hm") }}{{ partial "mark-r.html" (dict "class" "" "id" "hr") }}<span>{{ $.Params.poll_text }} →</span></a></p>
|
<p class="reveal"><a class="home-poll" href="{{ . }}">{{ partial "mark-m.html" (dict "class" "" "id" "hm") }}<span>{{ $.Params.poll_text }} →</span></a></p>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
</header>
|
</header>
|
||||||
|
|
||||||
|
|
@ -21,6 +22,20 @@
|
||||||
<section class="intro">{{ . | markdownify }}</section>
|
<section class="intro">{{ . | markdownify }}</section>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
|
{{ with .Params.steps }}
|
||||||
|
<section class="feature-section">
|
||||||
|
{{ with $.Params.steps_label }}<p class="section-eyebrow">{{ . }}</p>{{ end }}
|
||||||
|
<ol class="how-steps">
|
||||||
|
{{ range . }}
|
||||||
|
<li class="how-step" data-gsap="card">
|
||||||
|
<h3>{{ .title }}</h3>
|
||||||
|
<p>{{ .body | markdownify }}</p>
|
||||||
|
</li>
|
||||||
|
{{ end }}
|
||||||
|
</ol>
|
||||||
|
</section>
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
{{ if .Params.features_today }}
|
{{ if .Params.features_today }}
|
||||||
<section class="feature-section">
|
<section class="feature-section">
|
||||||
{{ with .Params.features_today_label }}<p class="section-eyebrow">{{ . }}</p>{{ end }}
|
{{ with .Params.features_today_label }}<p class="section-eyebrow">{{ . }}</p>{{ end }}
|
||||||
|
|
@ -43,6 +58,16 @@
|
||||||
</section>
|
</section>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
|
{{ with .Params.band_title }}
|
||||||
|
<section class="dl-band" data-gsap="card">
|
||||||
|
<div>
|
||||||
|
<h2>{{ . }}</h2>
|
||||||
|
<p>{{ $.Params.band_text }}</p>
|
||||||
|
</div>
|
||||||
|
<a class="cta cta--primary" href="{{ $dl }}">{{ $.Params.cta_download }} <span aria-hidden="true">→</span></a>
|
||||||
|
</section>
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
{{ with .Content }}
|
{{ with .Content }}
|
||||||
<section class="prose closer">{{ . }}</section>
|
<section class="prose closer">{{ . }}</section>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,2 @@
|
||||||
<svg class="gate-mark" width="1em" height="1em" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true" focusable="false">
|
{{- /* Furtka mark (M, small-size tier) — generated by tools/brand-assets.py from logo-assets.py geometry. */ -}}
|
||||||
<path d="M4 20 V12 A9 9 0 0 1 20 12 V20"/>
|
<svg class="gate-mark" width="1em" height="1em" viewBox="0 0 64 64" aria-hidden="true" focusable="false"><path fill="currentColor" fill-rule="evenodd" d="M5 60V27a27 27 0 0 1 54 0v33Z M19.5 60V26A10 10 0 0 1 29.5 16H46v10H32a2.5 2.5 0 0 0-2.5 2.5V32H46v10H29.5v18Z"/></svg>
|
||||||
<line x1="12" y1="5" x2="12" y2="20"/>
|
|
||||||
<line x1="3" y1="20" x2="21" y2="20"/>
|
|
||||||
<line x1="15" y1="12" x2="15" y2="14.5"/>
|
|
||||||
</svg>
|
|
||||||
|
|
|
||||||
|
Before Width: | Height: | Size: 384 B After Width: | Height: | Size: 390 B |
|
|
@ -10,12 +10,13 @@
|
||||||
<meta name="theme-color" content="#f7f6f3" media="(prefers-color-scheme: light)">
|
<meta name="theme-color" content="#f7f6f3" media="(prefers-color-scheme: light)">
|
||||||
<meta name="theme-color" content="#0d0d0f" media="(prefers-color-scheme: dark)">
|
<meta name="theme-color" content="#0d0d0f" media="(prefers-color-scheme: dark)">
|
||||||
<link rel="icon" type="image/svg+xml" href="/favicon.svg">
|
<link rel="icon" type="image/svg+xml" href="/favicon.svg">
|
||||||
|
<link rel="apple-touch-icon" href="/apple-touch-icon.png">
|
||||||
<meta property="og:site_name" content="{{ site.Title }}">
|
<meta property="og:site_name" content="{{ site.Title }}">
|
||||||
<meta property="og:title" content="{{ if .IsHome }}{{ site.Title }}{{ else }}{{ .Title }} · {{ site.Title }}{{ end }}">
|
<meta property="og:title" content="{{ if .IsHome }}{{ site.Title }}{{ else }}{{ .Title }} · {{ site.Title }}{{ end }}">
|
||||||
<meta property="og:description" content="{{ with .Params.description }}{{ . }}{{ else }}{{ site.Params.description }}{{ end }}">
|
<meta property="og:description" content="{{ with .Params.description }}{{ . }}{{ else }}{{ site.Params.description }}{{ end }}">
|
||||||
<meta property="og:type" content="{{ if .IsPage }}article{{ else }}website{{ end }}">
|
<meta property="og:type" content="{{ if .IsPage }}article{{ else }}website{{ end }}">
|
||||||
<meta property="og:url" content="{{ .Permalink }}">
|
<meta property="og:url" content="{{ .Permalink }}">
|
||||||
{{ with .Params.image }}<meta property="og:image" content="{{ . | absURL }}">
|
{{ with .Params.image | default "/img/brand/social.png" }}<meta property="og:image" content="{{ . | absURL }}">
|
||||||
<meta property="og:image:width" content="1200">
|
<meta property="og:image:width" content="1200">
|
||||||
<meta property="og:image:height" content="630">
|
<meta property="og:image:height" content="630">
|
||||||
<meta name="twitter:card" content="summary_large_image">{{ end }}
|
<meta name="twitter:card" content="summary_large_image">{{ end }}
|
||||||
|
|
|
||||||
57
website/layouts/partials/release.html
Normal file
|
|
@ -0,0 +1,57 @@
|
||||||
|
{{- /*
|
||||||
|
Latest Furtka release that has an ISO attached, looked up on Forgejo at
|
||||||
|
build time. Returns a dict: version, url (ISO), size (bytes, 0 = unknown),
|
||||||
|
date (time or ""), sha256 ("" when the release has no .iso.sha256), page
|
||||||
|
(release page URL), live (false when the lookup failed and we fell back
|
||||||
|
to site.Params.version). Use via partialCached "release.html" . "release".
|
||||||
|
*/ -}}
|
||||||
|
{{- $repo := printf "%s/%s" site.Params.forgejoURL site.Params.repoPath -}}
|
||||||
|
{{- $v := site.Params.version -}}
|
||||||
|
{{- $out := dict
|
||||||
|
"version" $v
|
||||||
|
"url" (printf "%s/releases/download/%s/furtka-%s.iso" $repo $v $v)
|
||||||
|
"size" 0
|
||||||
|
"date" ""
|
||||||
|
"sha256" ""
|
||||||
|
"page" (printf "%s/releases/tag/%s" $repo $v)
|
||||||
|
"all" (printf "%s/releases" $repo)
|
||||||
|
"live" false
|
||||||
|
-}}
|
||||||
|
{{- $api := printf "%s/api/v1/repos/%s/releases?limit=10" site.Params.forgejoURL site.Params.repoPath -}}
|
||||||
|
{{- with try (resources.GetRemote $api) -}}
|
||||||
|
{{- with .Err -}}
|
||||||
|
{{- warnf "release.html: release lookup failed, using site.Params.version: %s" . -}}
|
||||||
|
{{- else with .Value -}}
|
||||||
|
{{- $done := false -}}
|
||||||
|
{{- range (. | transform.Unmarshal) -}}
|
||||||
|
{{- if and (not $done) (not .draft) -}}
|
||||||
|
{{- $rel := . -}}
|
||||||
|
{{- $iso := "" -}}
|
||||||
|
{{- $sum := "" -}}
|
||||||
|
{{- range .assets -}}
|
||||||
|
{{- if strings.HasSuffix .name ".iso" }}{{ $iso = . }}{{ end -}}
|
||||||
|
{{- if strings.HasSuffix .name ".iso.sha256" }}{{ $sum = . }}{{ end -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{- with $iso -}}
|
||||||
|
{{- $done = true -}}
|
||||||
|
{{- $out = merge $out (dict
|
||||||
|
"version" $rel.tag_name
|
||||||
|
"url" .browser_download_url
|
||||||
|
"size" .size
|
||||||
|
"date" (time.AsTime $rel.published_at)
|
||||||
|
"page" $rel.html_url
|
||||||
|
"live" true) -}}
|
||||||
|
{{- with $sum -}}
|
||||||
|
{{- with try (resources.GetRemote .browser_download_url) -}}
|
||||||
|
{{- with .Value -}}
|
||||||
|
{{- $hash := index (split (trim .Content " \n") " ") 0 -}}
|
||||||
|
{{- if eq (len $hash) 64 }}{{ $out = merge $out (dict "sha256" $hash) }}{{ end -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{- end -}}
|
||||||
|
{{- return $out -}}
|
||||||
|
|
@ -4,32 +4,43 @@
|
||||||
side gets the "first thing on the page" advantage for the whole poll. */}}
|
side gets the "first thing on the page" advantage for the whole poll. */}}
|
||||||
{{- $order := $p.order | default (slice "m" "r") -}}
|
{{- $order := $p.order | default (slice "m" "r") -}}
|
||||||
{{- $s := $p.show -}}
|
{{- $s := $p.show -}}
|
||||||
<article class="poll" data-poll="{{ $p.poll }}" data-api="/api/poll/{{ $p.poll }}">
|
<article class="{{ if $p.closed }}poll-closed{{ else }}poll{{ end }}" data-poll="{{ $p.poll }}" data-api="/api/poll/{{ $p.poll }}">
|
||||||
<header class="page-header">
|
<header class="page-header">
|
||||||
<h1>{{ .Title }}</h1>
|
<h1>{{ .Title }}</h1>
|
||||||
{{ with $p.description }}<p class="lede">{{ . }}</p>{{ end }}
|
{{ with $p.description }}<p class="lede">{{ . }}</p>{{ end }}
|
||||||
</header>
|
</header>
|
||||||
|
{{ with $p.result }}<p class="poll-result" role="status">{{ . | markdownify }}</p>{{ end }}
|
||||||
<div class="prose">{{ .Content }}</div>
|
<div class="prose">{{ .Content }}</div>
|
||||||
|
|
||||||
{{/* ── Quick vote ─────────────────────────────────────────── */}}
|
{{/* ── Quick vote ─────────────────────────────────────────── */}}
|
||||||
<div class="poll-grid" id="vote">
|
<div class="poll-grid" id="vote">
|
||||||
{{ range $k := $order }}{{ $d := index site.Data.logo $k }}
|
{{ range $k := $order }}{{ $d := index site.Data.logo $k }}
|
||||||
{{ $c := index $p $k }}
|
{{ $c := index $p $k }}
|
||||||
<section class="poll-card" data-choice="{{ $k }}" aria-labelledby="poll-{{ $k }}-title">
|
{{- $total := 0 }}{{ range $v := $p.final }}{{ $total = add $total $v }}{{ end }}
|
||||||
|
{{- $won := and $p.closed (eq $k (cond (gt (index $p.final "m") (index $p.final "r")) "m" "r")) }}
|
||||||
|
<section class="poll-card{{ if $won }} is-yours{{ end }}" data-choice="{{ $k }}" aria-labelledby="poll-{{ $k }}-title">
|
||||||
<div class="poll-art poll-art--{{ $k }}">{{ $d.display | safeHTML }}</div>
|
<div class="poll-art poll-art--{{ $k }}">{{ $d.display | safeHTML }}</div>
|
||||||
<h2 id="poll-{{ $k }}-title">{{ $c.title }}</h2>
|
<h2 id="poll-{{ $k }}-title">{{ $c.title }}</h2>
|
||||||
<p class="poll-desc">{{ $c.text }}</p>
|
<p class="poll-desc">{{ $c.text }}</p>
|
||||||
|
{{ if $p.closed }}
|
||||||
|
{{ $n := index $p.final $k }}
|
||||||
|
<div class="poll-bar poll-bar--final" aria-hidden="true"><i style="width: {{ div (mul $n 100) $total }}%"></i></div>
|
||||||
|
<p class="poll-count">{{ $n }} / {{ $total }}</p>
|
||||||
|
{{ else }}
|
||||||
<button type="button" class="poll-btn" data-vote="{{ $k }}">{{ $p.labels.vote }}</button>
|
<button type="button" class="poll-btn" data-vote="{{ $k }}">{{ $p.labels.vote }}</button>
|
||||||
<div class="poll-bar" aria-hidden="true"><i></i></div>
|
<div class="poll-bar" aria-hidden="true"><i></i></div>
|
||||||
<p class="poll-count" data-count="{{ $k }}"></p>
|
<p class="poll-count" data-count="{{ $k }}"></p>
|
||||||
|
{{ end }}
|
||||||
</section>
|
</section>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
</div>
|
</div>
|
||||||
|
{{ if not $p.closed }}
|
||||||
<p class="poll-status" role="status" aria-live="polite"
|
<p class="poll-status" role="status" aria-live="polite"
|
||||||
data-t-voted="{{ $p.labels.voted }}"
|
data-t-voted="{{ $p.labels.voted }}"
|
||||||
data-t-total="{{ $p.labels.total }}"
|
data-t-total="{{ $p.labels.total }}"
|
||||||
data-t-error="{{ $p.labels.error }}"
|
data-t-error="{{ $p.labels.error }}"
|
||||||
data-t-change="{{ $p.labels.change }}">{{ $p.labels.nojs }}</p>
|
data-t-change="{{ $p.labels.change }}">{{ $p.labels.nojs }}</p>
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
{{/* ── Showcase ───────────────────────────────────────────── */}}
|
{{/* ── Showcase ───────────────────────────────────────────── */}}
|
||||||
<div class="show">
|
<div class="show">
|
||||||
|
|
@ -148,6 +159,7 @@
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
{{/* ── Vote again at the end ─────────────────────────────── */}}
|
{{/* ── Vote again at the end ─────────────────────────────── */}}
|
||||||
|
{{ if not $p.closed }}
|
||||||
<section class="poll-final">
|
<section class="poll-final">
|
||||||
<h2 class="show-h">{{ $s.final }}</h2>
|
<h2 class="show-h">{{ $s.final }}</h2>
|
||||||
<div class="poll-final-row">
|
<div class="poll-final-row">
|
||||||
|
|
@ -162,7 +174,10 @@
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<p class="poll-note">{{ $p.labels.note | safeHTML }}</p>
|
<p class="poll-note">{{ $p.labels.note | safeHTML }}</p>
|
||||||
|
{{ end }}
|
||||||
</article>
|
</article>
|
||||||
|
{{ if not $p.closed }}
|
||||||
{{ $js := resources.Get "js/poll.js" | minify | fingerprint }}
|
{{ $js := resources.Get "js/poll.js" | minify | fingerprint }}
|
||||||
<script defer src="{{ $js.RelPermalink }}" integrity="{{ $js.Data.Integrity }}"></script>
|
<script defer src="{{ $js.RelPermalink }}" integrity="{{ $js.Data.Integrity }}"></script>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
{{ end }}
|
||||||
|
|
|
||||||
BIN
website/static/apple-touch-icon.png
Normal file
|
After Width: | Height: | Size: 1.6 KiB |
|
|
@ -1,6 +1 @@
|
||||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="#a33e2e" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round">
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><style>svg{color:#c03a28}@media (prefers-color-scheme:dark){svg{color:#ff6b56}}</style><path fill="currentColor" fill-rule="evenodd" d="M5 60V27a27 27 0 0 1 54 0v33Z M19.5 60V26A10 10 0 0 1 29.5 16H46v10H32a2.5 2.5 0 0 0-2.5 2.5V32H46v10H29.5v18Z"/></svg>
|
||||||
<path d="M4 20 V12 A9 9 0 0 1 20 12 V20"/>
|
|
||||||
<line x1="12" y1="5" x2="12" y2="20"/>
|
|
||||||
<line x1="3" y1="20" x2="21" y2="20"/>
|
|
||||||
<line x1="15" y1="12" x2="15" y2="14.5"/>
|
|
||||||
</svg>
|
|
||||||
|
|
|
||||||
|
Before Width: | Height: | Size: 334 B After Width: | Height: | Size: 316 B |
BIN
website/static/img/brand/social.png
Normal file
|
After Width: | Height: | Size: 14 KiB |
104
website/tools/brand-assets.py
Normal file
|
|
@ -0,0 +1,104 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Generate the Furtka brand files from the winning logo (Mark M) everywhere
|
||||||
|
it ships: website, live installer, on-box UI, ISO boot splash, repo docs.
|
||||||
|
|
||||||
|
python3 website/tools/brand-assets.py
|
||||||
|
|
||||||
|
Reuses the geometry and rasteriser of logo-assets.py (the poll showcase), so
|
||||||
|
the mark is drawn from one source. Needs the same build-only deps: cairosvg,
|
||||||
|
Pillow, fontTools. Output files are committed; re-run after a geometry change.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import importlib.util
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
HERE = os.path.dirname(os.path.abspath(__file__))
|
||||||
|
REPO = os.path.abspath(os.path.join(HERE, "..", ".."))
|
||||||
|
|
||||||
|
_spec = importlib.util.spec_from_file_location("logo_assets", os.path.join(HERE, "logo-assets.py"))
|
||||||
|
la = importlib.util.module_from_spec(_spec)
|
||||||
|
_spec.loader.exec_module(la)
|
||||||
|
|
||||||
|
K = "m"
|
||||||
|
COLOR = la.MARKS[K]["color"] # light-theme accent
|
||||||
|
COLOR_DARK = "#ff6b56" # dark-theme accent used by the site and the box UI
|
||||||
|
INK = la.MARKS[K]["ink"]
|
||||||
|
|
||||||
|
|
||||||
|
def out(*parts):
|
||||||
|
path = os.path.join(REPO, *parts)
|
||||||
|
os.makedirs(os.path.dirname(path), exist_ok=True)
|
||||||
|
return path
|
||||||
|
|
||||||
|
|
||||||
|
def favicon_svg():
|
||||||
|
"""Small-size tier, accent colour, lighter accent on dark browser chrome."""
|
||||||
|
inner = la.body(K, "min", "currentColor")
|
||||||
|
x, y, w, h = la.MARKS[K]["vb"]
|
||||||
|
return (
|
||||||
|
f'<svg xmlns="http://www.w3.org/2000/svg" viewBox="{x} {y} {w} {h}">'
|
||||||
|
f"<style>svg{{color:{COLOR}}}"
|
||||||
|
f"@media (prefers-color-scheme:dark){{svg{{color:{COLOR_DARK}}}}}</style>"
|
||||||
|
f"{inner}</svg>\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def mark_svg(tier, color):
|
||||||
|
return (
|
||||||
|
la.svg(K, tier, color, standalone=True)
|
||||||
|
.replace(' class="pm"', "")
|
||||||
|
.replace(' aria-hidden="true" focusable="false"', "")
|
||||||
|
+ "\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def lockup_svg(color):
|
||||||
|
s = la.lockup(K).replace("currentColor", color)
|
||||||
|
return (
|
||||||
|
s.replace('<svg class="pm"', f"<svg {la.XMLNS}").replace(
|
||||||
|
' aria-hidden="true" focusable="false"', ' role="img" aria-label="Furtka"'
|
||||||
|
)
|
||||||
|
+ "\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def write(path, text):
|
||||||
|
with open(path, "w") as f:
|
||||||
|
f.write(text)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
fav = favicon_svg()
|
||||||
|
for p in (
|
||||||
|
("website", "static", "favicon.svg"),
|
||||||
|
("webinstaller", "static", "favicon.svg"),
|
||||||
|
("assets", "www", "favicon.svg"),
|
||||||
|
):
|
||||||
|
write(out(*p), fav)
|
||||||
|
|
||||||
|
la.tile(K, 180, pad=0.2).convert("RGB").save(
|
||||||
|
out("website", "static", "apple-touch-icon.png"), optimize=True
|
||||||
|
)
|
||||||
|
# Default share card for pages without their own og:image.
|
||||||
|
la.lockup_png(K, 1200, 630, False, 230).convert("RGB").save(
|
||||||
|
out("website", "static", "img", "brand", "social.png"), optimize=True
|
||||||
|
)
|
||||||
|
# syslinux (BIOS boot menu) wants a 640x480 PNG and draws its menu over
|
||||||
|
# the middle of it, so the lockup sits small in the top band — same
|
||||||
|
# layout as releng's Arch splash, which build.sh replaces with this.
|
||||||
|
splash_band = la.lockup_png(K, 640, 120, False, 44)
|
||||||
|
splash = la.Image.new("RGBA", (640, 480), INK)
|
||||||
|
splash.alpha_composite(splash_band, (0, 8))
|
||||||
|
splash.convert("RGB").save(out("iso", "overlay", "splash.png"), optimize=True)
|
||||||
|
|
||||||
|
write(out("docs", "brand", "furtka-mark.svg"), mark_svg("flat", COLOR))
|
||||||
|
write(out("docs", "brand", "furtka-mark-small.svg"), mark_svg("min", COLOR))
|
||||||
|
write(out("docs", "brand", "furtka-lockup.svg"), lockup_svg(COLOR))
|
||||||
|
write(out("docs", "brand", "furtka-lockup-white.svg"), lockup_svg("#ffffff"))
|
||||||
|
write(out("docs", "brand", "console-banner.txt"), la.banner(K, cols=20) + "\n")
|
||||||
|
print("brand assets ok")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
sys.exit(main())
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
# ruff: noqa: E501 — inline SVG markup reads better unwrapped
|
||||||
"""Generate the logo-poll showcase assets for /logo/ from one geometry source.
|
"""Generate the logo-poll showcase assets for /logo/ from one geometry source.
|
||||||
|
|
||||||
python3 website/tools/logo-assets.py
|
python3 website/tools/logo-assets.py
|
||||||
|
|
@ -10,6 +11,7 @@ the output — the site build itself needs nothing beyond Hugo.
|
||||||
Mark M: lowercase f knocked out of a gate, 64-unit grid (even-odd fill).
|
Mark M: lowercase f knocked out of a gate, 64-unit grid (even-odd fill).
|
||||||
Mark R: window, wheel and F, 104x114 grid, stroke 8 (from Robert's sketch).
|
Mark R: window, wheel and F, 104x114 grid, stroke 8 (from Robert's sketch).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import base64
|
import base64
|
||||||
import io
|
import io
|
||||||
import json
|
import json
|
||||||
|
|
@ -119,7 +121,9 @@ def raster(svgtxt, w, h):
|
||||||
|
|
||||||
def mark_png(k, tier, height, color=None):
|
def mark_png(k, tier, height, color=None):
|
||||||
_, _, w, h = MARKS[k]["vb"]
|
_, _, w, h = MARKS[k]["vb"]
|
||||||
return raster(svg(k, tier, color or MARKS[k]["color"], standalone=True), round(height * w / h), height)
|
return raster(
|
||||||
|
svg(k, tier, color or MARKS[k]["color"], standalone=True), round(height * w / h), height
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------- wordmark
|
# ---------------------------------------------------------------- wordmark
|
||||||
|
|
@ -141,7 +145,9 @@ def wordmark(text, size, x0=0.0, baseline=0.0, tracking=-0.028):
|
||||||
g.draw(pen)
|
g.draw(pen)
|
||||||
d = pen.getCommands()
|
d = pen.getCommands()
|
||||||
if d:
|
if d:
|
||||||
parts.append(f'<path transform="translate({x:.2f} {baseline:.2f}) scale({s:.5f} {-s:.5f})" d="{d}"/>')
|
parts.append(
|
||||||
|
f'<path transform="translate({x:.2f} {baseline:.2f}) scale({s:.5f} {-s:.5f})" d="{d}"/>'
|
||||||
|
)
|
||||||
x += g.width * s + tracking * size
|
x += g.width * s + tracking * size
|
||||||
return "".join(parts), x - x0 - tracking * size
|
return "".join(parts), x - x0 - tracking * size
|
||||||
|
|
||||||
|
|
@ -241,21 +247,24 @@ def vote_card(path):
|
||||||
m = mark_png(k, "flat", 330)
|
m = mark_png(k, "flat", 330)
|
||||||
im.alpha_composite(m, (cx - m.width // 2, 110 - (m.height - 330) // 2))
|
im.alpha_composite(m, (cx - m.width // 2, 110 - (m.height - 330) // 2))
|
||||||
size = 46
|
size = 46
|
||||||
d = ImageDraw.Draw(im)
|
|
||||||
for text, cx, col in (("M", W // 4, "#6b6b6f"), ("R", 3 * W // 4, "#8a8a90")):
|
for text, cx, col in (("M", W // 4, "#6b6b6f"), ("R", 3 * W // 4, "#8a8a90")):
|
||||||
paths, tw = wordmark(text, size)
|
paths, tw = wordmark(text, size)
|
||||||
# letters via the same outlines: rasterise a tiny SVG for crisp text
|
# letters via the same outlines: rasterise a tiny SVG for crisp text
|
||||||
svgtxt = (f'<svg {XMLNS} viewBox="0 -{size} {tw:.0f} {size * 1.3:.0f}">'
|
svgtxt = (
|
||||||
f'<g fill="{col}">{paths}</g></svg>')
|
f'<svg {XMLNS} viewBox="0 -{size} {tw:.0f} {size * 1.3:.0f}">'
|
||||||
|
f'<g fill="{col}">{paths}</g></svg>'
|
||||||
|
)
|
||||||
t = raster(svgtxt, round(tw), round(size * 1.3))
|
t = raster(svgtxt, round(tw), round(size * 1.3))
|
||||||
im.alpha_composite(t, (cx - t.width // 2, 500))
|
im.alpha_composite(t, (cx - t.width // 2, 500))
|
||||||
# url line, centred on the seam
|
# url line, centred on the seam
|
||||||
paths, tw = wordmark("furtka.org/logo", 40)
|
paths, tw = wordmark("furtka.org/logo", 40)
|
||||||
svgtxt = (f'<svg {XMLNS} viewBox="0 -40 {tw:.0f} 52"><g fill="#c03a28">{paths}</g></svg>')
|
svgtxt = f'<svg {XMLNS} viewBox="0 -40 {tw:.0f} 52"><g fill="#c03a28">{paths}</g></svg>'
|
||||||
t = raster(svgtxt, round(tw), 52)
|
t = raster(svgtxt, round(tw), 52)
|
||||||
pad = 18
|
pad = 18
|
||||||
box = Image.new("RGBA", (t.width + 2 * pad, t.height + 2 * pad), "#f7f6f3")
|
box = Image.new("RGBA", (t.width + 2 * pad, t.height + 2 * pad), "#f7f6f3")
|
||||||
ImageDraw.Draw(box).rounded_rectangle([0, 0, box.width - 1, box.height - 1], 14, outline="#e4e3dc")
|
ImageDraw.Draw(box).rounded_rectangle(
|
||||||
|
[0, 0, box.width - 1, box.height - 1], 14, outline="#e4e3dc"
|
||||||
|
)
|
||||||
box.alpha_composite(t, (pad, pad))
|
box.alpha_composite(t, (pad, pad))
|
||||||
im.alpha_composite(box, (W // 2 - box.width // 2, 40))
|
im.alpha_composite(box, (W // 2 - box.width // 2, 40))
|
||||||
im.convert("RGB").save(path, optimize=True)
|
im.convert("RGB").save(path, optimize=True)
|
||||||
|
|
|
||||||