v2.0.3-rc (#32)

# Changelog

## v2.0.3-rc

### Issues

* \#28 \[bug\] Address slow directory responses in S3 mounts for deeply nested directories
* \#29 \[bug\] S3 error responses are not being logged
* \#30 \[bug\] Sia provider error responses are not logged
* \#31 \[bug\] S3 provider should limit max key size to 1024

### Changes from v2.0.2-rc

* Always use direct for read-only providers
* Fixed externally removed files not being processed during cleanup
* Fixed http headers not being added for requests
* Fixed incorrect `stat` values for remote mounts
* Fixed invalid directory nullptr error on remote mounts
* Fixed memory leak in event system
* Refactored application shutdown
* Refactored event system
* Updated build system to Alpine 3.21.0
* Updated build system to MinGW-w64 12.0.0
* Updated copyright to 2018-2025

Reviewed-on: #32

README.md

@@ -1,23 +1,22 @@
 # Repertory
 
-Repertory allows you to mount AWS S3 and Sia via FUSE on Linux ~~/OS X~~ 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
-* Remote mounting of Repertory instances on Linux ~~, OS X~~ and Windows
-  * Securely share your mounts over TCP/IP (`XChaCha20-Poly1305` stream cipher)
-* Cross-platform support (Linux 64-bit, Linux arm64/aarch64, ~~OS X,~~ Windows 64-bit)
+* Single application to mount S3 and/or Sia
+* Remote mounting of Repertory instances on Linux and Windows
+  * Securely share your mounts over TCP/IP via `XChaCha20-Poly1305` with other systems on your network or over 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
 
 * [Sia renterd](https://github.com/SiaFoundation/renterd/releases) v0.4.0+ for Sia support
 * Only 64-bit operating systems are supported
   * By default, Linux requires `fusermount3`; otherwise, `repertory` must be manually compiled with `libfuse2` support
-  * ~~OS X requires the following dependency to be installed:~~
-    * ~~[FUSE for macOS v4.5.0](https://github.com/osxfuse/osxfuse/releases/download/macfuse-4.5.0/macfuse-4.5.0.dmg)~~
   * Windows requires the following dependencies to be installed:
     * [WinFSP 2023](https://github.com/winfsp/winfsp/releases/download/v2.0/winfsp-2.0.23075.msi)
 
@@ -25,47 +24,103 @@ on Windows.
 
 * Linux `arm64/aarch64`
 * Linux `amd64`
-* ~~OS X Mojave and above~~
 * Windows 64-bit 10, 11
 
 ## Usage
 
+### Sia
+
+* Initial Configuration
+  * Sia steps:
+    * Set the appropriate bucket name and `renterd` API password in `repertory` configuration:
+      * To use `default` as the bucket name and configuration name:
+        * `repertory -set HostConfig.ApiPassword '<my password>'`
+      * To use a different bucket name with `default` as the configuration name:
+        * `repertory -set HostConfig.ApiPassword '<my password>'`
+        * `repertory -set SiaConfig.Bucket '<my bucket>'`
+      * For all other configurations:
+        * `repertory --name '<my config name>' -set HostConfig.ApiPassword '<my password>'`
+        * `repertory --name '<my config name>' -set SiaConfig.Bucket '<my bucket name>'`
+  * To verify/view all configuration options:
+    * `repertory -dc`
+    * `repertory --name '<my config name>' -dc`
+      * Example:
+        * `repertory --name default -dc`
+* Mounting on Linux:
+  * `repertory /mnt/location`
+  * `repertory --name '<my config name>' /mnt/location`
+    * Example:
+      * `repertory --name default /mnt/location`
+* Mounting on Windows:
+  * `repertory t:`
+  * `repertory --name '<my config name>' t:`
+    * Example:
+      * `repertory --name default t:`
+
+### S3
+
+* Initial Configuration
+  * S3 steps:
+    * Set the appropriate base URL:
+      * `repertory -s3 --name '<my config name>' -set S3Config.URL '<my url>'`
+        * 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:
+      * `repertory -s3 --name '<my config name>' -set S3Config.AccessKey '<my access key>'`
+    * Set the appropriate 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:
+      * `repertory -s3 --name '<my config name>' -set S3Config.UsePathStyle true`
+    * Optional steps:
+      * Set an appropriate region. Default is set to `any`:
+        * `repertory -s3 --name '<my config name>' -set S3Config.Region '<my 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 '<my config name>' -set S3Config.EncryptionToken '<my strong password>'`
+  * To verify/view all configuration options:
+    * `repertory -s3 --name '<my config name>' -dc`
+      * Example:
+        * `repertory -s3 --name minio -dc`
+* Mounting on Linux:
+  * `repertory -s3 --name '<my config name>' /mnt/location`
+    * Example:
+      * `repertory -s3 --name minio /mnt/location`
+* Mounting on Windows:
+  * `repertory -s3 --name '<my config name>' t:`
+    * Example:
+      * `repertory -s3 --name minio t:`
+
 ### Notable Options
 
-* `-dc`
-  * Display mount configuration.
-  * For Sia, `--name` is optional
-  * For S3, the `-s3` option is required along with `--name`
 * `--help`
-  * Display all mount utility options.
+  * Display all mount utility options
 * `--name, -na [name]`
   * The `--name` option can be set to any valid value allowed as a file name for your filesystem.
   * For Sia, the bucket name will be set to the same value if it is empty in the configuration file.
     * If the `--name` option is not specified, `default` will be used.
   * For S3, the `--name` option is required and does not affect the bucket name.
-* `-set SiaConfig.Bucket`
-  * Set Sia bucket name for the mount.
-  * Can be used in combination with `--name` to target a unique configuration.
-* `-set S3Config.Bucket`
-  * S3 bucket name for the mount.
-  * Must be used in combination with `--name` to target a unique configuration.
-  * Must be used in combination with `-s3`.
+* `-dc`
+  * Display mount configuration
+  * For Sia, `--name` is optional
+  * For S3, the `-s3` option is required along with `--name`
 
-### Sia
+### Data Directories
 
 * Linux
-  * `repertory /mnt/location`
-  * `repertory --name default /mnt/location`
+  * `~/.local/repertory2`
 * Windows
-  * `repertory.exe t:`
-  * `repertory.exe --name default t:`
+  * `%LOCALAPPDATA%\repertory2`
+    * Example:
+      * `C:\Users\Tom\AppData\Local\repertory2`
+    * IMPORTANT:
+      * It is highly recommended to exclude this folder from any anti-virus/anti-malware applications as severe performance issues may arise.
+      * Excluding the mounted drive letter is also highly recommended.
 
-### S3
+## Remote Mounting
 
-* Linux 
-  * `repertory --name storj -s3 /mnt/location`
-* Windows
-  * `repertory.exe --name storj -s3 t:`
+`Repertory` allows local mounts to be shared with other computers on your network.
+This option is referred to as remote mounting. Instructions TBD.
 
 ## Compiling
 
@@ -94,17 +149,26 @@ on Windows.
 
 ## Credits
 
+* [binutils](https://www.gnu.org/software/binutils/)
 * [boost c++ libraries](https://www.boost.org/)
 * [cpp-httplib](https://github.com/yhirose/cpp-httplib)
 * [curl](https://curl.haxx.se/)
-* ~~[FUSE for macOS](https://osxfuse.github.io/)~~
+* [docker](https://www.docker.com/)
 * [Google Test](https://github.com/google/googletest)
+* [ICU](https://icu.unicode.org/)
 * [JSON for Modern C++](https://github.com/nlohmann/json)
+* [libexpat](https://github.com/libexpat/libexpat)
 * [libfuse](https://github.com/libfuse/libfuse)
 * [libsodium](https://doc.libsodium.org/)
+* [mingw-w64](https://www.mingw-w64.org/)
+* [MSYS2](https://www.msys2.org)
 * [OpenSSL](https://www.openssl.org/)
+* [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/)
+* [pugixml](https://pugixml.org/)
+* [RocksDB](https://rocksdb.org)
 * [ScPrime](https://scpri.me/)
 * [Sia Decentralized Cloud Storage](https://sia.tech/)
+* [spdlog](https://github.com/gabime/spdlog)
 * [SQLite](https://www.sqlite.org)
 * [stduuid](https://github.com/mariusbancila/stduuid)
 * [Storj](https://storj.io/)