Restic-back-ups maken naar Object Store

Gebruik de onderstaande stappen als je Restic op een Windows-systeem wilt gebruiken, bijvoorbeeld op een lokale computer of een Windows-instance in onze Public Cloud.

Stap 1

Verbind met je Windows-systeem. Gebruik je een Windows-instance, verbind dan via remote desktop. Open daarna PowerShell als administrator.

Stap 2

Installeer Restic met Winget. Winget is de package manager van Windows en installeert software vanuit de standaard package-bronnen van Microsoft.

winget install --id restic.restic --source winget --scope Machine

In dit commando:

• geeft --id restic.restic aan welk package wordt geïnstalleerd;
• geeft --source winget aan dat Winget de standaardbron gebruikt;
• zorgt --scope Machine ervoor dat Restic systeembreed beschikbaar is.

Stap 3

Zet de OpenStack-omgevingsvariabelen in je huidige PowerShell-sessie. Gebruik deze stap voor het initialiseren van je repository en het maken van je eerste test-back-up.

$env:OS_AUTH_URL="https://auth.teamblue.cloud/v3"
$env:OS_APPLICATION_CREDENTIAL_ID="JOUW_APPLICATION_CREDENTIAL_ID"
$env:OS_APPLICATION_CREDENTIAL_SECRET="JOUW_APPLICATION_CREDENTIAL_SECRET"

Deze variabelen zijn alleen actief in de huidige PowerShell-sessie. In de automatiseringsstappen hieronder zet je dezelfde waarden rechtstreeks in je script, zodat je geplande taak niet afhankelijk is van een PowerShell-profiel.

Stap 4

Initialiseer je Restic-repository in je container:

restic -r swift:example_container_name:/path init

In dit commando:

• geeft -r de locatie van de repository aan;
• staat swift:example_container_name:/path voor de containernaam en de optionele directory in je container;
• maakt init een nieuwe repository aan op die locatie.

Laat :/path weg als je de root van de container wilt gebruiken. Vervang example_container_name door de naam van je eigen container. Als de container nog niet bestaat, maakt Restic deze automatisch aan.

Restic vraagt nu om een repository-wachtwoord. Bewaar dit wachtwoord veilig buiten de back-upomgeving; zonder dit wachtwoord kun je de back-ups niet terugplaatsen.

Stap 5

Maak daarna een eerste test-back-up. In dit voorbeeld gebruiken we de map C:\Data:

restic -r swift:example_container_name:/path --verbose backup "C:\Data"

In dit commando:

• verwijst swift:example_container_name:/path naar dezelfde repository als in stap vier;
• vervang je C:\Data door het pad dat je wilt back-uppen;
• zorgt --verbose voor extra uitvoer, zodat je duidelijk ziet wat Restic doet.

Na het starten van de back-up voer je het repository-wachtwoord in. Gebruik --verbose vooral voor een eerste test of voor troubleshooting.

Stap 6

Maak een apart wachtwoordbestand aan voor geautomatiseerde back-ups. In dit voorbeeld slaan we het bestand op in C:\ProgramData\Restic.

New-Item -ItemType Directory -Path C:\ProgramData\Restic -Force
notepad C:\ProgramData\Restic\repository-password.txt

In het eerste commando zorgt -ItemType Directory ervoor dat een directory wordt aangemaakt. De optie -Force maakt de directory ook aan als een deel van het pad nog niet bestaat. Het tweede commando opent een tekstbestand in Notepad. Voeg alleen het repository-wachtwoord toe aan dit bestand en sla het bestand op.

Beperk daarna de toegang tot het wachtwoordbestand tot de lokale groep Administrators en het SYSTEM-account:

icacls "C:\ProgramData\Restic\repository-password.txt" /inheritance:r /grant:r "*S-1-5-32-544:(R,W)" "*S-1-5-18:(F)"

Met /inheritance:r verwijder je overgeërfde rechten. /grant:r vervangt bestaande expliciete rechten voor de opgegeven accounts.

Stap 7

Maak nu een PowerShell-script dat de back-up start. Maak eerst de directory C:\Scripts aan en open daarna het scriptbestand:

New-Item -ItemType Directory -Path C:\Scripts -Force
notepad C:\Scripts\restic-backup.ps1

Voeg de volgende inhoud toe:

$ErrorActionPreference = "Stop"

$env:OS_AUTH_URL = "https://auth.teamblue.cloud/v3"
$env:OS_APPLICATION_CREDENTIAL_ID = "JOUW_APPLICATION_CREDENTIAL_ID"
$env:OS_APPLICATION_CREDENTIAL_SECRET = "JOUW_APPLICATION_CREDENTIAL_SECRET"
$env:RESTIC_REPOSITORY = "swift:example_container_name:/path"
$env:RESTIC_PASSWORD_FILE = "C:\ProgramData\Restic\repository-password.txt"

restic backup "C:\Data"

Pas C:\Data aan naar de map die je wilt back-uppen. De variabele RESTIC_PASSWORD_FILE zorgt ervoor dat Restic het repository-wachtwoord uit het aparte wachtwoordbestand leest.

Beperk ook de toegang tot het script, omdat dit je application credential secret bevat:

icacls "C:\Scripts\restic-backup.ps1" /inheritance:r /grant:r "*S-1-5-32-544:(R,W)" "*S-1-5-18:(F)"

Stap 8

Plan het script in met de Taakplanner, zodat je back-ups automatisch worden uitgevoerd. Open de Taakplanner vanuit PowerShell:

taskschd.msc

Maak een nieuwe basistaak aan en gebruik de volgende instellingen:

• vul een naam en beschrijving in;
• geef aan wanneer en hoe vaak het script wordt uitgevoerd;
• geef aan vanaf welke datum het script wordt uitgevoerd;
• kies bij de actie voor het starten van een programma;
• vul bij Programma/script powershell.exe in;
• vul bij Argumenten toevoegen -ExecutionPolicy Bypass -File "C:\Scripts\restic-backup.ps1" in;
• vul bij Start in C:\Scripts in.

De optie -ExecutionPolicy Bypass zorgt ervoor dat PowerShell het script voor deze taak zonder onderbreking uitvoert. Voer de taak daarna één keer handmatig uit vanuit de Taakplanner, zodat je controleert of de back-up start en er een snapshot wordt aangemaakt.

Gebruik de onderstaande stappen als je Restic op macOS wilt gebruiken. Voor geautomatiseerde back-ups gebruiken we op macOS Keychain in combinatie met RESTIC_PASSWORD_COMMAND.

Stap 1

Open de Terminal-app op je macOS-systeem.

Stap 2

Installeer Restic met Homebrew. Homebrew is een package manager voor macOS.

brew install restic

Stap 3

Zet de OpenStack-omgevingsvariabelen in je huidige Terminal-sessie:

export OS_AUTH_URL=https://auth.teamblue.cloud/v3
export OS_APPLICATION_CREDENTIAL_ID=JOUW_APPLICATION_CREDENTIAL_ID
export OS_APPLICATION_CREDENTIAL_SECRET=JOUW_APPLICATION_CREDENTIAL_SECRET

Deze variabelen zijn alleen actief in de huidige Terminal-sessie. In de automatiseringsstappen hieronder zet je dezelfde waarden rechtstreeks in je script.

Stap 4

Initialiseer je Restic-repository:

restic -r swift:example_container_name:/path init

Vervang example_container_name door de naam van je container. Gebruik optioneel een pad, zoals :/backups/macos, als je de repository niet in de root van de container wilt plaatsen. Als de container nog niet bestaat, maakt Restic deze automatisch aan.

Restic vraagt nu om een repository-wachtwoord. Bewaar dit wachtwoord veilig buiten de back-upomgeving; zonder dit wachtwoord kun je de back-ups niet terugplaatsen.

Stap 5

Maak een eerste test-back-up. In dit voorbeeld gebruiken we een map in je home-directory:

restic -r swift:example_container_name:/path --verbose backup /Users/jouwgebruikersnaam/data

Vervang /Users/jouwgebruikersnaam/data door het pad dat je wilt back-uppen. Gebruik --verbose voor een eerste test of wanneer je extra uitvoer nodig hebt.

Stap 6

Sla het repository-wachtwoord op in Keychain, zodat Restic dit later via een commando kan ophalen:

security add-generic-password -a restic -s restic-swift-repo -w 'JOUW_REPOSITORY_WACHTWOORD' -U

In dit commando:

