From 25e08f5e2dd38f1a0285a8fd1e610c6f290837a0 Mon Sep 17 00:00:00 2001
From: tdpeuter <tibo.depeuter@gmail.com>
Date: Mon, 11 Sep 2023 13:18:22 +0200
Subject: [PATCH] [SSH] Add documentation

---
 nixos/modules/utils/ssh/README.md | 41 +++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 nixos/modules/utils/ssh/README.md

diff --git a/nixos/modules/utils/ssh/README.md b/nixos/modules/utils/ssh/README.md
new file mode 100644
index 0000000..8d7b9d8
--- /dev/null
+++ b/nixos/modules/utils/ssh/README.md
@@ -0,0 +1,41 @@
+# Adding SSH keys
+
+To incorporate SSH keys, for instance, to enable authentication with a Git server, follow these steps:
+
+Step 0: If necessary, generate a keypair, for example using the command:
+
+```bash
+ssh-keygen -t ed25519
+```
+
+Please note that setting a password for the keypair is not yet tested.
+
+Step 1: Create a new file named `yourservice.yaml` within the [secrets](../../../secrets/) directory by executing the following command:
+
+```bash
+sops secrets/yourservice.yaml
+```
+
+Within this file, create a value that contains your private key. For example:
+
+```yaml
+yourservice:
+    ssh: |
+        -----BEGIN OPENSSH PRIVATE KEY-----
+        <...>
+        -----END OPENSSH PRIVATE KEY-----
+```
+
+Step 2: Reference this value in [your sops configuration](../../utils/sops/default.nix) as follows:
+
+```
+sops.secrets."yourservice/ssh".format = "yaml";
+sops.secrets."yourservice/sss".sopsFile = secrets/youservice.yaml;
+```
+
+Step 3: Finally, add the SSH key to your SSH configuration so that it is used correctly when connecting to your host. Add the following lines to your SSH configuraton file:
+
+```
+Host yourservice
+    IdentityFile /run/secrets/yourservice/ssh
+```