Moraine-dokumentation

Installation

Moraine levereras med en kommandoradsklient (moraine) och en GTK-skrivbordsapp (moraine-gui, Linux). Den här guiden fokuserar på CLI:t.

thern.io CDN är värd för GPG-signerade APT-, DNF- och pacman-förråd, så installationer uppdateras automatiskt; de exakta enradarna för att lägga till förrådet (GPG-nyckel + källrad) finns på nedladdningssidan. Varje bygge finns även på GitHub Releases. Vid körning krävs rsync + ssh för SSH-backenden; rclone för moln-/FTP-backendarna.

Snabbstart

Fyra steg från ingenting till en fungerande snapshot:

# 1. Skriv en startkonfiguration (moraine.toml, endast ägaren)
$ moraine init

# 2. Redigera den — ange host, user, dest och dina källor
$ $EDITOR moraine.toml

# 3. Se exakt vad som skulle överföras, utan att röra något
$ moraine run --dry-run

# 4. Ta den första snapshoten
$ moraine run

Varje körning skapar <dest>/<name>/<timestamp>/ på målet och uppdaterar en latest-pekare. Oförändrade filer hårdlänkas mot föregående snapshot, så historiken kostar nästan ingenting.

Konfigurationsfilen

Konfigurationen är TOML: ett [[target]]-block per destination, vart och ett med en valfri [target.retention]. Här är ett kommenterat SSH-mål:

[[target]]
name    = "nas"          # mapp på målet & namn för --target
host    = "192.168.1.50" # IP eller värdnamn
user    = "backup"       # SSH-användare
port    = 22             # valfritt (standard 22)
key     = "~/.ssh/id_ed25519"  # valfritt; utelämna för att använda ssh-agent
dest    = "/volume1/backups"   # snapshots hamnar under <dest>/<name>/
sources = ["/home/me/documents", "/home/me/pictures"]
exclude = ["*.tmp", "node_modules", ".cache"]  # valfritt
# strict_host_key = true   # kräv att värdnyckeln redan finns i known_hosts
# vpn = "home-vpn"         # NetworkManager-anslutning att starta för körningen

[target.retention]       # valfritt — utelämna för att behålla allt
keep_last    = 7          # behåll de 7 senaste
keep_daily   = 14         # + nyaste per dag, 14 dagar
keep_weekly  = 8
keep_monthly = 12

Kommandoreferens

Alla kommandon tar den globala flaggan -c/--config <file>. Utan --target verkar kommandona på alla mål.

$ moraine verify -t nas          # testa anslutning + källor + dest
$ moraine run -t nas             # snapshot av ett mål
$ moraine run --dry-run          # förhandsgranska alla mål
$ moraine list -t nas            # visa tidsstämplar
$ moraine prune -t nas --dry-run # visa vad gallringen skulle radera

Ad-hoc-backuper (utan konfigurationsfil)

moraine run kan definiera ett helt mål med enbart flaggor, vilket är praktiskt för engångsjobb och skript — inget skrivs till moraine.toml:

$ moraine run --host nas --user me --key ~/.ssh/id \
      --dest /backups --source ~/docs --source ~/pictures

Det fungerar för alla backends (--backend ssh|rclone|ftp) och tar upprepade --source/--exclude, plus --port, --name (snapshot-mappen under --dest, standard: värdnamnet), --bwlimit (t.ex. 2M) och --strict-host-key.

Kryptera destinationen

För rclone- och FTP-backendarna krypterar --crypt-password destinationen i vila (rclones crypt), med ett valfritt --crypt-salt. Användbart när lagringen ligger någonstans du inte kontrollerar.

$ MORAINE_PASSWORD=… moraine run --host ftp.example.com --backend ftp \
      --user me --dest backups --source ~/docs

Så fungerar snapshots

Moraine använder rsyncs --link-dest. Varje körning skriver ett träd som ser komplett ut, men filer som inte ändrats blir hårdlänkar till föregående snapshot istället för nya kopior:

/volume1/backups/nas/
  2026-07-01T02-00-00/     # första körningen — full kopia
  2026-07-02T02-00-00/     # oförändrade filer är hårdlänkar → ~inget extra diskutrymme
  latest -> 2026-07-02T02-00-00