• staat -a voor de accountnaam in Keychain;
• staat -s voor de servicenaam;
• geeft -w het wachtwoord door;
• werkt -U een bestaand Keychain-item met dezelfde naam bij.

Stap 7

Maak nu een script dat de back-up start. Maak eerst een map voor je script aan en open daarna het scriptbestand:

mkdir -p ~/bin
nano ~/bin/restic-backup.sh

Voeg de volgende inhoud toe. De waarde van RESTIC_REPOSITORY moet gelijk zijn aan de repository die je in stap vier hebt geïnitialiseerd.

#!/bin/bash
set -e

export OS_AUTH_URL=https://auth.teamblue.cloud/v3
export OS_APPLICATION_CREDENTIAL_ID=JOUW_APPLICATION_CREDENTIAL_ID
export OS_APPLICATION_CREDENTIAL_SECRET=JOUW_APPLICATION_CREDENTIAL_SECRET
export RESTIC_REPOSITORY=swift:example_container_name:/path
export RESTIC_PASSWORD_COMMAND='security find-generic-password -a restic -s restic-swift-repo -w'

/opt/homebrew/bin/restic backup /Users/jouwgebruikersnaam/data

Gebruik je een Intel Mac, vervang dan /opt/homebrew/bin/restic in het script door /usr/local/bin/restic. Op Apple Silicon Macs is /opt/homebrew/bin/restic meestal het juiste pad.

Sla de wijzigingen op en sluit het bestand (ctrl + x > y > enter). Maak het script daarna uitvoerbaar:

chmod 700 ~/bin/restic-backup.sh

De optie set -e zorgt ervoor dat het script direct stopt bij een fout. De regel met RESTIC_PASSWORD_COMMAND laat Restic het repository-wachtwoord ophalen uit Keychain. Het commando dat je hier opgeeft, moet alleen het wachtwoord naar de standaarduitvoer schrijven.

Stap 8

Plan het script in met launchd. Launchd is het ingebouwde taakplanningssysteem van macOS.

Maak eerst de benodigde mappen aan als deze nog niet bestaan en open daarna een nieuwe LaunchAgent:

mkdir -p ~/Library/LaunchAgents
mkdir -p ~/Library/Logs
nano ~/Library/LaunchAgents/restic-backup.plist

Voeg de volgende inhoud toe en vervang jouwgebruikersnaam door je eigen gebruikersnaam:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>Label</key>
    <string>restic-backup</string>
    <key>ProgramArguments</key>
    <array>
        <string>/Users/jouwgebruikersnaam/bin/restic-backup.sh</string>
    </array>
    <key>StartCalendarInterval</key>
    <dict>
        <key>Hour</key>
        <integer>3</integer>
        <key>Minute</key>
        <integer>0</integer>
    </dict>
    <key>StandardOutPath</key>
    <string>/Users/jouwgebruikersnaam/Library/Logs/restic-backup.log</string>
    <key>StandardErrorPath</key>
    <string>/Users/jouwgebruikersnaam/Library/Logs/restic-backup-error.log</string>
</dict>
</plist>

In dit voorbeeld wordt dagelijks om 03:00 uur een back-up gemaakt. Pas de waarden binnen StartCalendarInterval aan als je een ander tijdstip wilt gebruiken. Je gebruikt hiervoor onder andere de volgende keys:

Sla de wijzigingen op en sluit het bestand (ctrl + x > y > enter). Laad daarna de LaunchAgent in:

launchctl bootstrap gui/$(id -u) ~/Library/LaunchAgents/restic-backup.plist

Het commando bootstrap laadt de LaunchAgent in de launchd-omgeving van de ingelogde gebruiker. Gebruik hiervoor hetzelfde account als waarmee je het wachtwoord in Keychain hebt opgeslagen.

Start de taak daarna één keer handmatig:

launchctl kickstart -k gui/$(id -u)/restic-backup

Controleer de uitvoer daarna in ~/Library/Logs/restic-backup.log en ~/Library/Logs/restic-backup-error.log. Controleer ook of er een nieuwe snapshot is aangemaakt.

Gebruik de onderstaande stappen als je Restic op Debian of Ubuntu wilt gebruiken. Voor geautomatiseerde back-ups gebruiken we een wachtwoordbestand via RESTIC_PASSWORD_FILE.

Stap 1

Verbind met je server via SSH of de VPS-console.

Stap 2

