diff --git a/CHANGELOG.md b/CHANGELOG.md index 9e1b1bbc..50a6f6f3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ ### Issues +* \#34 Add macOS support * \#51 [ui] UI console window should close after launch * \#53 Create Windows installer * \#54 Remove 'default' as initial bucket name for Sia diff --git a/README.md b/README.md index 6dce6bf1..10f9198c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Repertory -Repertory allows you to mount S3 and Sia via FUSE on Linux or via WinFSP +Repertory allows you to mount S3 and Sia via FUSE on Linux/OS X or via WinFSP on Windows. ## Contents @@ -38,15 +38,17 @@ on Windows. ## Details and Features * Optimized for [Plex Media Server](https://www.plex.tv/) -* Remote mounting of `repertory` instances on Linux and Windows +* Remote mounting of `repertory` instances between Linux, OS X, and/or 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) +* Cross-platform support (Linux, OS X, and Windows) * Optionally encrypt file names and file data via `XChaCha20-Poly1305` in S3 mounts ## Minimum Requirements * [Sia renterd](https://github.com/SiaFoundation/renterd/releases) v2.0.0+ for Sia support * Linux requires `fusermount3`; otherwise, `repertory` must be manually compiled with `libfuse2` support +* OS X requires the following dependencies to be installed: + * [macFUSE 4.10-2](https://github.com/macfuse/macfuse/releases/download/macfuse-4.10.2/macfuse-4.10.2.dmg) * Windows requires the following dependencies to be installed: * [WinFSP 2025](https://github.com/winfsp/winfsp/releases/download/v2.1/winfsp-2.1.25156.msi) @@ -55,12 +57,14 @@ on Windows. Only 64-bit operating systems are supported * Linux `arm64/aarch64` -* Linux `amd64` -* Windows 64-bit 10, 11 +* Linux `x86-64` +* OS X `arm64/aarch64` +* OS X `x86-64` +* Windows `x86-64` 10, 11 ## GUI -As of `v2.0.5-rc`, mounts can be managed using the `Repertory Management Portal`. +As of `v2.0.6-release`, mounts can be managed using the `Repertory Management Portal`. To launch the portal, execute the following command: * `repertory -ui` @@ -434,6 +438,7 @@ in the `dist/` directory * [libexpat](https://github.com/libexpat/libexpat) * [libfuse](https://github.com/libfuse/libfuse) * [libsodium](https://doc.libsodium.org/) +* [macFUSE](https://macfuse.github.io/) * [mingw-w64](https://www.mingw-w64.org/) * [MSYS2](https://www.msys2.org) * [OpenSSL](https://www.openssl.org/)