Merge pull request 'docs: small fixes' (#2590) from Enzime/clan-core:push-ntnmoqslpuot into main

This commit is contained in:
clan-bot
2024-12-11 03:42:04 +00:00
6 changed files with 21 additions and 21 deletions

View File

@@ -180,7 +180,7 @@ extra_css:
extra:
social:
- icon: fontawesome/regular/comment
link: https://matrix.to/#/#clan:lassul.us
link: https://matrix.to/#/#clan:clan.lol
- icon: fontawesome/brands/gitlab
link: https://git.clan.lol/clan/clan-core
- icon: fontawesome/brands/github

View File

@@ -94,7 +94,7 @@ After writing the installer to the USB drive, use it to boot the target machine.
5. Select `NixOS` to boot into the clan installer
6. The installer will display an IP address and a root password, which you can use to connect via SSH.
6. The installer will display an IP address and a root password, which you can use to connect via SSH.
Alternatively you can also use the displayed QR code.
7. Set your keyboard language (i.e. `de` for German keyboards, default is English). Important for writing passwords correctly.
@@ -139,7 +139,7 @@ After writing the installer to the USB drive, use it to boot the target machine.
---
# Whats next?
# What's next?
- Deploy a clan machine-configuration on your prepared machine

View File

@@ -202,7 +202,7 @@ For renaming jon to your own machine name, you can use the following command:
git mv ./machines/jon ./machines/newname
```
If you only want to setup a single machine at this point, you can delete `sara` from flake.nix as well as from the machines directory:
If you only want to setup a single machine at this point, you can delete `sara` from `flake.nix` as well as from the machines directory:
```
git rm ./machines/sara
@@ -210,8 +210,8 @@ git rm ./machines/sara
---
## Whats next?
## What's next?
- [Secrets & Facts](secrets.md): Setting up secrets with nix-sops
- [Secrets & Facts](secrets.md): Setting up secrets with sops-nix
---

View File

@@ -4,7 +4,7 @@ Our installer image simplifies the process of performing remote installations.
Follow our step-by-step guide to create and transfer this image onto a bootable USB drive.
!!! info
!!! info
If you already have a NixOS machine you can ssh into (in the cloud for example) you can skip this chapter and go directly to [Configure Machines](configure.md).
### Step 0. Prerequisites
@@ -54,7 +54,7 @@ sudo umount /dev/sdb1
flash-installer
```
!!! Note
Replace `$HOME/.ssh/id_ed25519.pub` with a path to your SSH public key.
Replace `$HOME/.ssh/id_ed25519.pub` with a path to your SSH public key.
Replace `/dev/sd<X>` with the drive path you want to flash
!!! Danger "Specifying the wrong device can lead to unrecoverable data loss."
@@ -73,13 +73,13 @@ sudo umount /dev/sdb1
```
clan flash list keymaps
```
- **List Languages**:
You can get a list of all languages with the following command:
```
clan flash list languages
```
@@ -183,7 +183,7 @@ You're all set up
---
## Whats next?
## What's next?
- [Configure Machines](configure.md): Customize machine configuration

View File

@@ -85,7 +85,7 @@ This command helps ensure that your system configuration is correct and free fro
You can integrate this step into your [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration) workflow to ensure that only valid Nix configurations are merged into your codebase.
## Whats next?
## What's next?
- [Deployment](deploy.md): How to remotely deploy your machine
- Full [Secrets](../manual/secrets.md) guide If you want to know more about how to save and share passwords in your clan

View File

@@ -1,22 +1,22 @@
# Adding Machines
Clan has two general methods of adding machines
Clan has two general methods of adding machines:
- **Automatic**: Detects every folder in the `machines` folder.
- **Declarative**: Explicit declarations in nix.
- **Declarative**: Explicit declarations in Nix.
## Automatic register
## Automatic registration
Every machine of the form `machines/{machineName}` will be registered automatically.
Every folder `machines/{machineName}` will be registered automatically as a Clan machine.
!!! info "Automatically loaded files"
Some files are loaded by a clan machine automatically. This decision was made for convinience and allows easier automation.
The following files are loaded automatically for each Clan machine:
- [x] ``machines/{machineName}/configuration.nix`
- [x] ``machines/{machineName}/hardware-configuration.nix`
- [x] ``machines/{machineName}/facter.json` Automatically configured, for further information see [nixos-facter](https://clan.lol/blog/nixos-facter/)
- [x] ``machines/{machineName}/disko.nix` Automatically loaded, for further information see the [disko docs](https://github.com/nix-community/disko/blob/master/docs/quickstart.md).
- [x] `machines/{machineName}/configuration.nix`
- [x] `machines/{machineName}/hardware-configuration.nix`
- [x] `machines/{machineName}/facter.json` Automatically configured, for further information see [nixos-facter](https://clan.lol/blog/nixos-facter/)
- [x] `machines/{machineName}/disko.nix` Automatically loaded, for further information see the [disko docs](https://github.com/nix-community/disko/blob/master/docs/quickstart.md).
## Manual declaration