updated README.md

.cspell/words.txt

@@ -140,10 +140,12 @@ libuuid
 libuuid_include_dirs
 libvlc
 linkflags
+localappdata
 lptr
 lpwstr
 markdownlint
 mbig
+minio
 msvc
 msvcr120
 msys2
@@ -200,6 +202,7 @@ stduuid_project
 strequal
 ularge_integer
 uring
+url
 userenv
 utimens_impl
 utimensat

README.md

@@ -8,7 +8,7 @@ on Windows.
 * 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)
+  * Securely share your mounts over TCP/IP (`XChaCha20-Poly1305` stream cipher) with other systems on your network or the internet.
 * Cross-platform support (Linux 64-bit, Linux arm64/aarch64, ~~OS X,~~ Windows 64-bit)
 
 ## Minimum Requirements
@@ -44,28 +44,73 @@ on Windows.
     * 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.
+  * Sets the Sia bucket name to mount.
   * Can be used in combination with `--name` to target a unique configuration.
 * `-set S3Config.Bucket`
-  * S3 bucket name for the mount.
+  * Sets the S3 bucket name to mount.
   * Must be used in combination with `--name` to target a unique configuration.
   * Must be used in combination with `-s3`.
 
-### Sia
+### Data Directories
 
 * Linux
+  * `~/.local/repertory2`
+* Windows
+  * `%LOCALAPPDATA%\repertory2`
+    * i.e. `C:\\Users\\Tom\\AppData\\Local\\repertory2`
+
+### 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 all configuration options:
+    * `repertory -dc` or `repertory --name '<my config name>' -dc`
+* Mounting on Linux:
   * `repertory /mnt/location`
   * `repertory --name default /mnt/location`
-* Windows
+* Mounting on Windows:
-  * `repertory.exe t:`
+  * `repertory t:`
-  * `repertory.exe --name default t:`
+  * `repertory --name default t:`
 
 ### S3
 
-* Linux 
+* Initial Configuration
-  * `repertory --name storj -s3 /mnt/location`
+  * S3 steps:
-* Windows
+    * Set the appropriate bucket name:
-  * `repertory.exe --name storj -s3 t:`
+      * `repertory --name '<my config name>' -set S3Config.Bucket '<my bucket name>'`
+    * Set the appropriate base URL:
+      * `repertory --name '<my config name>' -set S3Config.URL '<my url>'`
+        * i.e. `repertory --name minio -set S3Config.URL 'http://localhost:9000'`
+    * Set the appropriate access key:
+      * `repertory --name '<my config name>' -set S3Config.AccessKey '<my access key>'`
+    * Set the appropriate secret key:
+      * `repertory --name '<my config name>' -set S3Config.SecretKey '<my secret key>'`
+    * For Sia and most local S3 gateway instances, enable path style URL's:
+      * `repertory --name '<my config name>' -set S3Config.UsePathStyle true`
+    * Optionally, set the appropriate region. Default is set to `any`: 
+      * `repertory --name '<my config name>' -set S3Config.Region '<my region>'`
+    * Optionally, to enable encrypted file names and file data, set a strong, random encryption token:
+      * `repertory --name '<my config name>' -set S3Config.EncryptionToken '<my strong password>'`
+  * To verify all configuration options:
+    * `repertory -dc` or `repertory --name '<my config nam>' -dc`
+* Mounting on Linux:
+  * `repertory -s3 --name '<my config name>' /mnt/location`
+* Mounting on Windows:
+  * `repertory -s3 --name '<my config name>' t:`
+
+## Remote Mounting
+
+`Repertory` allows local mounts to be shared with other computers on your network. This option is referred to as remote mounting. 
+Instructions TBD.
 
 ## Compiling