Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions content/de/developer/integration/backup/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Backup"
description: "Verbinden Sie Backup-Tools über S3-kompatible Objektspeicher-Schnittstellen mit RustFS."
---

Verwenden Sie **RustFS** als Objektspeicher-Backend für Backup-Tools, die Repository-Daten in einem S3-kompatiblen Dienst ablegen.

## Systeme

- [Restic](./restic.md)

Halten Sie Backup-Jobs in einem eigenen Bucket und Präfix und verwenden Sie Anmeldedaten, die auf die erforderlichen Bucket-Operationen beschränkt sind.
6 changes: 6 additions & 0 deletions content/de/developer/integration/backup/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"title": "Backup",
"pages": [
"restic"
]
}
91 changes: 91 additions & 0 deletions content/de/developer/integration/backup/restic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: "Restic"
description: "Sichern Sie lokale Daten mit Restic in RustFS und stellen Sie Snapshots aus einem S3-kompatiblen Repository wieder her."
---

Restic ist ein Kommandozeilen-Backup-Tool, das Snapshots in einem Repository speichert. Diese Anleitung zeigt, wie Sie Restic auf RustFS ausrichten, ein lokales Verzeichnis sichern, einen Snapshot wiederherstellen und die gespeicherten Objekte in RustFS prüfen.

Sie benötigen eine laufende RustFS-Instanz, einen Bucket wie `my-bucket`, eine installierte Restic-Version, Zugriffsschlüssel für den Bucket und ein Passwort für das Restic-Repository.

:::note[Pfadbasierte Adressierung]

Die S3-Backend-Konfiguration von Restic sollte für RustFS pfadbasierte Adressierung verwenden. Diese Anleitung setzt `-o s3.bucket-lookup=path` und verwendet den Bucket-Namen in der Repository-URL.

:::

## Architektur

```mermaid
flowchart LR
Files["Local files"] --> Restic["Restic"]
Restic -->|S3 API| RustFS["RustFS"]
RustFS --> Bucket["my-bucket/restic"]
```

Restic schreibt Repository-Metadaten und Sicherungssnapshots über die S3 API in RustFS. Das Repository-Präfix in dieser Anleitung lautet `restic`, der Bucket `my-bucket`.

## 1. Bucket vorbereiten

Öffnen Sie die RustFS Console unter `http://localhost:9001` und erstellen Sie `my-bucket`, oder wählen Sie einen vorhandenen Bucket, der ausschließlich für Backups verwendet wird.

![RustFS Console mit der Bucket-Liste und dem ausgewählten Backup-Bucket `my-bucket`](./images/restic-console.png)

Verwenden Sie für jeden Backup-Job einen eigenen Bucket. Der Screenshot zeigt die Console in englischer Sprache und im hellen Design.

## 2. Restic-Repository initialisieren

Setzen Sie die Anmeldedaten, die Region, das Repository-Passwort und den Repository-Pfad:

```bash
export AWS_ACCESS_KEY_ID=<your-access-key>
export AWS_SECRET_ACCESS_KEY=<your-secret-key>
export AWS_DEFAULT_REGION=us-east-1
export RESTIC_PASSWORD=<your-restic-password>
export RESTIC_REPOSITORY=s3:http://localhost:9000/my-bucket/restic
```

Führen Sie `restic init` mit pfadbasierter Bucket-Auswahl aus:

```bash
restic -o s3.bucket-lookup=path init
```

Das Repository-Passwort schützt die Snapshot-Daten. Bewahren Sie es getrennt von den RustFS-Zugriffsschlüsseln auf.

## 3. Daten sichern

Erstellen Sie ein kleines Testverzeichnis und sichern Sie es:

```bash
mkdir -p ~/Documents/restic-demo
printf 'hello from RustFS\n' > ~/Documents/restic-demo/hello.txt
restic -o s3.bucket-lookup=path backup ~/Documents/restic-demo
```

Restic gibt nach Abschluss des Backups eine Snapshot-ID aus. Führen Sie den Befehl nach einer Dateianpassung erneut aus, um einen zweiten Snapshot zu erzeugen.

## 4. Snapshot wiederherstellen

Stellen Sie den neuesten Snapshot in ein separates Verzeichnis wieder her:

```bash
mkdir -p ~/Documents/restic-restore
restic -o s3.bucket-lookup=path restore latest --target ~/Documents/restic-restore
```

Sie können auch eine bestimmte Snapshot-ID wiederherstellen, wenn Sie eine ältere Version benötigen.

## 5. Repository in RustFS prüfen

Öffnen Sie `my-bucket` in der RustFS Console und prüfen Sie, ob Restic Repository-Objekte unter dem Präfix `restic/` erstellt hat.

Sie können zusätzlich die Repository-Prüfung ausführen:

```bash
restic -o s3.bucket-lookup=path check
```

## Nächste Schritte

