BlockStorage/repertory
1
0
Fork 0
Code Issues 8 Pull Requests Releases 6 Wiki Activity

updated README.md

Browse Source
This commit is contained in:
Scott E. Graves
2025-02-11 08:53:29 -06:00
parent 051e9e1130
commit 9fdc0c172d
1 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,15 +1,16 @@
# Repertory # 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. on Windows.
## Details and Features ## Details and Features
* Optimized for [Plex Media Server](https://www.plex.tv/) * 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 * 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) * 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 ## Minimum Requirements
@ -54,21 +55,23 @@ on Windows.
* Initial Configuration * Initial Configuration
* S3 steps: * S3 steps:
* Set the appropriate bucket name:
* `repertory -s3 --name '<my config name>' -set S3Config.Bucket '<my bucket name>'`
* Set the appropriate base URL: * Set the appropriate base URL:
* `repertory -s3 --name '<my config name>' -set S3Config.URL '<my url>'` * `repertory -s3 --name '<my config name>' -set S3Config.URL '<my 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 '<my config name>' -set S3Config.Bucket '<my bucket name>'`
* Set the appropriate access key: * Set the appropriate access key:
* `repertory -s3 --name '<my config name>' -set S3Config.AccessKey '<my access key>'` * `repertory -s3 --name '<my config name>' -set S3Config.AccessKey '<my access key>'`
* Set the appropriate secret key: * Set the appropriate secret key:
* `repertory -s3 --name '<my config name>' -set S3Config.SecretKey '<my secret key>'` * `repertory -s3 --name '<my config name>' -set S3Config.SecretKey '<my secret key>'`
* For Sia and most local S3 gateway instances, enable path style URL's: * For Sia and most local S3 gateway instances, enable path style URL's:
* `repertory -s3 --name '<my config name>' -set S3Config.UsePathStyle true` * `repertory -s3 --name '<my config name>' -set S3Config.UsePathStyle true`
* Optionally, set the appropriate region. Default is set to `any`: * Optional steps:
* `repertory -s3 --name '<my config name>' -set S3Config.Region '<my region>'` * Set the appropriate region. Default is set to `any`:
* Optionally, to enable encrypted file names and file data, set a strong, random encryption token: * `repertory -s3 --name '<my config name>' -set S3Config.Region '<my region>'`
* `repertory -s3 --name '<my config name>' -set S3Config.EncryptionToken '<my strong password>'` * 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 '<my config name>' -set S3Config.EncryptionToken '<my strong password>'`
* To verify/view all configuration options: * To verify/view all configuration options:
* `repertory -s3 --name '<my config name>' -dc` * `repertory -s3 --name '<my config name>' -dc`
* Mounting on Linux: * Mounting on Linux: