Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2026 AerynOS Developers
# SPDX-FileCopyrightText: 2026 aerynOS Developers
# SPDX-License-Identifier: MPL-2.0

name: CI
Expand Down
2 changes: 1 addition & 1 deletion .typos.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2026 AerynOS Developers
# SPDX-FileCopyrightText: 2026 aerynOS Developers
# SPDX-License-Identifier: MPL-2.0

[default]
Expand Down
10 changes: 5 additions & 5 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export default defineConfig({
light: "@/images/logo-light-mode.svg",
replacesTitle: false,
},
title: "AerynOS Docs",
title: "aerynOS Docs",
// Multilingual reference implementation:
// locales: {
// root: { label: "English", lang: "en" },
Expand All @@ -39,7 +39,7 @@ export default defineConfig({
{
icon: "github",
label: "GitHub",
href: "https://github.com/AerynOS/dotdev",
href: "https://github.com/aerynOS/dotdev",
},
{
icon: "zulip",
Expand All @@ -49,12 +49,12 @@ export default defineConfig({
{
icon: "mastodon",
label: "Mastodon",
href: "https://hachyderm.io/@AerynOS",
href: "https://hachyderm.io/@aerynOS",
},
],
customCss: ["@/styles/global.css"],
editLink: {
baseUrl: "https://github.com/AerynOS/dotdev/edit/main/",
baseUrl: "https://github.com/aerynOS/dotdev/edit/main/",
},
lastUpdated: true,
components: {
Expand Down Expand Up @@ -85,7 +85,7 @@ export default defineConfig({
],
sidebar: [
{
label: "AerynOS",
label: "aerynOS",
items: [
{ slug: "aerynos" },
{ slug: "aerynos/overview" },
Expand Down
4 changes: 2 additions & 2 deletions public/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/assets/macros/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Update this directory from github.com/AerynOS/moss/ (boulder/data/)
Update this directory from github.com/aerynOS/moss/ (boulder/data/)
Rebuilds will pick up new macro changes.
Markdown files still need to be created per group.
2 changes: 1 addition & 1 deletion src/content/docs/Developers/Stone/V1/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ copyright: "Copyright © 2025 aerynOS Developers"
---
import DirectoryList from '@components/DirectoryList.astro';

The v1 of the Stone format is the version currently employed by AerynOS, and is the first revision of our format.
The v1 of the Stone format is the version currently employed by aerynOS, and is the first revision of our format.

:::tip
The contents below extend the version-agnostic components of the Stone format.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/Developers/Stone/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ copyright: "Copyright © 2025 aerynOS Developers"
import DirectoryList from '@components/DirectoryList.astro';

The Stone format is a binary format designed to be type-safe and version-aware.
It is used to package and distribute software in AerynOS, in fact both the packages themselves
It is used to package and distribute software in aerynOS, in fact both the packages themselves
and the index file of repositories use the Stone format.

Anything encoded in the Stone format is called a *stone*.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/Developers/Stone/prelude.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ fields can be handled separately from version and format detection. This is a 32
It's the [magic number](https://en.wikipedia.org/wiki/Magic_number_(programming)) of the Stone format.

The `magic` field always contains `['\0', 'M', 'O', 'S']`.
It is defined after AerynOS's package manager: `moss`.
It is defined after aerynOS's package manager: `moss`.

In the Rust language it is defined as:

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/Developers/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Developers
lastUpdated: 2025-03-28T05:28:00Z
description: AerynOS developer documentation
description: aerynOS developer documentation
license: "CC-BY-SA-4.0"
copyright: "Copyright © 2025 aerynOS Developers"
---
Expand All @@ -13,6 +13,6 @@ import DirectoryList from '@components/DirectoryList.astro';
This documentation is only a stub and serves as a placeholder for future content. In time, the full format and payloads of of `moss` will be documented, along with other technologies such as `blsforme`, `os-info`, etc.
</Aside>

AerynOS includes some bespoke technologies and formats that are used to package, distribute, and introspect deployed software. This section of the documentation provides an overview of these technologies and formats.
aerynOS includes some bespoke technologies and formats that are used to package, distribute, and introspect deployed software. This section of the documentation provides an overview of these technologies and formats.

<DirectoryList/>
8 changes: 4 additions & 4 deletions src/content/docs/FAQ/aerynos-features.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AerynOS Features
title: aerynOS Features
lastUpdated: 2026-01-15T12:25:00Z
description: How to use the key features of AerynOS
description: How to use the key features of aerynOS
license: "CC-BY-SA-4.0"
copyright: "Copyright © 2025 aerynOS Developers"
---
Expand All @@ -25,13 +25,13 @@ sudo moss sync

Hold down or mash your Space key repeatedly after your computer starts up.

### How do I verify the integrity of my install states in AerynOS?
### How do I verify the integrity of my install states in aerynOS?

```sudo moss state verify```

Tack on ```--help``` to see the options for verify.

### How do I clean out older install states in AerynOS?
### How do I clean out older install states in aerynOS?

```sudo moss state prune```

Expand Down
18 changes: 9 additions & 9 deletions src/content/docs/FAQ/filesystems.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Filesystems
lastUpdated: 2026-01-15T12:25:00Z
description: Information about filesystem support on AerynOS
description: Information about filesystem support on aerynOS
license: "CC-BY-SA-4.0"
copyright: "Copyright © 2025 aerynOS Developers"
---
Expand All @@ -10,26 +10,26 @@ copyright: "Copyright © 2025 aerynOS Developers"

### Why do you recommend the xfs filesystem for the root partition?

[Testing has shown](https://github.com/AerynOS/os-tools/blob/main/moss-filesystem-performance.md) that, due to how moss saves rollback states, xfs is by far the quickest filesystem in practice for AerynOS root partition usage.
[Testing has shown](https://github.com/aerynOS/os-tools/blob/main/moss-filesystem-performance.md) that, due to how moss saves rollback states, xfs is by far the quickest filesystem in practice for aerynOS root partition usage.

We currently do not recommend either ext4 or f2fs root partitions, because testing has shown that they offer very poor performance on the first update (sudo moss sync -u) after a cold start of your computer compared to xfs.

### Do you support installing AerynOS on ext4?
### Do you support installing aerynOS on ext4?

We currently **strongly recommend** that you use **xfs** on your root partition for the best experience with moss and AerynOS.
We currently **strongly recommend** that you use **xfs** on your root partition for the best experience with moss and aerynOS.

### Do you support installing AerynOS on f2fs?
### Do you support installing aerynOS on f2fs?

We currently **strongly recommend** that you use **xfs** on your root partition for the best experience with moss and AerynOS.
We currently **strongly recommend** that you use **xfs** on your root partition for the best experience with moss and aerynOS.

### Do you support installing AerynOS on btrfs?
### Do you support installing aerynOS on btrfs?

Not yet

### Do you support installing AerynOS on bcachefs?
### Do you support installing aerynOS on bcachefs?

Not yet

### Do you support installing AerynOS on ZFS?
### Do you support installing aerynOS on ZFS?

Not at this stage. We may or may not decide to support it at some unspecified point in the future, provided we can guarantee that we are legally in the clear to do so.
34 changes: 17 additions & 17 deletions src/content/docs/FAQ/general-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ copyright: "Copyright © 2025 aerynOS Developers"

# Project identity

### What does AerynOS mean and how do I pronounce it?
### What does aerynOS mean and how do I pronounce it?

AerynOS is a stylized spelling of "Erin", alluding to the project's Irish roots.
aerynOS is a stylized spelling of "Erin", alluding to the project's Irish roots.
It is pronounced exactly the same as "Erin" - "AIR-in" OS.
It's also a play on "aer" and the phonetic "air" sound,
indicative of our desire to produce an open, trusted and high-performance operating system.
Expand All @@ -19,7 +19,7 @@ It's pronounced as "AIR-in" OS.

### What was Serpent OS?

Serpent OS is the former name of AerynOS. We [announced our rebrand](https://aerynos.com/blog/2025/02/14/evolve-this-os/) back in February 2025, which culminated with the inaugural release of AerynOS 2025.03 on March 25th, 2025. Per the announcement, our desire to rebrand was chiefly driven due to effectively being lumbered with a hastily chosen name, that poorly reflected the project's goals and aspirations.
Serpent OS is the former name of aerynOS. We [announced our rebrand](https://aerynos.com/blog/2025/02/14/evolve-this-os/) back in February 2025, which culminated with the inaugural release of aerynOS 2025.03 on March 25th, 2025. Per the announcement, our desire to rebrand was chiefly driven due to effectively being lumbered with a hastily chosen name, that poorly reflected the project's goals and aspirations.

The project itself remains the same, with the same goals and aspirations, but with a new name and a fresh coat of paint.

Expand All @@ -39,7 +39,7 @@ For now, log out and back in again and they will show up.

### How do I configure custom kernel command line parameters applied at each boot?

See the [blsforme repo readme](https://github.com/AerynOS/blsforme/?tab=readme-ov-file#filesystem-layout) for the expected format.
See the [blsforme repo readme](https://github.com/aerynOS/blsforme/?tab=readme-ov-file#filesystem-layout) for the expected format.

Typically, it is necessary to change the installed system state with `moss` for command-line snippets to take effect.

Expand All @@ -61,25 +61,25 @@ See above.

For now, we encourage users to use flatpaks for the applications we do not yet carry in our repository.

Currently, we are focusing on adding must-have packages for platform bring-up, for things that give us a development edge, or for things that help us showcase AerynOS capabilities.
Currently, we are focusing on adding must-have packages for platform bring-up, for things that give us a development edge, or for things that help us showcase aerynOS capabilities.

If the use-case for the package you are proposing is in line with the ethos above, you can make a package request [here](https://github.com/AerynOS/recipes/issues/new/choose)
If the use-case for the package you are proposing is in line with the ethos above, you can make a package request [here](https://github.com/aerynOS/recipes/issues/new/choose)

### Where can I learn how to package for AerynOS?
### Where can I learn how to package for aerynOS?

Consult the packaging documentation [here](/packaging/).

In addition, consult the AerynOS [recipes/ repository](https://github.com/AerynOS/recipes).
In addition, consult the aerynOS [recipes/ repository](https://github.com/aerynOS/recipes).

Finally, join the [AerynOS Zulip space](https://aerynos.zulipchat.com/join/fuqokhsomj5mzqj6akqaiqlr/) and make sure to join the #Onboarding channel in the General - Public space.
Finally, join the [aerynOS Zulip space](https://aerynos.zulipchat.com/join/fuqokhsomj5mzqj6akqaiqlr/) and make sure to join the #Onboarding channel in the General - Public space.

# Project Questions

### Which distribution is AerynOS derived from?
### Which distribution is aerynOS derived from?

AerynOS has been bootstrapped and built from scratch and is not based on any other distro.
aerynOS has been bootstrapped and built from scratch and is not based on any other distro.

This implies that AerynOS has its own:
This implies that aerynOS has its own:

- package manager (`moss`)
- package build tool (`boulder`)
Expand All @@ -88,21 +88,21 @@ This implies that AerynOS has its own:
- the builder-as-a-service middleware (`avalanche`)
- the package repository manager (`vessel`)

This also implies that AerynOS does NOT build upon or use either:
This also implies that aerynOS does NOT build upon or use either:

- `.rpm` related tooling from Red Hat
- `.deb` related tooling from the Debian Project
- Arch-related tooling

### When will AerynOS be considered stable?
### When will aerynOS be considered stable?

AerynOS is taking on the ambitious task of creating a distribution from scratch, whilst building its own tooling and solutions for this.
aerynOS is taking on the ambitious task of creating a distribution from scratch, whilst building its own tooling and solutions for this.

As such, there is no official ETA.

Now that the project has hit alpha status, you will see frequent updates and progress reports.

### What is AerynOS' position on the use of LLMs
### What is aerynOS' position on the use of LLMs

Contributions must not include content generated by large language models or other probabilistic tools like ChatGPT, Claude, and Copilot.

Expand All @@ -117,6 +117,6 @@ This ban of LLM-generated content applies to all parts of the projects, includin

#### Project-related use of LLMs

We heavily discourage the use of LLM chat bots as a replacement for reading AerynOS's documentation.
We heavily discourage the use of LLM chat bots as a replacement for reading aerynOS's documentation.

Support requests referencing misleading or false LLM output relating to the project may be ignored, since it is a waste of time for us to "debug" where things went wrong based on this output before human support was sought. Once you're ready to submit your code, create a pull request, and one of our maintainers will review it.
4 changes: 2 additions & 2 deletions src/content/docs/FAQ/index.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: FAQ
lastUpdated: 2025-03-28T05:28:00Z
description: Frequently Asked Questions about AerynOS
description: Frequently Asked Questions about aerynOS
license: "CC-BY-SA-4.0"
copyright: "Copyright © 2025 aerynOS Developers"
---
import DirectoryList from '@components/DirectoryList.astro';

Our FAQ section provides answers to frequently asked questions about AerynOS. If you have any questions that are not answered here, please feel free to reach out to us via [Zulip](https://aerynos.zulipchat.com).
Our FAQ section provides answers to frequently asked questions about aerynOS. If you have any questions that are not answered here, please feel free to reach out to us via [Zulip](https://aerynos.zulipchat.com).

The FAQ section, by it's nature, is a work in progress and subject to change.

Expand Down
26 changes: 13 additions & 13 deletions src/content/docs/FAQ/installation.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Installation FAQ
lastUpdated: 2026-01-15T12:25:00Z
description: Installation FAQ for AerynOS
description: Installation FAQ for aerynOS
license: "CC-BY-SA-4.0"
copyright: "Copyright © 2025 aerynOS Developers"
---
Expand All @@ -10,9 +10,9 @@ import { Aside } from "@astrojs/starlight/components";

# Installation Questions

### Which CPUs does AerynOS support?
### Which CPUs does aerynOS support?

AerynOS is currently only compiled for the x86-64-v2 target architecture, which means that it will run on CPUs supporting x86-64-v2 or greater psABI feature levels.
aerynOS is currently only compiled for the x86-64-v2 target architecture, which means that it will run on CPUs supporting x86-64-v2 or greater psABI feature levels.

Checking the currently supported x86-64 psABI feature level of a system can be done by typing the following command in a terminal as a normal user:

Expand All @@ -29,34 +29,34 @@ On an x86-64-v2 based system, you will see the following output:
```

<Aside type="note">
If the x86-64-v3 and x86-64-v4 psABI feature levels were supported, they would also show `(supported, searched)` next to them. AerynOS will still work on these systems.
If the x86-64-v3 and x86-64-v4 psABI feature levels were supported, they would also show `(supported, searched)` next to them. aerynOS will still work on these systems.
</Aside>

### Does AerynOS offer NVIDIA GPU support?
### Does aerynOS offer NVIDIA GPU support?

Due to the way NVIDIA distributes its drivers, maintaining them in a distro is labor-intensive and frustrating when they do not work as advertised.

Given AerynOS is in the Alpha development stage, only limited, best effort NVIDIA enablement related to cards supported by the so-called nvidia-open-gpu-kernel-modules is currently offered.
Given aerynOS is in the Alpha development stage, only limited, best effort NVIDIA enablement related to cards supported by the so-called nvidia-open-gpu-kernel-modules is currently offered.

You can check the status of NVIDIA support in [AerynOS/recipes#435](https://github.com/AerynOS/recipes/issues/435)
You can check the status of NVIDIA support in [aerynOS/recipes#435](https://github.com/aerynOS/recipes/issues/435)

### Does AerynOS support being installed alongside another OS?
### Does aerynOS support being installed alongside another OS?

Officially? Not yet.

You can try, but there is no guarantee that AerynOS won't eat your other OS.
You can try, but there is no guarantee that aerynOS won't eat your other OS.

You have been warned.

### What is the recommended partition layout for AerynOS?
### What is the recommended partition layout for aerynOS?

In practice, we recommend that you install AerynOS to a separate drive with:
In practice, we recommend that you install aerynOS to a separate drive with:

- A >=256MB ESP FAT32 partition (type 1 in fdisk).
- This must be manually formatted for the installer to recognize it.
- A 4GB XBOOTLDR FAT32 partition (type 142 in fdisk, bls_boot in gparted).
- This must be manually formatted for the installer to recognize it.
- This partition is large, because it is where the AerynOS kernel+initramfs and (in the future) rescue image files will be saved.
- This partition is large, because it is where the aerynOS kernel+initramfs and (in the future) rescue image files will be saved.
- A >20 GB system xfs partition
- This must be manually formatted for the installer to recognize it.
- The larger the xfs system (/ or root) partition is, the more OS /usr directory rollback states it can support in /.moss/.
Expand Down Expand Up @@ -86,4 +86,4 @@ nvme1n1
ermo@virgil:~
```

NB: Remember, there is nothing stopping you from creating an extra partition, formatting it with a filesystem of your choice, and then configuring /etc/fstab to mount it as /home after AerynOS has been installed. You can do this if you want to use a different filesystem than xfs for your /home folders for whatever reason.
NB: Remember, there is nothing stopping you from creating an extra partition, formatting it with a filesystem of your choice, and then configuring /etc/fstab to mount it as /home after aerynOS has been installed. You can do this if you want to use a different filesystem than xfs for your /home folders for whatever reason.
Loading