Eftersom varje snapshot är ett vanligt katalogträd kan du bläddra i den eller kopiera från den med helt vanliga verktyg — inget särskilt format, ingen uppackning. Att radera en snapshot frigör bara de block som inget annat länkar till.

En avbruten körning blir aldrig en snapshot

En snapshot byggs i ett dolt arbetsområde och görs synlig först när varenda fil har överförts. SSH-backenden skriver till .incomplete-<timestamp>/ och byter namn på katalogen atomärt när körningen lyckats; rclone-/FTP-backendarna skapar först en markör <timestamp>.incomplete och raderar den sist.

list, check, återställning och gallring ignorerar alla ofärdiga snapshots. En kraschad eller avbruten körning kan därför inte bli ”den senaste snapshoten”, kan inte återställas av misstag och kan inte lura gallringen att radera din senaste kompletta backup. Rester städas bort automatiskt — vid nästa lyckade backup (SSH), eller vid nästa lyckade backup eller gallring (rclone/FTP).

Backends

SSH / rsync (standard)

Standardvalet. Moraine kör rsync över ssh till user@host. Autentiseringsalternativ, enklast först:

• ssh-agent — utelämna key; nyckeln som är laddad i din agent används.
• Nyckelfil — sätt key = "~/.ssh/id_ed25519".
• Lösenfras / lösenord — sätt password; det matas till ssh via SSH_ASKPASS, aldrig på kommandoraden.

Fjärrsidan behöver ha rsync installerat. Vid den första anslutningen accepteras en okänd värdnyckel och fästs (sätt strict_host_key = true för att istället kräva den redan från början).

rclone & FTP

Sätt backend = "rclone" och ange namnet på en rclone-remote i host (kör rclone config först). Fungerar med SFTP, SMB, WebDAV, S3, Drive, B2 med mera — inget rsync/ssh behövs, vilket gör det till det portabla valet på Windows.

[[target]]
name    = "cloud"
backend = "rclone"
host    = "myremote"   # en rclone-remote (tomt = en lokal sökväg)
dest    = "backups"
sources = ["/home/me/documents"]

För ren FTP utan rclone-konfiguration, använd backend = "ftp" med host/user/password/port. Inloggningsuppgifterna skickas till rclone via miljön, inte via processlistan.

Gallring & rensning

Gallringen följer grandfather-father-son (GFS). Varje nivå är ett antal; den nyaste snapshoten behålls alltid, och poster som inte går att tolka eller ser udda ut behålls också (raderas aldrig av misstag).

De behållna mängderna slås ihop till en union. Kör moraine prune -t nas --dry-run för att se exakt vad en policy skulle radera, innan den gör det.

Schemaläggning

Automatisera moraine run med cron på Linux och macOS. Eftersom en lyckad körning gallrar automatiskt räcker en rad för båda delarna:

# crontab -e — nattlig backup av alla mål kl. 02:00
0 2 * * *  moraine -c /home/me/moraine.toml run >/dev/null 2>&1

# eller ett enskilt mål, varje timme
0 * * * *  moraine -c /home/me/moraine.toml run -t nas >/dev/null 2>&1

Använd absoluta sökvägar till både moraine och konfigurationsfilen (cron har en minimal miljö). Skrivbordsappens flik Schedule skriver de här raderna åt dig.

Windows

På Windows installerar samma flik Schedule istället jobb i Task Scheduler: varje schema blir en uppgift under mappen \Moraine\, driven av ett litet .cmd-omslag i %APPDATA%\Moraine\tasks\. Från CLI:t pekar du en åtgärd i Task Scheduler mot moraine.exe med samma argument -c och run.

Återställa filer

En snapshot är bara ett katalogträd, så att återställa från CLI:t är en helt vanlig kopiering från målet:

# hela snapshoten
$ rsync -aAX backup@192.168.1.50:/volume1/backups/nas/latest/ ./restore/

# en enskild fil eller mapp från en viss snapshot
$ rsync -aAX backup@192.168.1.50:/volume1/backups/nas/2026-07-01T02-00-00/documents/report.odt  ./

