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

Complete initial v2.0 documentation #33
All checks were successful
BlockStorage/repertory/pipeline/head This commit looks good
Details

Browse Source
This commit is contained in:
Scott E. Graves 2025-02-22 19:59:22 -06:00
parent f41ad47262
commit 521874a56f
1 changed files with 116 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

189
README.md
View File

@ -30,28 +30,45 @@ on Windows.
### Sia ### Sia
* Initial Configuration #### Initial Configuration
* Sia steps:
* Set the appropriate bucket name and `renterd` API password in `repertory` configuration: * Required steps:
* To use `default` as the bucket name and configuration name: * Set the appropriate bucket name and `renterd` API password in `repertory` configuration:
* `repertory -set HostConfig.ApiPassword '<my password>'` * To use `default` as the bucket name and configuration name, you only need to set the `renterd` API password:
* To use a different bucket name with `default` as the configuration name: * `repertory -set HostConfig.ApiPassword '<my password>'`
* `repertory -set HostConfig.ApiPassword '<my password>'` * To specify a different bucket name while using `default` as the configuration name:
* `repertory -set SiaConfig.Bucket '<my bucket>'` * `repertory -set HostConfig.ApiPassword '<my password>'`
* For all other configurations: * `repertory -set SiaConfig.Bucket '<my bucket>'`
* `repertory --name '<my config name>' -set HostConfig.ApiPassword '<my password>'` * For all other configurations:
* `repertory --name '<my config name>' -set SiaConfig.Bucket '<my bucket name>'` * `repertory --name '<my config name>' -set HostConfig.ApiPassword '<my password>'`
* To verify/view all configuration options: * `repertory --name '<my config name>' -set SiaConfig.Bucket '<my bucket name>'`
* `repertory -dc`
* `repertory --name '<my config name>' -dc` * Optional steps:
* Example: * Set a custom user name used for basic authentication:
* `repertory --name default -dc` * `repertory -set HostConfig.ApiUser '<my user>'`
* Mounting on Linux: * `repertory --name '<my config name>' -set HostConfig.ApiUser '<my user>'`
* Set the `renterd` API port to a value other than `9980`:
* `repertory -set HostConfig.ApiPort 9981`
* `repertory --name '<my config name>' -set HostConfig.ApiPort 9981`
* Set a custom agent string:
* `repertory -set HostConfig.AgentString '<my agent>'`
* `repertory --name '<my config name>' -set HostConfig.AgentString '<my agent>'`
* To verify/view all configuration options:
* `repertory -dc`
* `repertory --name '<my config name>' -dc`
* Example:
* `repertory --name default -dc`
#### Mounting
* Linux:
* `repertory /mnt/location` * `repertory /mnt/location`
* `repertory --name '<my config name>' /mnt/location` * `repertory --name '<my config name>' /mnt/location`
* Example: * Example:
* `repertory --name default /mnt/location` * `repertory --name default /mnt/location`
* Mounting on Windows:
* Windows:
* `repertory t:` * `repertory t:`
* `repertory --name '<my config name>' t:` * `repertory --name '<my config name>' t:`
* Example: * Example:
@ -59,47 +76,61 @@ on Windows.
### S3 ### S3
* Initial Configuration <!-- markdownlint-disable-next-line -->
* S3 steps: #### Initial Configuration
* Set the appropriate base URL:
* `repertory -s3 --name '<my config name>' -set S3Config.URL '<my url>'` * Required steps:
* Example: * Set the appropriate base URL:
* `repertory -s3 --name minio -set S3Config.URL 'http://localhost:9000'` * `repertory -s3 --name '<my config name>' -set S3Config.URL '<my url>'`
* 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: * Example:
* `repertory -s3 --name minio -dc` * `repertory -s3 --name minio -set S3Config.URL 'http://localhost:9000'`
* Mounting on Linux: * 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`
<!-- markdownlint-disable-next-line -->
#### Mounting
* Linux:
* `repertory -s3 --name '<my config name>' /mnt/location` * `repertory -s3 --name '<my config name>' /mnt/location`
* Example: * Example:
* `repertory -s3 --name minio /mnt/location` * `repertory -s3 --name minio /mnt/location`
* Mounting on Windows:
* Windows:
* `repertory -s3 --name '<my config name>' t:` * `repertory -s3 --name '<my config name>' t:`
* Example: * Example:
* `repertory -s3 --name minio t:` * `repertory -s3 --name minio t:`
### Notable Options ### Common Options
* `--help` * `--help`
* Display all mount utility options * Display all mount utility options
* `-f`
* Keep process in foreground on Linux.
* `--name, -na [name]` * `--name, -na [name]`
* The `--name` option can be set to any valid value allowed as a file name for your filesystem. * 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. * 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. * 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. * For S3, the `--name` option is required and does not affect the bucket name.
* `-dc` * `-dc`
* Display mount configuration * Display mount configuration
* For Sia, `--name` is optional * For Sia, `--name` is optional
@ -107,15 +138,18 @@ on Windows.
### Data Directories ### Data Directories
* Linux #### Linux
* `~/.local/repertory2`
* Windows * `~/.local/repertory2`
* `%LOCALAPPDATA%\repertory2`
* Example: #### Windows
* `C:\Users\Tom\AppData\Local\repertory2`
* IMPORTANT: * `%LOCALAPPDATA%\repertory2`
* It is highly recommended to exclude this folder from any anti-virus/anti-malware applications as severe performance issues may arise. * Example:
* Excluding the mounted drive letter is also highly recommended. * `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.
## Remote Mounting ## Remote Mounting
@ -124,28 +158,37 @@ This option is referred to as remote mounting. Instructions TBD.
## Compiling ## Compiling
* Successful compilation will result in all required files being placed in the `dist/` directory Successful compilation will result in all files required for execution to be placed
* Linux in the `dist/` directory
<!-- markdownlint-disable-next-line -->
### 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`
<!-- markdownlint-disable-next-line -->
### Windows
* OFFICIAL: Cross-compiling on Linux
* Ensure `docker` is installed * Ensure `docker` is installed
* For x86_64: * RelWithDebInfo: `scripts/make_win32.sh`
* RelWithDebInfo: `scripts/make_unix.sh` * Release: `scripts/make_win32.sh x86_64 Release`
* Release: `scripts/make_unix.sh x86_64 Release` * Debug: `scripts/make_win32.sh x86_64 Debug`
* Debug: `scripts/make_unix.sh x86_64 Debug`
* For aarch64: * UNOFFICIAL: Compiling on Windows
* RelWithDebInfo: `scripts/make_unix.sh aarch64` * Ensure latest [MSYS2](https://www.msys2.org/) is installed
* Release: `scripts/make_unix.sh aarch64 Release` * RelWithDebInfo: `scripts\make_win32.cmd`
* Debug: `scripts/make_unix.sh aarch64 Debug` * Release: `scripts\make_win32.cmd x86_64 Release`
* Windows * Debug: `scripts\make_win32.cmd x86_64 Debug`
* 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 ## Credits