v2.0.2-rc (#27)

## v2.0.2-rc

### BREAKING CHANGES

* Refactored `config.json` - will need to verify configuration settings prior to mounting

### Issues

* \#12 \[Unit Test\] Complete all providers unit tests
* \#14 \[Unit Test\] SQLite mini-ORM unit tests and cleanup
* \#16 Add support for bucket name in Sia provider
* \#17 Update to common c++ build system
  * A single 64-bit Linux Jenkins server is used to build all Linux and Windows versions
  * All dependency sources are now included
  * MSVC is no longer supported
  * MSYS2 is required for building Windows binaries on Windows
  * OS X support is temporarily disabled
* \#19 \[bug\] Rename file is broken for files that are existing
* \#23 \[bug\] Incorrect file size displayed while upload is pending
* \#24 RocksDB implementations should be transactional
* \#25 Writes should block when maximum cache size is reached
* \#26 Complete ring buffer and direct download support

### Changes from v2.0.1-rc

* Ability to choose between RocksDB and SQLite databases
* Added direct reads and implemented download fallback
* Corrected file times on S3 and Sia providers
* Corrected handling of `chown()` and `chmod()`
* Fixed erroneous download of chunks after resize

Reviewed-on: #27

README.md

@@ -1,24 +1,23 @@
 # Repertory
 
-Repertory allows you to mount AWS S3 and Sia via FUSE on Linux/OS X or via WinFSP
+Repertory allows you to mount AWS S3 and Sia via FUSE on Linux ~~/OS X~~ 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
-* Only 1 Sia mount and 1 S3 mount (per bucket) per user is supported.
-* Remote mounting of Repertory instances on Linux, OS X and Windows
+* 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)
+* Cross-platform support (Linux 64-bit, Linux arm64/aarch64, ~~OS X,~~ Windows 64-bit)
 
 ## Minimum Requirements
 
 * [Sia renterd](https://github.com/SiaFoundation/renterd/releases) v0.4.0+ for Sia support
 * Only 64-bit operating systems are supported
-  * Linux requires `fusermount3` or `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)
+  * 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)
 
@@ -26,15 +25,79 @@ on Windows.
 
 * Linux `arm64/aarch64`
 * Linux `amd64`
-* OS X Mojave and above
+* ~~OS X Mojave and above~~
 * Windows 64-bit 10, 11
 
+## Usage
+
+### 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.
+* `--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`.
+
+### Sia
+
+* Linux
+  * `repertory /mnt/location`
+  * `repertory --name default /mnt/location`
+* Windows
+  * `repertory.exe t:`
+  * `repertory.exe --name default t:`
+
+### S3
+
+* Linux 
+  * `repertory --name storj -s3 /mnt/location`
+* Windows
+  * `repertory.exe --name storj -s3 t:`
+
+## Compiling
+
+* Successful compilation will result in all required files being placed in the `dist/` directory
+* Linux
+  * Ensure `docker` is installed
+    * For x86_64:
+      * RelWithDebInfo: `scripts/make_unix.sh`
+      * Release: `scripts/make_unix.sh x86_64 Release`
+      * Debug: `scripts/make_unix.sh x86_64 Debug`
+    * For aarch64:
+      * RelWithDebInfo: `scripts/make_unix.sh aarch64`
+      * Release: `scripts/make_unix.sh aarch64 Release`
+      * Debug: `scripts/make_unix.sh aarch64 Debug`
+* Windows
+  * OFFICIAL: Cross-compiling on Linux
+    * Ensure `docker` is installed
+      * RelWithDebInfo: `scripts/make_win32.sh`
+      * Release: `scripts/make_win32.sh x86_64 Release`
+      * Debug: `scripts/make_win32.sh x86_64 Debug`
+  * UNOFFICIAL: Compiling on Windows
+    * Ensure latest [MSYS2](https://www.msys2.org/) is installed
+      * RelWithDebInfo: `scripts\make_win32.cmd`
+      * Release: `scripts\make_win32.cmd x86_64 Release`
+      * Debug: `scripts\make_win32.cmd x86_64 Debug`
+
 ## Credits
 
 * [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/)
+* ~~[FUSE for macOS](https://osxfuse.github.io/)~~
 * [Google Test](https://github.com/google/googletest)
 * [JSON for Modern C++](https://github.com/nlohmann/json)
 * [libfuse](https://github.com/libfuse/libfuse)
@@ -52,28 +115,17 @@ on Windows.
 
 ```text
 -----BEGIN PUBLIC KEY-----
-MIIEIjANBgkqhkiG9w0BAQEFAAOCBA8AMIIECgKCBAEKfZmq5mMAtD4kSt2Gc/5J
-H+HHTYtUZE6YYvsvz8TNG/bNL67ZtNRyaoMyhLTfIN4rPBNLUfD+owNS+u5Yk+lS
-ZLYyOuhoCZIFefayYqKLr42G8EeuRbx0IMzXmJtN0a4rqxlWhkYufJubpdQ+V4DF
-oeupcPdIATaadCKVeZC7A0G0uaSwoiAVMG5dZqjQW7F2LoQm3PhNkPvAybIJ6vBy
-LqdBegS1JrDn43x/pvQHzLO+l+FIG23D1F7iF+yZm3DkzBdcmi/mOMYs/rXZpBym
-2/kTuSGh5buuJCeyOwR8N3WdvXw6+KHMU/wWU8qTCTT87mYbzH4YR8HgkjkLHxAO
-5waHK6vMu0TxugCdJmVV6BSbiarJsh66VRosn7+6hlq6AdgksxqCeNELZBS+LBki
-tb5hKyL+jNZnaHiR0U7USWtmnqZG6FVVRzlCnxP7tZo5O5Ex9AAFGz5JzOzsFNbv
-xwQ0zqaTQOze+MJbkda7JfRoC6TncD0+3hoXsiaF4mCn8PqUCn0DwhglcRucZlST
-ZvDNDo1WAtxPJebb3aS6uymNhBIquQbVAWxVO4eTrOYEgutxwkHE3yO3is+ogp8d
-xot7f/+vzlbsbIDyuZBDe0fFkbTIMTU48QuUUVZpRKmKZTHQloz4EHqminbfX1sh
-M7wvDkpJEtqbc0VnG/BukUzP6e7Skvgc7eF1sI3+8jH8du2rivZeZAl7Q2f+L9JA
-BY9pjaxttxsud7V5jeFi4tKuDHi21/XhSjlJK2c2C4AiUEK5/WhtGbQ5JjmcOjRq
-yXFRqLlerzOcop2kbtU3Ar230wOx3Dj23Wg8++lV3LU4U9vMR/t0qnSbCSGJys7m
-ax2JpFlTwj/0wYuTlVFoNQHZJ1cdfyRiRBY4Ou7XO0W5hcBBKiYsC+neEeMMHdCe
-iTDIW/ojcVTdFovl+sq3n1u4SBknE90JC/3H+TPE1s2iB+fwORVg0KPosQSNDS0A
-7iK6AZCDC3YooFo+OzHkYMt9uLkXiXMSLx70az+qlIwOzVHKxCo7W/QpeKCXUCRZ
-MMdlYEUs1PC8x2qIRUEVHuJ0XMTKNyOHmzVLuLK93wUWbToh+rdDxnbhX+emuESn
-XH6aKiUwX4olEVKSylRUQw8nVckZGVWXzLDlgpzDrLHC8J8qHzFt7eCqOdiqsxhZ
-x1U5LtugxwSWncTZ7vlKl0DuC/AWB7SuDi7bGRMSVp2n+MnD1VLKlsCclHXjIciE
-W29n3G3lJ/sOta2sxqLd0j1XBQddrFXl5b609sIY81ocHqu8P2hRu5CpqJ/sGZC5
-mMH3segHBkRj0xJcfOxceRLj1a+ULIIR3xL/3f8s5Id25TDo/nqBoCvu5PeCpo6L
-9wIDAQAB
+MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAqXedleDOugdk9sBpgFOA
+0+MogIbBF7+iXIIHv8CRBbrrf8nxLSgQvbHQIP0EklebDgLZRgyGI3SSQYj7D957
+uNf1//dpkELNzfuezgAyFer9+iH4Svq46HADp5k+ugaK0mMDZM7OLOgo7415/+z4
+NIQopv8prMFdxkShr4e4dpR+S6LYMYMVjsi1gnYWaZJMWgzeZouXFSscS1/XDXSE
+vr1Jfqme+RmB4Q2QqGcDrY2ijumCJYJzQqlwG6liJ4FNg0U3POTCQDhQmuUoEJe0
+/dyiWlo48WQbBu6gUDHbTCCUSZPs2Lc9l65MqOCpX76+VXPYetZgqpMF4GVzb2y9
+kETxFNpiMYBlOBZk0I1G33wqVmw46MI5IZMQ2z2F8Mzt1hByUNTgup2IQELCv1a5
+a2ACs2TBRuAy1REeHhjLgiA/MpoGX7TpoHCGyo8jBChJVpP9ZHltKoChwDC+bIyx
+rgYH3jYDkl2FFuAUJ8zAZl8U1kjqZb9HGq9ootMk34Dbo3IVkc2azB2orEP9F8QV
+KxvZZDA9FAFEthSiNf5soJ6mZGLi0es5EWPoKMUEd9tG5bP980DySAWSSRK0AOfE
+QShT/z7oG79Orxyomwrb8ZJCi7wEfcCuK1NWgqLVUgXhpi2J9WYS6DAbF3Oh3Hhl
+DYSHlcfFBteqNDlR2uFInIECAwEAAQ==
 -----END PUBLIC KEY-----
 ```