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

updated readme

Browse Source
This commit is contained in:
Scott E. Graves 2024-09-25 07:33:56 -05:00
parent 868e8ae124
commit ca4111ac77
2 changed files with 28 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.cspell/words.txt
View File

@ -136,6 +136,7 @@ linkflags
mbig mbig
msvc msvc
msvcr120 msvcr120
msys2
mtune mtune
nana nana
ncrypt ncrypt
@ -148,6 +149,7 @@ oleaut32
openal_version openal_version
openssldir openssldir
pkgconfig pkgconfig
plex
project_enable_fontconfig project_enable_fontconfig
project_enable_gtkmm project_enable_gtkmm
project_enable_libdsm project_enable_libdsm
@ -160,6 +162,7 @@ puint32
pvoid pvoid
pwstr pwstr
remote_winfsp remote_winfsp
renterd
richtext richtext
rocksdb_library rocksdb_library
rpcrt4 rpcrt4

27
README.md
View File

@ -1,6 +1,6 @@
# Repertory # 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. on Windows.
## Details and Features ## Details and Features
@ -8,9 +8,9 @@ on Windows.
* 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 AWS S3 and/or Sia
* Only 1 Sia mount and 1 S3 mount (per bucket) per user is supported. * 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) * 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 ## Minimum Requirements
@ -29,6 +29,27 @@ on Windows.
* ~~OS X Mojave and above~~ * ~~OS X Mojave and above~~
* Windows 64-bit 10, 11 * Windows 64-bit 10, 11
## Compiling
* Successful compilation will result in all required files being placed in the `dist/` directory
* Linux
* Ensure `docker` is installed
* For x86_64:
* Release: `scripts/make_unix.sh x86_64`
* Debug: `scripts/make_unix.sh x86_64 debug`
* For aarch64:
* Release: `scripts/make_unix.sh aarch64`
* Debug: `scripts/make_unix.sh aarch64 debug`
* Windows
* RECOMMENDED: Cross-compiling on Linux
* Ensure `docker` is installed
* Release: `scripts/make_win32.sh`
* Debug: `scripts/make_win32.sh debug`
* Compiling on Windows
* Ensure latest [MSYS2](https://www.msys2.org/) is installed
* Release: `scripts/make_win32.cmd`
* Debug: `scripts/make_win32.cmd debug`
## Credits ## Credits
* [boost c++ libraries](https://www.boost.org/) * [boost c++ libraries](https://www.boost.org/)