- [CLI Client (rc)](/operations/rc) zum Erstellen von Buckets und Prüfen von Objekten über die Kommandozeile.
- [TLS Configuration](/integration/tls-configured), wenn Sie RustFS außerhalb eines vertrauenswürdigen Netzwerks bereitstellen.
3 changes: 2 additions & 1 deletion content/de/developer/integration/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
---
title: "Integration"
description: "Integrate RustFS with reverse proxies and big data systems."
description: "Integrate RustFS with reverse proxies, backup tools, and big data systems."
---

Use this section to connect **RustFS** to infrastructure and application platforms through its S3-compatible API.

## Integration categories

- [Reverse Proxy](./reverse-proxy/index.md) covers Nginx, Traefik, Caddy, and HAProxy.
- [Backup](./backup/index.md) covers Restic.
- [Big Data](./big-data/index.md) covers Iceberg.

Each guide identifies the RustFS endpoint and addressing requirements to use when configuring the integrating system.
1 change: 1 addition & 0 deletions content/de/developer/integration/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"title": "Integration",
"pages": [
"reverse-proxy",
"backup",
"big-data"
]
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions content/en/developer/integration/backup/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Backup"
description: "Connect backup tools to RustFS through S3-compatible object storage interfaces."
---

Use **RustFS** as the object storage backend for backup tools that store repository data in an S3-compatible service.

## Systems

- [Restic](./restic.md)

Keep backup jobs in a dedicated bucket and prefix, and use credentials scoped to the required bucket operations.
6 changes: 6 additions & 0 deletions content/en/developer/integration/backup/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"title": "Backup",
"pages": [
"restic"
]
}
91 changes: 91 additions & 0 deletions content/en/developer/integration/backup/restic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: "Restic"
description: "Back up local data to RustFS with Restic and restore snapshots from an S3-compatible repository."
---

Restic is a command-line backup tool that stores snapshots in a repository. This guide shows how to point Restic at RustFS, back up a local directory, restore a snapshot, and verify the stored objects in RustFS.

You need a running RustFS instance, a bucket such as `my-bucket`, Restic installed, access keys for the bucket, and a password for the Restic repository.

:::note[Path-style access]

Restic's S3 backend should use path-style access for RustFS. This guide sets `-o s3.bucket-lookup=path` and uses the bucket name in the repository URL.

:::

## Architecture

```mermaid
flowchart LR
Files["Local files"] --> Restic["Restic"]
Restic -->|S3 API| RustFS["RustFS"]
RustFS --> Bucket["my-bucket/restic"]
```

Restic writes repository metadata and backup snapshots into RustFS through the S3 API. The repository prefix in this guide is `restic`, and the bucket is `my-bucket`.

## 1. Prepare the bucket

Open the RustFS Console at `http://localhost:9001` and create `my-bucket`, or choose an existing bucket that is dedicated to backups.

![RustFS Console bucket list with the `my-bucket` backup bucket selected](./images/restic-console.png)

Use a dedicated bucket for each backup job. The example screenshot shows the Console in English and light theme.

## 2. Initialize the Restic repository

Set the credentials, region, repository password, and repository location:

```bash
export AWS_ACCESS_KEY_ID=<your-access-key>
export AWS_SECRET_ACCESS_KEY=<your-secret-key>
export AWS_DEFAULT_REGION=us-east-1
export RESTIC_PASSWORD=<your-restic-password>
export RESTIC_REPOSITORY=s3:http://localhost:9000/my-bucket/restic
```

Run `restic init` with path-style bucket lookup:

```bash
restic -o s3.bucket-lookup=path init
```

The repository password protects the snapshot data. Keep it separate from the RustFS access keys.

## 3. Back up data

Create a small test directory and back it up:

```bash
mkdir -p ~/Documents/restic-demo
printf 'hello from RustFS\n' > ~/Documents/restic-demo/hello.txt
restic -o s3.bucket-lookup=path backup ~/Documents/restic-demo
```

Restic prints a snapshot ID after the backup completes. Run the command again after changing a file to create a second snapshot.

## 4. Restore a snapshot

Restore the latest snapshot to a separate directory:

```bash
mkdir -p ~/Documents/restic-restore
restic -o s3.bucket-lookup=path restore latest --target ~/Documents/restic-restore
```

You can also restore a specific snapshot ID if you want to recover an earlier version.

## 5. Verify the repository in RustFS

Open `my-bucket` in the RustFS Console and confirm that Restic created repository objects under the `restic/` prefix.

You can also run a repository check:

```bash
restic -o s3.bucket-lookup=path check
```

## Next steps

- [CLI Client (rc)](/operations/rc) to create buckets and inspect objects from the command line.
- [TLS Configuration](/integration/tls-configured) if you expose RustFS outside a trusted network.
3 changes: 2 additions & 1 deletion content/en/developer/integration/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
---
title: "Integration"
description: "Integrate RustFS with reverse proxies and big data systems."
description: "Integrate RustFS with reverse proxies, backup tools, and big data systems."
---

Use this section to connect **RustFS** to infrastructure and application platforms through its S3-compatible API.

## Integration categories

- [Reverse Proxy](./reverse-proxy/index.md) covers Nginx, Traefik, Caddy, and HAProxy.
- [Backup](./backup/index.md) covers Restic.
- [Big Data](./big-data/index.md) covers Iceberg.

