From 90c2f3ac278239a3e3fbbf425fdd303a20bd8b11 Mon Sep 17 00:00:00 2001 From: Damiano Albani Date: Sat, 24 Jun 2023 14:06:22 +0200 Subject: [PATCH] Document rclone storage backend --- Cloud-Tier.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/Cloud-Tier.md b/Cloud-Tier.md index 4baf523..87e9c7a 100644 --- a/Cloud-Tier.md +++ b/Cloud-Tier.md @@ -50,9 +50,14 @@ Compared to direct S3 storage, this is both faster and cheaper! 1. Use `volume.tier.download` in `weed shell` to move volumes to the local cluster. ## Configuring Storage Backend -(Currently only s3 is developed. More is coming soon.) -Multiple s3 buckets are supported. Usually you just need to configure one backend. +The following storage backends are currently supported: +- S3 +- Rclone + +### S3 + +Multiple S3 buckets are supported. Usually you just need to configure one backend. ``` # The storage backends are configured on the master, inside master.toml @@ -75,6 +80,26 @@ Multiple s3 buckets are supported. Usually you just need to configure one backen ``` +### Rclone + +Here's an example of a configuration for an Rclone storage backend: + +``` +[storage.backend] + [storage.backend.rclone.default] + enabled = true + remote_name = "my-onedrive" +``` + +Where `my-remote` must correspond to what's configured in `~/.config/rclone/rclone.conf`: +``` +[my-onedrive] +type = onedrive +... +``` + +### Configuration + After changing the master config, you need to **restart the volume servers** so that they pull the updated configuration from the master. If you forget to do this, you'll get an error message about no storage backends being configured.