Skip to content

LordOS — a free, fast and secure GNU/Linux distribution based on Debian, with its own desktop environment: display server and Wayland compositor in C, a React UI engine on QuickJS, and private native apps.

Docs audit (part 1): SESSIONS multi-monitor lending, BENCHMARK status and real lord.sysinfo API, WAYLAND protocol table and pending list, PRIVACY namespaces and enforcement, NATIVE-APPS lord.fs reach and pending, DOCK, GPU log path, LANGUAGES key counts, NOTES strikethrough, UPDATES CDN note

Federico Pereirab2f4eed6bfb7
diff --git a/docs/BENCHMARK.md b/docs/BENCHMARK.md
index e2085e6..eee3c5f 100644
--- a/docs/BENCHMARK.md
+++ b/docs/BENCHMARK.md
@@ -1,6 +1,6 @@
# System Information, LordBench and hardware reports (proposal)
-**Status: design proposal; the 0.8.5 collector and `lordos-sysreport` are built (below), the rest is not.** It plans three releases and a later stage:
+**Status: design proposal. Built for 0.8.5 (in development, see "Work plan for 0.8.5" below): the collector, `lordos-sysreport report|fetch`, the System Information app (Overview, Hardware, Compatibility, Checks, Report), the Sandbox Probe and the shared measurement library `server/src/bench`. LordBench (0.8.6), community reports (0.8.7) and the `checks`/`bench` subcommands of `lordos-sysreport` are not built.** It plans three releases and a later stage:
| Release | What |
|---|---|
@@ -103,7 +103,7 @@ the test:
|---|---|---|---|
| `sec.server-user` | §2.2 | `lord-server`'s uid ≠ 0 | — |
| `sec.app-sandbox` | §6.4 | `Seccomp: 2`, `NoNewPrivs: 1` on an isolated app | a probe app (a system package started like any isolated app) tries to read a file outside its grant, open a socket, `ptrace`, create a user namespace and reach another app's scope; every attempt must be refused |
-| `sec.helper-sandbox` | §6.7 | — | `lord-bench` itself checks after its own lock-in that `open` of a path, `socket` and `execve` fail |
+| `sec.helper-sandbox` | §6.7 | — | a child of the probe app that takes `sandbox_apply_helper()` checks that a unix socket, `exec`, `fork` and the app's data folder fail (0.8.5; `lord-bench` is planned to repeat it after its own lock-in in 0.8.6) |
| `sec.landlock` | §6.4 | Landlock ABI ≥ 6 | covered by the probe app |
| `sec.netperm` | §6.6 | `lord-netperm` running, programs attached, devices and Bluetooth programs loaded | the probe app, denied the network by a temporary rule, fails to connect to a local listener |
| `sec.code` | §6.9 | manifest present | every loaded bundle verified in this session |
@@ -115,8 +115,8 @@ the test:
| `gpu.used` | §7.3 | hardware renderer exists | GPU path on, or a warning with the reason |
| `sys.time`, `sys.firmware`, `sys.fans`, `sys.memcg`, `sys.pi-bootloader`, `sys.updates` | various | as listed in the Hardware tree | — |
-Thresholds live in a signed data file (`assets/sysinfo/checks.json`, in the code manifest). A
-failed check offers **Report a problem** with the bug template.
+Thresholds are constants in `apps/sysinfo/checks.js`, signed with the theme bundle (the separate
+`checks.json` first planned was not needed). A failed check offers **Report a problem** with the bug template.
### Compatibility
@@ -235,7 +235,8 @@ before installing.
## New interfaces, all under the rules of `AGENTS.md`
-- `lord.sysinfo` in `server/src/ui/js_hw.c`: `scan()`, `checks()`, `report()`; in 0.8.6
+- `lord.sysinfo` in `server/src/ui/js_hw.c`: `report()`, `markdown()`, `facts()`, `probe()` (built in
+ 0.8.5; the checks are evaluated in `apps/sysinfo/checks.js`); in 0.8.6
`bench.start(kind)`, `bench.poll()`, `bench.cancel()`.
- `lordos-sysreport`, a user command (not started by `lord-server`).
- One read-only admin action, `hw-memory-modules` (anyone, no arguments): SMBIOS memory device
@@ -338,7 +339,7 @@ temporary rule), video decode and encode and Vulkan (shown as *Not checked*).
(AMD desktop, Intel laptop, Nvidia desktop, Raspberry Pi 5, VM), the anonymization test,
`hw-memory-modules`, `lordos-sysreport report`.
2. The app: Overview, Hardware, Compatibility; About's button; en, es, pt; right to left.
-3. Checks, configured and effective, the probe app, signed `checks.json`, `lordos-sysreport checks`.
+3. Checks, configured and effective, the probe app, thresholds signed in `apps/sysinfo/checks.js` (built); `lordos-sysreport checks` (not built yet).
4. Reports with preview; docs; screenshots on VMs; the first real reports: the Raspberry Pi 5 with a
monitor and the maintainer's PC (Core i9-10900, Radeon RX 580), the first real AMD data in the
project.
diff --git a/docs/DOCK.md b/docs/DOCK.md
index 80da5ac..199e69a 100644
--- a/docs/DOCK.md
+++ b/docs/DOCK.md
@@ -233,7 +233,8 @@ Settings says so below "Position on screen".
## Pending
-- Minimize effect (genie or scale): the engine doesn't have `transform: scale` yet.
+- A genie minimize effect: the Default theme's is a scale towards the Dock (`useMinimizing` in
+ `themes/default/index.jsx`, `transform: scale` from a cached raster; `DESIGN.md`).
- Auto-hide for the Classic theme's bar.
- Dragging the Dock to another edge with the mouse (⇧ on the separator).
- Quick actions for `.lpk` apps (they would need to reach the isolated process through the broker).
diff --git a/docs/GPU.md b/docs/GPU.md
index 3b463d0..ff42b36 100644
--- a/docs/GPU.md
+++ b/docs/GPU.md
@@ -204,7 +204,8 @@ compositing is the GPU's work, and the CPU only uploads what changed in the UI.
To test it on the AMD PC (live ISO):
1. Boot.
-2. In the LordOS Terminal, `grep gpu /tmp/lord.log` (or whatever log the ISO uses): it must say
+2. In the LordOS Terminal, `grep gpu: ~/.cache/lordos/session.log` (or System Information →
+ Hardware → Graphics, 0.8.5): it must say
`GPU composition (AMD Radeon …)` and `cursor by hardware (cursor plane)`.
3. `vkcube`, `glmark2-es2-wayland`, a game (SuperTuxKart, 0 A.D.).
4. With `LORD_GPU_DEBUG=1`, in fullscreen `direct scanout: N frames` must appear.
diff --git a/docs/LANGUAGES.md b/docs/LANGUAGES.md
index fb4d1c9..dc3ada6 100644
--- a/docs/LANGUAGES.md
+++ b/docs/LANGUAGES.md
@@ -116,15 +116,15 @@ node tools/i18n-pack.mjs new fr "Français" French zero-one-other fr_FR # lord
node tools/i18n-check.mjs lordos-lang-fr.json # missing keys and variables
```
-Then copy `lordos-lang-fr.json` to `~/Descargas` and use **Settings → Language & Region →
+Then copy `lordos-lang-fr.json` to your Downloads folder and use **Settings → Language & Region →
Add**. Available plural rules: `one-other`, `zero-one-other`, `none`, `east-slavic`, `polish`,
`czech-slovak`, `arabic`. `node tools/i18n-pack.mjs export pt` exports an existing language in
the same format.
`node tools/i18n-check.mjs` with no arguments checks every bundled language and also the keys the
-code uses (`t('…')` in apps, themes and SDK) that don't exist in English. Today: 391 keys,
-complete in es, en and pt. It also runs `tools/brand-check.mjs`, which fails when a third-party
-brand or product name (another operating system, its apps or features) shows up in the catalogs,
+code uses (`t('…')` in apps, themes and SDK) that don't exist in English. Today (0.8.5 in
+development): 7,856 keys, complete in es, en and pt, and 481 error codes from the server. It also runs `tools/brand-check.mjs`, which fails when a third-party
+brand or product name (another system, its apps or features) shows up in the catalogs,
the Help articles, the app manifests, README.md or CHANGELOG.md: LordOS uses its own names
(Search, Apps, Night Light, Quick Preview…) and generic wording. Real exceptions go in its
`ALLOW` list.
diff --git a/docs/NATIVE-APPS.md b/docs/NATIVE-APPS.md
index 72be0ec..df50a7f 100644
--- a/docs/NATIVE-APPS.md
+++ b/docs/NATIVE-APPS.md
@@ -33,7 +33,7 @@ assets/… what the app reads at runtime: .wasm, images, data (optiona
"id": "fractal",
"name": { "es": "Fractal", "en": "Fractal" },
"description": { "es": "Explorador del conjunto de Mandelbrot", "en": "Mandelbrot set explorer" },
- "version": "1.0.0",
+ "version": "1.1.0",
"icon": "icon.png",
"size": [660, 520],
"minSize": [360, 300],
@@ -95,7 +95,9 @@ The rest of the SDK is the same as for the bundled apps (see `apps/README.md`).
## System apps (0.8.2)
-The apps in `apps/` are **system apps**: they are built into the theme bundles, which LordOS checks
+The apps in `apps/` are **system apps**: they are built into the theme bundles (or, for those that
+run as their own process, `"process": "isolated"`, into `assets/sysapps/<id>/`: Passwords, Mail,
+Calendar, Contacts, Reminders and, in 0.8.5, the hidden Sandbox Probe), which LordOS checks
against its signed manifest before running them (see [SIGNING.md](SIGNING.md), "Verified system
code"), and the Store never offers to remove them ("System app — part of LordOS"). An installed
`.lpk` is never a system app, even with the same id: the theme's app wins and the package is not
@@ -120,11 +122,15 @@ Since M8 there is **package signing** and a **permissions and isolation** model
`~/.local/share/lordos/appdata/<id>`.
What **always** limits any app (installed or not): lord-server runs without root, `lord.fs`
-works only in the home folder and doesn't write to the launch/install folders, the settings or
-`permisos.json`, and JS can't run commands or create `.desktop` files.
+writes only in the home folder and the user's mounts (since 0.8.5 it reads the whole tree as the
+user, except `/proc`, `/sys`, `/dev` and `/run`; an isolated app's broker keeps only its data
+folder), never to the launch/install folders, the settings or `permisos.json`, and JS can't run
+commands or create `.desktop` files.
+
+In the isolated process the system file dialog (powerbox), the microphone and camera (as rings),
+live theme tokens and language, menus in the menu bar and several windows are done (see
+`PRIVACY.md`, «Status»).
Pending:
-- in the isolated process: the system file dialog (powerbox), camera and microphone as an
- fd/stream, live theme tokens and language, and menus (see `PRIVACY.md`, «Status»);
- a LordOS app repository for the Store, with a signed catalog (see `SIGNING.md`).
diff --git a/docs/NOTES.md b/docs/NOTES.md
index be35a2b..45c1f20 100644
--- a/docs/NOTES.md
+++ b/docs/NOTES.md
@@ -122,7 +122,8 @@ and `toggleTask(text, line)`.
a single `<Text>`. So a paragraph is a row with `flexWrap: 'wrap'` and one `<Text>` per word
(the space is attached to the word): it breaks lines between words and each word carries its
style.
-- **Strikethrough.** Done with the combining character U+0336.
+- **Strikethrough.** A 1 px line drawn across each word (the combining character U+0336 used before
+ is missing from most fonts and drew boxes).
## Desktop widgets (`sdk/widgets.js`)
diff --git a/docs/PRIVACY.md b/docs/PRIVACY.md
index 951386b..137274b 100644
--- a/docs/PRIVACY.md
+++ b/docs/PRIVACY.md
@@ -37,13 +37,16 @@ Not every program on LordOS is sandboxed. This is exactly what applies to each k
|---|---|---|---|---|---|
| `.lpk` apps, Passwords, Mail, Calendar, Contacts, Reminders | own process (`lord-server --app <id>`) | yes | own (`app-lordos-lpk-<id>.scope`) | yes: every call is checked in `lord-server` | per app (`lpk:<id>`): network rules and every non-network restriction (broker) |
| Other built-in apps | inside `lord-server` | no | `lord-server`'s | no broker: camera, microphone and screen are checked in C (`js_media.c`), notifications in `sdk/notify.js` | as "LordOS" (`lordos`): network rules; camera, microphone, screen and notifications restrictions |
-| Linux apps from the launcher | own process | no by default; with "no access to your files", their own user, mount and PID namespace plus Landlock (no seccomp), from the next launch | own (`app-lordos-<id>.scope`) | no | per app (`desktop:<id>`), when the owner sets them: network rules; camera, USB and screen (`/dev/fb*`) devices and Bluetooth sockets in the kernel (`lord-netperm`); microphone and PipeWire cameras (our PipeWire guard, plus ALSA capture nodes in the kernel); files (the launcher); notifications (our notification server). Not the clipboard, and not BlueZ over D-Bus |
+| Linux apps from the launcher | own process | no by default; with "no access to your files", or restricted from the microphone, camera, USB or Bluetooth, their own user, mount, PID and IPC namespaces plus Landlock (no seccomp), from the next launch | own (`app-lordos-<id>.scope`) | no | per app (`desktop:<id>`), when the owner sets them: network rules; camera, USB and screen (`/dev/fb*`) devices and Bluetooth sockets in the kernel (`lord-netperm`); microphone and PipeWire cameras (our PipeWire guard, plus ALSA capture nodes in the kernel); files (the launcher); notifications (our notification server). Not the clipboard, and not BlueZ over D-Bus |
| Terminal programs | children of the Terminal's shell | no | `lord-server`'s | no | as "LordOS" (`lordos`): network rules |
-Flatpak and bubblewrap are not used. Namespaces are used in one place: a Linux app restricted
-with "no access to your files" starts in its own unprivileged user, mount and PID namespace,
-built by our own code in the launcher (`sec/sandbox.c`, `sandbox_files_isolate`), so it can't
-reach the session's sockets. The firewall's restrictions, where each one is enforced and what each
+Flatpak and bubblewrap are not used. Namespaces are used in two places: a Linux app restricted
+with "no access to your files", or from the microphone, camera, USB or Bluetooth, starts in its own
+unprivileged user, mount, PID and IPC namespaces (its own view: a runtime folder with only the
+Wayland and PipeWire sockets, private `/tmp`, `/dev/shm` and devpts; only "no access to your files"
+also hides the home), built by our own code in the launcher (`sec/sandbox.c`,
+`sandbox_files_isolate`), so it can't reach the session's sockets; and Xwayland (0.8.3) runs in an
+empty network namespace (see [X11 apps](#x11-apps-083)). The firewall's restrictions, where each one is enforced and what each
one doesn't cover are in [FIREWALL.md](FIREWALL.md#non-network-restrictions) and, for Linux apps,
[FIREWALL.md, "Linux apps"](FIREWALL.md#linux-apps).
@@ -182,8 +185,9 @@ Our own code, without bubblewrap, flatpak or firejail. It uses kernel 6.12 featu
(`unshare(CLONE_NEWNET)` needs `CAP_SYS_ADMIN`). Decision: the app stays in the machine's netns,
and **without the `network` permission** seccomp rejects `socket(AF_INET/AF_INET6)` and Landlock
(ABI ≥ 4) denies it TCP `bind`/`connect`. With the permission (declared **and** granted, decided
- at launch), they are allowed. The monitoring agent adds per-cgroup nftables rules (defense in
- depth) and attributes traffic by the scope's name.
+ at launch), they are allowed. On top of that, `lord-netperm`'s cgroup BPF programs enforce the
+ app's firewall rules in the kernel (defense in depth, see `FIREWALL.md`), and traffic is
+ attributed by the scope's name.
- **`no_new_privs`**, all capabilities dropped (empty `capset` + `PR_CAPBSET_DROP`).
- Its own **cgroup v2**, `app-lordos-lpk-<id>.scope`: `memory.high` 192 MB, `memory.max` 512 MB,
`cpu.max` one core.
diff --git a/docs/SESSIONS.md b/docs/SESSIONS.md
index eea9a35..5002621 100644
--- a/docs/SESSIONS.md
+++ b/docs/SESSIONS.md
@@ -403,7 +403,9 @@ session. Everything that changes something goes through closed `admin.c` actions
## Pending
-- **Multiple monitors:** a single connector is used, as before.
+- **Multiple monitors:** since 0.8.0 the session drives every display of the lent card
+ (`display_attach` → `outputs_apply` in `main.c`, see [DISPLAYS.md](DISPLAYS.md)); the lend/revoke
+ cycle with several real monitors is untested.
- **Text consoles:** Ctrl+Alt+F2 doesn't switch consoles while LordOS is running, as before.
- **Choosing the avatar image:** today it's a hand-typed path; the file picker is missing.
- **Testing with a real card** (AMD, on the live USB): in the VMs, the GPU could only be tested
diff --git a/docs/UPDATES.md b/docs/UPDATES.md
index ebc3ebc..5788864 100644
--- a/docs/UPDATES.md
+++ b/docs/UPDATES.md
@@ -319,4 +319,5 @@ for now.
check and `shellcheck` on every new script.
- **Not yet:** the CDN change above, so `https://lordos.org/apt-staging` is uploaded and signed but
`InRelease` still answers 404 (the router) and http 301; `apt-repo.sh verify staging` passes
- only after `tools/web/cdn-apt-behaviors.sh` is run by the account administrator.
+ only after `tools/web/cdn-apt-behaviors.sh` is run by the account administrator. (Done since: the 0.8.2
+ release test updated a 0.8.1 system from `https://lordos.org/apt`, `ISO.md`.)
diff --git a/docs/WAYLAND.md b/docs/WAYLAND.md
index 4b268a4..41adbf4 100644
--- a/docs/WAYLAND.md
+++ b/docs/WAYLAND.md
@@ -38,6 +38,9 @@ Apps that only speak X11 open through Xwayland, started on demand, with our own
| `xdg_wm_base` | 6 | windows (`xdg_toplevel`: title, move, resize, maximize, minimize, close) and popup menus (`xdg_popup` with `xdg_positioner`: anchor, gravity, flip and slide within the screen) |
| `zxdg_decoration_manager_v1` | 1 | the app picks who draws the frame: server side (Qt, foot, Kitty, Alacritty: the theme's frame) or client side (Chromium with its own bar), also while it's open (0.8.4) |
| `wp_cursor_shape_manager_v1` | 1 | the app asks for the cursor by name (Chromium, GTK 4, Qt 6) and LordOS draws its own (`cursor.c`, see `WINDOWS.md`) |
+| `org_kde_kwin_server_decoration_manager` | 1 | GTK 3's way to ask for the frame (Firefox, Mousepad; see "Who draws the frame") |
+| `zwp_idle_inhibit_manager_v1` | 1 | a video or presentation keeps the screen on while its surface is mapped (0.8.5, see the end of this page) |
+| `zwp_linux_dmabuf_v1` 4, `wp_presentation` 1, `wp_viewporter` 1, `zwp_relative_pointer_manager_v1` 1, `zwp_pointer_constraints_v1` 1 | | GPU buffers, presentation feedback, cropping and scaling, games' pointer (see `GPU.md` and `DISPLAYS.md`) |
Windows enter the SDK's window manager (`sdk/wayland.js`) as the internal app `linux` (id
`linux#<surface>`): the theme sees them like any other, with their title, focus, maximize,
@@ -463,7 +466,8 @@ display.
the build installed before (October 18) and with the LordOS frame, so it isn't the frame. To
investigate (two `wl_seat` bindings from the same client get the events twice).
- SVG app icons (most modern GTK/Qt apps only ship SVG).
-- Opening files with a Linux app (`%f`/`%u`), `.desktop` actions and terminal apps.
+- Terminal apps (`Terminal=true`: neither listed nor launched). (Opening files with a Linux app,
+ `%f`/`%u`, and `.desktop` actions: done, see "The launcher" above; actions since 0.8.1.)
- Already done (see `GPU.md`): `linux-dmabuf` v4, GPU composition (Mesa, optional), direct
fullscreen scanout, `wp_presentation`, `wp_viewporter`, `relative-pointer`,
`pointer-constraints`, real fullscreen (❖Esc exits) and app cursors (image or hidden).