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.

6.7 KB
Raw Blame

LordOS documentation

LordOS is a free GNU/Linux distribution based on Debian 13, with its own desktop environment: a display server and Wayland compositor written in C, its own interface engine, and native apps. This folder documents how it works, how to build it and how to verify it. Start with the paper for the big picture, or ARCHITECTURE.md for the technical map.

Website: lordos.org · Brand kit: LORDOS-BRAND.md

Start here

Document What it covers
PAPER.md The project paper: vision, architecture, security model, performance, roadmap
ARCHITECTURE.md Components, processes, dependencies and platforms
ROADMAP.md Milestones, what is done and what comes next
DESIGN.md Design guide for LordOS apps
LORDOS-BRAND.md Logo, colours, typography and the Lumo mascot

Install and build

Document What it covers
ISO.md The live and installable ISO for 64-bit PCs: building, booting, final test results
RASPBERRY.md The Raspberry Pi 5 image, our kernel with Landlock, boot switch files
IMAGER.md LordOS Imager: writing LordOS to cards and sticks, in LordOS and on other computers, and the first-run file
INSTALL-DEBIAN.md Installing LordOS on an existing Debian 13 with one command
VM-SETUP.md The development VM, step by step
UPDATES.md Updating an installed system in place from the signed APT repository, and migrations
TROUBLESHOOTING.md Known problems and how to fix them (for example a modified system component)
RELEASING.md How a release is made: changelog, tag, build, sign, SBOM and the GitHub release notes
../CHANGELOG.md What changed in each version (also the body of each GitHub release)

Desktop and display

Document What it covers
WAYLAND.md Linux apps (GTK, Qt, browsers) on our Wayland compositor
WINDOWS.md Moving and resizing windows, the Window menu, cursors
DISPLAYS.md Several displays and HiDPI
GPU.md GPU composition, dmabuf and the CPU path
DOCK.md Dock and taskbar
THEMES-GUIDE.md How to build a LordOS appearance (theme): anatomy, tokens, frames, building, verified code, testing
LAYERS.md The desktop's stacking order: what is drawn and clicked above what
SPOTLIGHT.md Search and the advanced clipboard
TRACKPAD.md Touchpads, gestures and touchscreens
SESSIONS.md Login screen, sessions, user switching, boot splash hand-off
REMOTE.md Remote desktop on the LAN (off by default, port 5673), SSH and root over SSH (0.8.5, advanced)
LANGUAGES.md Languages, regions, complex scripts, input methods, error messages

Privacy and security

Document What it covers
PRIVACY.md App isolation, permissions, and what is isolated today
FIREWALL.md Per-app firewall, restrictions, domain rules and blocklists (0.8.5)
SIGNING.md Package signing, trust levels and release signing
IMMUTABLE.md Design study: an immutable edition with A/B system images (0.8.2, experimental prototype)
SECURITY-REVIEW-0.8.0.md Security review before 0.8.0-beta: every finding and its status
PASSWORDS.md Passwords and the system keyring
COMPLIANCE.md Licence compliance, the SBOM, and the standards our processes align with
../SECURITY.md How to report a vulnerability
../CONTRIBUTING.md, ../CODE_OF_CONDUCT.md How to contribute, and the code of conduct

Apps

Document What it covers
NATIVE-APPS.md Installable native apps (.lpk)
PACKAGES.md Debian packages and the Store: our package engine, HTTPS downloads (0.8.5), the AI and Commercial catalogs
WASM.md WebAssembly apps
FILES.md Files
TERMINAL.md Terminal
EDITOR.md Text Editor
NOTES.md Notes
DOCUMENTS.md PDFs, archives, fonts and emoji
PRINTING.md Printing and scanning
MEDIA.md Photos, Player, Screenshots, Camera and Recorder
VIDEO.md Video in the browser without hardware decoding (H.264 instead of VP9/AV1)
MAIL.md Mail, Calendar, Contacts and Reminders
MONITOR.md Monitor: usage, processes, network map and connections, firewall, disk health, cooling
SYSTEM.md Disks, Backups, Logs, Clock and Help

System and hardware

Document What it covers
SETTINGS.md Settings hardware pages: displays, Bluetooth, energy, cooling, notifications, date and time, default apps
NETWORK.md Networking and VPNs
SOUND.md Sound (PipeWire)
FANS.md Fan control on the Raspberry Pi 5 and PCs
BENCHMARK.md System Information (0.8.5), LordBench and hardware reports: design and status

Measurements and validation

Document What it covers
PAPER-VALIDATION.md Each claim of the paper, how it is checked and its state
RESULTS.md Versioned results: measurements per version and machine, with the commands that produced them

Images and assets

Folder What it holds
screenshots/ Curated English screenshots, and gallery.json for the website gallery
brand/ Logo, icons, mascot and colours (see brand/README.md)
boot/ Boot menu and splash screenshots
iso-final/ Screenshots of the final ISO test
polish/ Before and after screenshots of the visual polish pass
packs/ Sample language pack and script test text
classic/ Screenshots of the Lord Classic theme and the Lord Flow theme, light and dark
imager/ Screenshots of LordOS Imager (native app and desktop app)
qa/ Screenshots of the app-by-app QA pass (see VM-SETUP.md)

Research notes

Document What it covers
HANDWIRED_NOTES.md Research notes on a related UI project