För en återställning med peka-och-klicka — bläddra i filträdet, kryssa i filer, återställ till den ursprungliga platsen eller någon annanstans — använd skrivbordsappens flik Restore (se nedan). Återställning raderar aldrig något på destinationen; den lägger bara till och skriver över.

Återställningar hoppar över symlänkar som pekar utanför det återställda trädet (rsync --safe-links), eftersom fillistan kommer från destinationen och ett komprometterat mål annars skulle kunna placera ut en länk som x → ~/.ssh och skriva genom den. Om en legitim absolut symlänk hoppas över säger rsync till — återskapa den för hand.

VPN per mål

Om ett mål bara går att nå över VPN, sätt vpn till namnet på en NetworkManager-anslutning. Moraine startar den före körningen och stänger den efteråt (och låter den vara uppe om du redan hade anslutit den själv):

vpn = "home-vpn"   # nmcli connection up/down runt körningen

Lista dina anslutningar med nmcli connection show. Detta gäller även schemalagda CLI-körningar.

Säkerhet

• Hemligheter på disk är åtkomliga endast för ägaren. moraine.toml och körningsloggen skrivs med rättigheterna 0600. Behåll det så om du lagrar ett password.
• Hemligheter från konfigurationen når aldrig kommandoraden. SSH-autentisering går via SSH_ASKPASS; FTP-uppgifter går via rclones miljövariabler — inget från moraine.toml dyker upp i ps.
• Ad-hoc-flaggor är undantaget — använd miljön. En lösenfras som skickas med --password eller --crypt-password är synlig för andra lokala användare i ps och /proc/<pid>/cmdline. Föredra MORAINE_PASSWORD och MORAINE_CRYPT_PASSWORD.
• Värdnycklar. Förtroende vid första anslutning som standard; strict_host_key = true kräver att nyckeln finns i known_hosts redan från början. Rekommenderas för alla mål som loggar in med lösenord — förtroende vid första anslutning skulle lämna över lösenordet till den som svarar först.
• Återställningar följer inte symlänkar ut ur trädet. Fillistan vid återställning kommer från destinationen — sidan som Moraine betraktar som opålitlig — så återställningar använder rsync --safe-links. En komprometterad destination kan inte placera ut x → ~/.ssh och få en återställning att skriva genom den. Avvägningen: legitima absoluta symlänkar hoppas över (rsync rapporterar varje sådan).
• Nedladdningar verifieras med kontrollsumma. Varje release publicerar en SHA256SUMS som täcker alla filer, och skrivbordsappens uppdaterare kontrollerar det nedladdade installationsprogrammet mot den innan den erbjuder Open.
• Krypterad export av konfigurationen. I skrivbordsappen skriver ⚙ Settings → Export config en lösenordsskyddad kopia (gpg AES-256) att flytta mellan maskiner.

Felsökning

Kör moraine verify -t NAME för en snabb hälsokontroll av källor, anslutning och destination.

Skrivbordsapp (GUI)

GTK-appen (moraine-gui, Linux) använder samma motor och samma konfiguration som CLI:t — allt du ställer in i den ena dyker upp i den andra. Fem flikar:

• Quick Backup — välj ett mål, redigera anslutningen, Test connection, sedan Dry run eller Run backup med en progressindikator i realtid (mängd, hastighet, återstående tid). ⚙ Settings per mål: källor (väljarna File… / Folder…), uteslutningar, gallring, VPN, strikt värdnyckel.
• Schedule — bygg scheman (varje timme/dagligen/veckovis) och tryck Install för att lägga in dem i crontab.
• Restore — snapshotarna laddas automatiskt; välj en, bläddra i filträdet, kryssa i filer/mappar och återställ. Restore to: är förifyllt med den ursprungliga platsen och går att ändra.
• History — varje backup/återställning/gallring, lyckad eller misslyckad.
• Settings — krypterad export/import av konfigurationen, starta vid inloggning (startar minimerad till aktivitetsfältet) och appinformation.
• Help — hela funktionsuppsättningen förklarad inne i appen: backuper & snapshots, backendarna, alla avancerade målinställningar, schemaläggning, återställning och hur hemligheter hanteras. Kräver ingen internetuppkoppling.

← Tillbaka till startsidan   GitHub