Update je apt repositories en installeer Restic:

sudo apt -y update && sudo apt -y install restic

De optie -y zorgt ervoor dat pakketinstallaties automatisch worden bevestigd.

Stap 3

Zet de OpenStack-omgevingsvariabelen in je huidige shell:

export OS_AUTH_URL=https://auth.teamblue.cloud/v3
export OS_APPLICATION_CREDENTIAL_ID=JOUW_APPLICATION_CREDENTIAL_ID
export OS_APPLICATION_CREDENTIAL_SECRET=JOUW_APPLICATION_CREDENTIAL_SECRET

Deze variabelen zijn alleen actief in de huidige shell. In de automatiseringsstappen hieronder zet je dezelfde waarden rechtstreeks in je script.

Stap 4

Initialiseer je Restic-repository:

restic -r swift:example_container_name:/path init

Vervang example_container_name door de naam van je container. Gebruik optioneel een pad, zoals :/backups/server1, als je de repository niet in de root van de container wilt plaatsen. Als de container nog niet bestaat, maakt Restic deze automatisch aan.

Restic vraagt nu om een repository-wachtwoord. Bewaar dit wachtwoord veilig buiten de back-upomgeving; zonder dit wachtwoord kun je de back-ups niet terugplaatsen.

Stap 5

Maak een eerste test-back-up. In dit voorbeeld gebruiken we de map /srv/data:

restic -r swift:example_container_name:/path --verbose backup /srv/data

Vervang /srv/data door het pad dat je wilt back-uppen, bijvoorbeeld /var/www of /home. Gebruik --verbose voor een eerste test of wanneer je extra uitvoer nodig hebt.

Stap 6

Maak een afgeschermd wachtwoordbestand aan voor geautomatiseerde back-ups:

sudo install -d -m 700 /etc/restic
sudo nano /etc/restic/repository-password

Voeg alleen het repository-wachtwoord toe aan dit bestand. Sla de wijzigingen op en sluit het bestand (ctrl + x > y > enter). Beperk daarna de rechten op het bestand:

sudo chmod 600 /etc/restic/repository-password

In het eerste commando maakt install -d de directory aan. De optie -m 700 zorgt ervoor dat alleen de eigenaar volledige rechten krijgt. Met chmod 600 maak je het wachtwoordbestand alleen lees- en schrijfbaar voor de eigenaar.

Stap 7

Maak nu een script dat de back-up start:

sudo nano /usr/local/bin/restic-backup.sh

Voeg de volgende inhoud toe:

#!/bin/bash
set -e

export OS_AUTH_URL=https://auth.teamblue.cloud/v3
export OS_APPLICATION_CREDENTIAL_ID=JOUW_APPLICATION_CREDENTIAL_ID
export OS_APPLICATION_CREDENTIAL_SECRET=JOUW_APPLICATION_CREDENTIAL_SECRET
export RESTIC_REPOSITORY=swift:example_container_name:/path
export RESTIC_PASSWORD_FILE=/etc/restic/repository-password

restic backup /srv/data

Sla de wijzigingen op en sluit het bestand (ctrl + x > y > enter). Maak het script daarna uitvoerbaar:

sudo chmod 700 /usr/local/bin/restic-backup.sh

De optie set -e zorgt ervoor dat het script direct stopt bij een fout. De variabele RESTIC_PASSWORD_FILE zorgt ervoor dat Restic het repository-wachtwoord uit het aparte bestand leest.

Stap 8

Plan het script in met een cronjob:

sudo crontab -e

Voeg onderaan de crontab de volgende regel toe om iedere nacht om 03:00 uur een back-up te maken:

0 3 * * * /usr/local/bin/restic-backup.sh

In deze regel:

• staat het eerste getal, 0, voor de minuut;
• staat het tweede getal, 3, voor het uur;
• geven de asterisken aan dat de taak elke dag, elke maand en op elke dag van de week draait;
• roept /usr/local/bin/restic-backup.sh het back-upscript aan.

Sla de wijzigingen op en sluit het bestand. De cronjob voert het script daarna automatisch uit op het ingestelde tijdstip.

Gebruik de onderstaande stappen als je Restic op Rocky Linux of AlmaLinux wilt gebruiken. De werkwijze is grotendeels gelijk aan Debian en Ubuntu, maar de installatie loopt via dnf.

Stap 1

