Skip to content

Commit

Permalink
Updated the wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
rasmus-kirk committed Mar 3, 2024
1 parent 6c4d047 commit adbe93d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 22 deletions.
26 changes: 12 additions & 14 deletions docs/wiki/ddns/njalla/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,30 @@ Go to your domain on njalla:

![Njalla Domain](/docs/wiki/ddns/njalla/domain.png)

Then press "Add record" and select "Dynamic" and write your subdomain in
the input box. It should now be added to your records. Click on the record,
Then press "Add record", select "Dynamic" and write your subdomain in the
input box. It should now be added to your records. Click on the record,
you should now see something like the following:

![Njalla Record](/docs/wiki/ddns/njalla/record.png)

With this, then your JSON file should contain:
Given this, your JSON file should contain the following:

```json
{
"jellyfin.example.com": "48esqclnvqGiCZPbd"
}
```

Add this as a secret file to your secrets (See [this page](/wiki/secrets)
for secrets management). This could be done, for example, in the following way:
Add the above as a secret file to your secrets (See [this page](/wiki/secrets)
for secrets management). As an example, here is one way of accomplishing it:

- Writing the specified JSON to `/data/.secret/njalla/keys-file.json`
- Setting the owner as root:
- Write the specified JSON to `/data/.secret/njalla/keys-file.json`
- Set the owner as root:
- `sudo chown root:root /data/.secret/njalla/keys-file.json`
- Setting the permissions to 700 (read, write, execute for file owner, root):
- Set the permissions to 700 (read, write, execute for file owner, root):
- `sudo chmod 700 /data/.secret/njalla/keys-file.json`

And finally adding it to your nix configuration:
And finally add the secret file to your nix configuration:

```nix
nixarr.ddns.njalla = {
Expand Down Expand Up @@ -61,8 +61,6 @@ Then run the following to get your public IP address:
curl https://ipv4.icanhazip.com/
```

And if you check your njalla domain page, you should see your public IP on
your Dynamic DNS record!

And after waiting a little you should be able to connect to your ip, using
the set domain.
And if you check your njalla domain page, you should see your public IP
on your Dynamic DNS record! After waiting a little you should be able to
connect to your ip, using the set domain.
5 changes: 4 additions & 1 deletion docs/wiki/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
title: Welcome to the Nixarr Wiki!
---

This is a list of existing articles:
This is an index of existing articles:

- **[Recommended Secrets Management](/wiki/secrets)**
- **DDNS**
- **[Njalla](/wiki/ddns/njalla)**

For learning how to setup the "*Arrs", once running, refer to the [servarr
wiki](https://wiki.servarr.com/)
16 changes: 9 additions & 7 deletions docs/wiki/secrets/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,18 @@ And set the accompanying Nixarr option:
};
```

**Note:** This is impure, meaning that since the file is not part of the
nix store, a nixos rollback will not restore a previous secret. This also
means you have to rebuild Nixos using the `--impure` flag set.
**Note:** This is "impure", meaning that since the file is not part of the nix
store, a nixos rollback will not restore a previous secret (not a big problem
if the secrets are not changed often). This also means you have to rebuild Nixos
using the `--impure` flag set.

## Agenix - A Path to Purity

The "right way" to do secret management is to have your secrets
encrypted in your configuration directory. This can be accomplished using
The "right way" to do secret management is to have your secrets encrypted in
your configuration directory. Doing it this way is "pure", and rollbacks
will once again function correctly. This can be accomplished using
[agenix](https://github.com/ryantm/agenix). I won't go into the details of how
to set it up since it's a more complex solution than the one above. However,
including the right way doing it should help you if you're a more advanced
user and want to do things the "right way".
if you're a more advanced user and want to do things the "right way", then
check out their documentation.

0 comments on commit adbe93d

Please sign in to comment.