From 9fdc0c172d0e94e8902d73a41077ef4ea00302f9 Mon Sep 17 00:00:00 2001 From: "Scott E. Graves" Date: Tue, 11 Feb 2025 08:53:29 -0600 Subject: [PATCH] updated README.md --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3b3fd2bc..523a3302 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ # Repertory -Repertory allows you to mount AWS S3 and Sia via FUSE on Linux or via WinFSP +Repertory allows you to mount S3 and Sia via FUSE on Linux or via WinFSP on Windows. ## Details and Features * Optimized for [Plex Media Server](https://www.plex.tv/) -* Single application to mount AWS S3 and/or Sia +* Single application to mount S3 and/or Sia * Remote mounting of Repertory instances on Linux and Windows - * Securely share your mounts over TCP/IP (`XChaCha20-Poly1305` stream cipher) with other systems on your network or the internet. + * Securely share your mounts over TCP/IP via `XChaCha20-Poly1305` with other systems on your network or the internet. * Cross-platform support (Linux 64-bit, Linux arm64/aarch64, Windows 64-bit) +* Optionally encrypt file names and file data via `XChaCha20-Poly1305` in S3 mounts ## Minimum Requirements @@ -54,21 +55,23 @@ on Windows. * Initial Configuration * S3 steps: - * Set the appropriate bucket name: - * `repertory -s3 --name '' -set S3Config.Bucket ''` * Set the appropriate base URL: * `repertory -s3 --name '' -set S3Config.URL ''` - * i.e. `repertory -s3 --name minio -set S3Config.URL 'http://localhost:9000'` + * Example: + * `repertory -s3 --name minio -set S3Config.URL 'http://localhost:9000'` + * Set the appropriate bucket name: + * `repertory -s3 --name '' -set S3Config.Bucket ''` * Set the appropriate access key: * `repertory -s3 --name '' -set S3Config.AccessKey ''` * Set the appropriate secret key: * `repertory -s3 --name '' -set S3Config.SecretKey ''` * For Sia and most local S3 gateway instances, enable path style URL's: * `repertory -s3 --name '' -set S3Config.UsePathStyle true` - * Optionally, set the appropriate region. Default is set to `any`: - * `repertory -s3 --name '' -set S3Config.Region ''` - * Optionally, to enable encrypted file names and file data, set a strong, random encryption token: - * `repertory -s3 --name '' -set S3Config.EncryptionToken ''` + * Optional steps: + * Set the appropriate region. Default is set to `any`: + * `repertory -s3 --name '' -set S3Config.Region ''` + * Enable encrypted file names and file data. Set a strong, random encryption token and be sure to store it in a secure backup location: + * `repertory -s3 --name '' -set S3Config.EncryptionToken ''` * To verify/view all configuration options: * `repertory -s3 --name '' -dc` * Mounting on Linux: