nerf/READMETypo #8

Merged
nerf merged 5 commits from nerf/nixConfig:nerf/READMETypo into main 2023-10-05 21:31:47 +00:00
Owner

I cherry picked the documentation from the nyarlathotep branch and did some minor polishing.
Please read it and tell me what I should improve.

I cherry picked the documentation from the nyarlathotep branch and did some minor polishing. Please read it and tell me what I should improve.
nerf added the
Kind/Documentation
label 2023-09-26 12:23:41 +00:00
nerf added 2 commits 2023-09-26 12:23:42 +00:00
nerf self-assigned this 2023-09-26 12:24:13 +00:00
Owner

Many interesting things in here. I miss the bit how to bootstrap a Nix VM from Dom0.

Many interesting things in here. I miss the bit how to bootstrap a Nix VM from Dom0.
Author
Owner

That is changing right now, (as I change disklayout of things) will add that as soon as I got the process itself going

That is changing right now, (as I change disklayout of things) will add that as soon as I got the process itself going
nerf added 1 commit 2023-09-30 15:04:48 +00:00
Author
Owner

Added the requested information, please review

Added the requested information, please review
Gonne requested review from Gonne 2023-10-02 05:27:16 +00:00
Gonne approved these changes 2023-10-02 05:48:44 +00:00
Dismissed
Gonne left a comment
Owner

So far, I have not tried to actually use this documentation to build a machine, but it looks reasonable.

So far, I have not tried to actually use this documentation to build a machine, but it looks reasonable.
README.md Outdated
@ -4,0 +26,4 @@
└───packages
└───x86_64-linux
```
we can see there is an output called `nixosConfigurations.nyarlathotep`. Which contains the configuration of the machine
Owner

Change . Which to which

Change `. Which` to ` which`
Gonne marked this conversation as resolved
README.md Outdated
@ -10,0 +57,4 @@
```
$ nix copy -s --to <however you setup your ssh stuff> .#nixosConfigurations.<name>.config.system.build.toplevel
```
This will evaluate the flake again to get the store path of the given derivation. If we want to avoid this
Owner

Insert Comma after if-clause (Grammarly-Explanation).

Insert Comma after `if`-clause ([Grammarly-Explanation](https://www.grammarly.com/blog/conditional-sentences/)).
Gonne marked this conversation as resolved
README.md Outdated
@ -10,0 +60,4 @@
This will evaluate the flake again to get the store path of the given derivation. If we want to avoid this
we might supply the corresponding store path directly.
The `-s` is important it makes the target machine substitute all derivations it can (by default from chache.nixos.org).
Owner

Change important to important:.

Change `important` to `important:`.
Gonne marked this conversation as resolved
README.md Outdated
@ -10,0 +79,4 @@
is exactly the same it was on your machine.
If you have a `nixos-rebuild` available on your system it can automatize these things with the `--flake` and
Owner

Comma after if-clause.

Comma after `if`-clause.
Gonne marked this conversation as resolved
README.md Outdated
@ -12,2 +86,2 @@
clone this repo to `/etc/nixos/` and `nixos-rebuild` that will select
the appropriate machine based on hostname
clone this repository to `/etc/nixos/` and `nixos-rebuild boot` or `nixos-rebuild switch` that will select
Owner

Clone capitalised

`Clone` capitalised
Gonne marked this conversation as resolved
README.md Outdated
@ -14,0 +87,4 @@
clone this repository to `/etc/nixos/` and `nixos-rebuild boot` or `nixos-rebuild switch` that will select
the appropriate machine based on hostname.
If the hostname is not correct, or you don't want to clone this flake you can also use the `--flake` parameter.
Owner

Comma after if-clause

Comma after `if`-clause
Gonne marked this conversation as resolved
README.md Outdated
@ -15,2 +141,3 @@
### sops
## How to write a new machine configuration
At best you take a first look at already existing configurations. But here are a few guidelines.
Owner

At best, you first take a look at

`At best, you first take a look at`
Owner

I not only inserted the comma but also reordered the words. Any comments on that?

I not only inserted the comma but also reordered the words. Any comments on that?
nerf marked this conversation as resolved
README.md Outdated
@ -17,0 +163,4 @@
system.stateVersion = "<state version at time of install>";
}
```
the import of `../../roles` loads all the nice default setup that all these machines have in common. There the
Owner

The

`The`
Gonne marked this conversation as resolved
README.md Outdated
@ -17,0 +171,4 @@
is already taken care of by `../../roles`.
As of moment of writing `network.nix` should contain ip, nameserver and default gateway setup. As parts of
this is constant across all systems this will undergo refactor soon.
Owner

and will

