| 1 |
# The Alloy Manual |
| 2 |
|
| 3 |
Alloy is an opinionated tiling user layer for Fedora Silverblue: an immutable |
| 4 |
base, the sway compositor, a curated terminal-first stack, and one authored |
| 5 |
control surface, the `alloy` console. |
| 6 |
|
| 7 |
This manual is for people who run Alloy. It says what the system does, which |
| 8 |
keys do it, and what to do when something does not work. The design documents |
| 9 |
one directory up (`docs/MANIFESTO.md`, `docs/STACK.md`, `docs/CONSOLE.md` and |
| 10 |
the rest) explain why each pick was made; they are written for whoever works on |
| 11 |
Alloy, not for whoever uses it. Nothing here replaces them. |
| 12 |
|
| 13 |
Alloy is pre-v0. Where a thing is not built yet, this manual says so instead of |
| 14 |
describing it in the future tense. |
| 15 |
|
| 16 |
## Chapters |
| 17 |
|
| 18 |
1. [What Alloy is](01-what-alloy-is.md) |
| 19 |
2. [Building your image](02-building-your-image.md) |
| 20 |
3. [Installing](03-installing.md) |
| 21 |
4. [The first fifteen minutes](04-first-fifteen-minutes.md) |
| 22 |
5. [Keybindings](05-keybindings.md) |
| 23 |
6. [The console](06-the-console.md) |
| 24 |
7. [Installing software](07-installing-software.md) |
| 25 |
8. [Updating and rolling back](08-updating-and-rolling-back.md) |
| 26 |
9. [Files, editing, and media](09-files-and-apps.md) |
| 27 |
10. [The shell](10-the-shell.md) |
| 28 |
11. [Appearance](11-appearance.md) |
| 29 |
12. [Network, mesh, sync, and backup](12-continuity.md) |
| 30 |
13. [Hardware and peripherals](13-hardware.md) |
| 31 |
14. [Troubleshooting](14-troubleshooting.md) |
| 32 |
15. [Questions](15-faq.md) |
| 33 |
|
| 34 |
## Two things to know before anything else |
| 35 |
|
| 36 |
**Nobody downloads Alloy.** There is no image to fetch and no registry to pull |
| 37 |
from. You take the source, build an installer ISO on your own Linux machine, |
| 38 |
and write it to a USB stick. Chapter 2 covers it. |
| 39 |
|
| 40 |
**An installed machine never reaches out on its own.** It does not check for |
| 41 |
updates, does not phone home, and does not enroll in anything until you ask. |
| 42 |
Updating means rebuilding the image and switching to it, which chapter 8 |
| 43 |
covers. |
| 44 |
|