Verbind met je server via SSH of de VPS-console.

Stap 2

Installeer Restic via dnf:

sudo dnf -y update && sudo dnf -y install epel-release && sudo dnf -y install restic

De optie -y zorgt ervoor dat de installatie automatisch wordt bevestigd. EPEL is een aanvullende repository met packages die niet standaard in de Rocky Linux- en AlmaLinux-repositories staan.

Stap 3

Zet de OpenStack-omgevingsvariabelen in je huidige shell:

export OS_AUTH_URL=https://auth.teamblue.cloud/v3
export OS_APPLICATION_CREDENTIAL_ID=JOUW_APPLICATION_CREDENTIAL_ID
export OS_APPLICATION_CREDENTIAL_SECRET=JOUW_APPLICATION_CREDENTIAL_SECRET

Deze variabelen zijn alleen actief in de huidige shell. In de automatiseringsstappen hieronder zet je dezelfde waarden rechtstreeks in je script.

Stap 4

Initialiseer je Restic-repository:

restic -r swift:example_container_name:/path init

Vervang example_container_name door de naam van je container. Gebruik optioneel een pad, zoals :/backups/server1, als je de repository niet in de root van de container wilt plaatsen. Als de container nog niet bestaat, maakt Restic deze automatisch aan.

Restic vraagt nu om een repository-wachtwoord. Bewaar dit wachtwoord veilig buiten de back-upomgeving; zonder dit wachtwoord kun je de back-ups niet terugplaatsen.

Stap 5

Maak een eerste test-back-up. In dit voorbeeld gebruiken we de map /srv/data:

restic -r swift:example_container_name:/path --verbose backup /srv/data

Vervang /srv/data door het pad dat je wilt back-uppen, bijvoorbeeld /var/www of /home. Gebruik --verbose voor een eerste test of wanneer je extra uitvoer nodig hebt.

Stap 6

Maak een afgeschermd wachtwoordbestand aan voor geautomatiseerde back-ups:

sudo install -d -m 700 /etc/restic
sudo nano /etc/restic/repository-password

Voeg alleen het repository-wachtwoord toe aan dit bestand. Sla de wijzigingen op en sluit het bestand (ctrl + x > y > enter). Beperk daarna de rechten op het bestand:

sudo chmod 600 /etc/restic/repository-password

In het eerste commando maakt install -d de directory aan. De optie -m 700 zorgt ervoor dat alleen de eigenaar volledige rechten krijgt. Met chmod 600 maak je het wachtwoordbestand alleen lees- en schrijfbaar voor de eigenaar.

Stap 7

Maak nu een script dat de back-up start:

sudo nano /usr/local/bin/restic-backup.sh

Voeg de volgende inhoud toe:

#!/bin/bash
set -e

export OS_AUTH_URL=https://auth.teamblue.cloud/v3
export OS_APPLICATION_CREDENTIAL_ID=JOUW_APPLICATION_CREDENTIAL_ID
export OS_APPLICATION_CREDENTIAL_SECRET=JOUW_APPLICATION_CREDENTIAL_SECRET
export RESTIC_REPOSITORY=swift:example_container_name:/path
export RESTIC_PASSWORD_FILE=/etc/restic/repository-password

restic backup /srv/data

Sla de wijzigingen op en sluit het bestand (ctrl + x > y > enter). Maak het script daarna uitvoerbaar:

sudo chmod 700 /usr/local/bin/restic-backup.sh

De optie set -e zorgt ervoor dat het script direct stopt bij een fout. De variabele RESTIC_PASSWORD_FILE zorgt ervoor dat Restic het repository-wachtwoord uit het aparte bestand leest.

Stap 8

Plan het script in met een cronjob:

sudo crontab -e

Voeg onderaan de crontab de volgende regel toe om iedere nacht om 03:00 uur een back-up te maken:

0 3 * * * /usr/local/bin/restic-backup.sh

In deze regel:

• staat het eerste getal, 0, voor de minuut;
• staat het tweede getal, 3, voor het uur;
• geven de asterisken aan dat de taak elke dag, elke maand en op elke dag van de week draait;
• roept /usr/local/bin/restic-backup.sh het back-upscript aan.

Sla de wijzigingen op en sluit het bestand. De cronjob voert het script daarna automatisch uit op het ingestelde tijdstip.