Added documentation for the numbus-server

2026-03-18 13:26:13 +01:00
parent d09e261b14
commit b156bf443e
20 changed files with 581 additions and 161 deletions
@@ -0,0 +1,31 @@
+# Requirements
+
+### To deploy
+
+To deploy a numbus-backup-server, you will need :
+
+* A **live NixOS** bootable USB disk.
+
+You will make the **target** machine **boot** into the NixOS live environment using this **USB stick**. Download the [NixOS iso](https://github.com/nix-community/nixos-images/releases/download/nixos-unstable/nixos-installer-x86_64-linux.iso) image.
+
+*On Linux* : Flash it using [Impression (flatpak)](https://flathub.org/en/apps/io.gitlab.adhami3310.Impression) or [BalenaEtcher (AppImage)](https://etcher.balena.io/#download-etcher).
+
+*On MacOS* : Flash it using [BalenaEtcher](https://etcher.balena.io/#download-etcher).
+
+*On Windows* : Flash it using [Rufus](https://rufus.ie/en/#download) or [BalenaEtcher](https://etcher.balena.io/#download-etcher).
+
+* **Source** Machine:
+
+Can be any machine with **Nix installed**, e.g. a **NixOS** machine.
+
+* **Target** Machine:
+
+Can be **any computer** (desktop, SFF, tiny/mini/micro, even a laptop). It could be a dedicated server that you bought or just some computer that you decided to repurpose into a backup server.
+
+* **Network connection** between the source and the target machine.
+
+---
+
+### Next step
+
+[Configuration](./configuration/index.md)