Each guide identifies the RustFS endpoint and addressing requirements to use when configuring the integrating system.
1 change: 1 addition & 0 deletions content/en/developer/integration/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"title": "Integration",
"pages": [
"reverse-proxy",
"backup",
"big-data"
]
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions content/fr/developer/integration/backup/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Sauvegarde"
description: "Connectez des outils de sauvegarde à RustFS via des interfaces de stockage objet compatibles S3."
---

Utilisez **RustFS** comme backend de stockage objet pour les outils de sauvegarde qui stockent les données de dépôt dans un service compatible S3.

## Systèmes

- [Restic](./restic.md)

Conservez les tâches de sauvegarde dans un compartiment et un préfixe dédiés, et utilisez des identifiants limités aux opérations de compartiment nécessaires.
6 changes: 6 additions & 0 deletions content/fr/developer/integration/backup/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"title": "Sauvegarde",
"pages": [
"restic"
]
}
91 changes: 91 additions & 0 deletions content/fr/developer/integration/backup/restic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: "Restic"
description: "Sauvegardez des données locales vers RustFS avec Restic et restaurez des snapshots depuis un dépôt compatible S3."
---

Restic est un outil de sauvegarde en ligne de commande qui stocke les snapshots dans un dépôt. Cette page montre comment pointer Restic vers RustFS, sauvegarder un répertoire local, restaurer un snapshot et vérifier les objets stockés dans RustFS.

Vous avez besoin d'une instance RustFS en cours d'exécution, d'un compartiment comme `my-bucket`, de Restic installé, de clés d'accès pour le compartiment et d'un mot de passe pour le dépôt Restic.

:::note[Adressage de type chemin]

Le backend S3 de Restic doit utiliser l'adressage de type chemin avec RustFS. Cette page définit `-o s3.bucket-lookup=path` et utilise le nom du compartiment dans l'URL du dépôt.

:::

## Architecture

```mermaid
flowchart LR
Files["Local files"] --> Restic["Restic"]
Restic -->|S3 API| RustFS["RustFS"]
RustFS --> Bucket["my-bucket/restic"]
```

Restic écrit les métadonnées du dépôt et les snapshots de sauvegarde dans RustFS via l'API S3. Le préfixe du dépôt dans cette page est `restic`, et le compartiment est `my-bucket`.

## 1. Préparer le compartiment

Ouvrez la Console RustFS à l'adresse `http://localhost:9001` et créez `my-bucket`, ou choisissez un compartiment existant dédié aux sauvegardes.

![Console RustFS affichant la liste des compartiments avec le compartiment de sauvegarde `my-bucket` sélectionné](./images/restic-console.png)

Utilisez un compartiment dédié pour chaque tâche de sauvegarde. La capture d'écran montre la Console en anglais et en thème clair.

## 2. Initialiser le dépôt Restic

Définissez les identifiants, la région, le mot de passe du dépôt et l'emplacement du dépôt :

```bash
export AWS_ACCESS_KEY_ID=<your-access-key>
export AWS_SECRET_ACCESS_KEY=<your-secret-key>
export AWS_DEFAULT_REGION=us-east-1
export RESTIC_PASSWORD=<your-restic-password>
export RESTIC_REPOSITORY=s3:http://localhost:9000/my-bucket/restic
```

Exécutez `restic init` avec la sélection de compartiment en mode chemin :

```bash
restic -o s3.bucket-lookup=path init
```

Le mot de passe du dépôt protège les données des snapshots. Conservez-le séparément des clés d'accès RustFS.

## 3. Sauvegarder des données

Créez un petit répertoire de test et sauvegardez-le :

```bash
mkdir -p ~/Documents/restic-demo
printf 'hello from RustFS\n' > ~/Documents/restic-demo/hello.txt
restic -o s3.bucket-lookup=path backup ~/Documents/restic-demo
```

Restic affiche l'ID du snapshot une fois la sauvegarde terminée. Relancez la commande après avoir modifié un fichier pour créer un second snapshot.

## 4. Restaurer un snapshot

Restaurez le snapshot le plus récent dans un répertoire séparé :

```bash
mkdir -p ~/Documents/restic-restore
restic -o s3.bucket-lookup=path restore latest --target ~/Documents/restic-restore
```

Vous pouvez aussi restaurer un ID de snapshot précis si vous devez récupérer une version antérieure.

## 5. Vérifier le dépôt dans RustFS

Ouvrez `my-bucket` dans la Console RustFS et vérifiez que Restic a créé des objets de dépôt sous le préfixe `restic/`.

Vous pouvez aussi lancer une vérification du dépôt :

```bash
restic -o s3.bucket-lookup=path check
```

## Étapes suivantes

- [CLI Client (rc)](/operations/rc) pour créer des compartiments et inspecter les objets depuis la ligne de commande.
- [Configuration TLS](/integration/tls-configured) si vous exposez RustFS hors d'un réseau de confiance.
Loading
Loading