`and will`
Gonne marked this conversation as resolved
README.md Outdated
@ -17,0 +173,4 @@
As of moment of writing `network.nix` should contain ip, nameserver and default gateway setup. As parts of
this is constant across all systems this will undergo refactor soon.
I would recommend to split your configuration into small files you import. If this is something machine specific (like
Owner

Comma after if-clause

Comma after `if`-clause
Gonne marked this conversation as resolved
README.md Outdated
@ -17,0 +174,4 @@
this is constant across all systems this will undergo refactor soon.
I would recommend to split your configuration into small files you import. If this is something machine specific (like
tied to your ip address hostname) put it into the machine directory. If it is not put it into `/nixos/roles/` if it
Owner

Comma after if-clause

Comma after `if`-clause
Gonne marked this conversation as resolved
README.md Outdated
@ -17,0 +198,4 @@
network configuration. And service configuration that are too closely interwoven with the rest of that machine (for example
mailserver configuration depends heavily on network settings). It also
contains the root configuration for that machine called `configuration.nix`. This file usually only includes other modules.
These `configuration.nix` files are almost usual nix configurations. The only difference is, that they take as an extra argument
Owner

No comma before that

No comma before `that`
Gonne marked this conversation as resolved
README.md Outdated
@ -17,0 +199,4 @@
mailserver configuration depends heavily on network settings). It also
contains the root configuration for that machine called `configuration.nix`. This file usually only includes other modules.
These `configuration.nix` files are almost usual nix configurations. The only difference is, that they take as an extra argument
the flake inputs. This allows them to load modules from these flakes. For example nyarlathotep loads the simple-nixos-mailserver
Owner

For example,

`For example,`
Gonne marked this conversation as resolved
Author
Owner

So far, I have not tried to actually use this documentation to build a machine, but it looks reasonable.

That works (that way I set up nyarla). But right now only I have access to the nixos machine (this is true for all machines
as long as people don't get in pull requests for admins.nix) and its setup is messy.
But there someone should dump some work into. (Isn't probably too much, it is just copy nyarla, disable the mail stuff. (very easy)
change the hardware and network config, and find out which packages are needed for the install and filesystem utils.

> So far, I have not tried to actually use this documentation to build a machine, but it looks reasonable. That works (that way I set up nyarla). But right now only I have access to the nixos machine (this is true for all machines as long as people don't get in pull requests for `admins.nix`) and its setup is messy. But there someone should dump some work into. (Isn't probably too much, it is just copy nyarla, disable the mail stuff. (very easy) change the hardware and network config, and find out which packages are needed for the install and filesystem utils.
nerf added 1 commit 2023-10-02 09:48:48 +00:00
nerf dismissed Gonne's review 2023-10-02 09:48:48 +00:00
Reason:

New commits pushed, approval review dismissed automatically according to repository settings

Gonne requested changes 2023-10-03 20:36:06 +00:00
Gonne left a comment
Owner

Found two more commas.

Found two more commas.
README.md Outdated
@ -4,0 +6,4 @@
most appropriate depends on the context and scenario. So first there will be a general
explanation how this works and afterwards we will talk about some scenarios.
If you run `nix flake show` you should get an output similar to this
Owner

Comma after if-clause

Comma after `if`-clause
nerf marked this conversation as resolved
README.md Outdated
@ -7,0 +43,4 @@
And so on...
#### Build
If you have this repository local in your current directory you can just run
Owner

Comma after if-clause

Comma after `if`-clause
nerf marked this conversation as resolved
README.md Outdated
@ -14,0 +134,4 @@
nixos-install --flake 'git+https://gitea.mathebau.de/Fachschaft/nixConfig?ref=<branchname>#<name>'
```
where `<branchname>` is the branch you install from and `<name>` is the name of the configuration you build.
If the build system is already in the nix store this will start the installation, else it will first attempt to build
Owner

Comma after if-clause

Comma after `if`-clause
nerf marked this conversation as resolved
nerf added 1 commit 2023-10-04 21:38:05 +00:00
nerf requested review from Gonne 2023-10-04 21:39:02 +00:00
Author
Owner

sry I can't type you just don't read the commit message

sry I can't type you just don't read the commit message
nerf force-pushed nerf/READMETypo from 5b74127fce to 96611e47c2 2023-10-04 21:43:21 +00:00 Compare
Author
Owner

fixed it

fixed it
Gonne approved these changes 2023-10-05 07:48:47 +00:00
nerf force-pushed nerf/READMETypo from 96611e47c2 to 44036f804a 2023-10-05 21:30:37 +00:00 Compare
nerf merged commit 4515516ba8 into main 2023-10-05 21:31:47 +00:00
nerf deleted branch nerf/READMETypo 2023-10-05 21:31:47 +00:00
nerf referenced this pull request from a commit 2023-10-05 21:31:49 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Fachschaft/nixConfig#8
No description provided.