hpz937/zurg
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Ben Adrian Sarmiento
2024-07-12 13:33:03 +02:00
parent 7509f0fa59
commit fded8ee8aa
1 changed files with 19 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -2,29 +2,39 @@
A self-hosted Real-Debrid webdav server written from scratch. Together with [rclone](https://rclone.org/) it can mount your Real-Debrid torrent library into your file system like Dropbox. It's meant to be used with Infuse (webdav server) and Plex (mount zurg webdav with rclone). A self-hosted Real-Debrid webdav server written from scratch. Together with [rclone](https://rclone.org/) it can mount your Real-Debrid torrent library into your file system like Dropbox. It's meant to be used with Infuse (webdav server) and Plex (mount zurg webdav with rclone).
[Are you looking for the source code?](https://github.com/debridmediamanager/zurg-testing/issues/53)
## Download ## Download
### Latest version: v0.10.0-rc.2 [Release Cycle](https://github.com/debridmediamanager/zurg-testing/wiki/Release-cycle)
### Latest version: 2024.07.12-nightly (Sponsors only)
[Download the binary](https://github.com/debridmediamanager/zurg/releases) or use docker [Download the binary](https://github.com/debridmediamanager/zurg/releases) or use docker
```sh ```sh
docker pull ghcr.io/debridmediamanager/zurg:latest docker pull ghcr.io/debridmediamanager/zurg:latest
# or # or
docker pull ghcr.io/debridmediamanager/zurg:v0.10.0-rc.2 docker pull ghcr.io/debridmediamanager/zurg:2024.07.12-nightly
```
### Stable version: v0.9.3-hotfix.11 (Public)
[Download the binary](https://github.com/debridmediamanager/zurg-testing/releases) or use docker
```sh
docker pull ghcr.io/debridmediamanager/zurg-testing:latest
# or
docker pull ghcr.io/debridmediamanager/zurg-testing:v0.9.3-hotfix.11
``` ```
## How to run zurg in 5 steps for Plex with Docker ## How to run zurg in 5 steps for Plex with Docker
1. Clone this repo `git clone https://github.com/debridmediamanager/zurg.git` 1. Clone the repo `git clone https://github.com/debridmediamanager/zurg-testing.git` or `git clone https://github.com/debridmediamanager/zurg.git`
2. Add your token in `config.yml` 2. Add your token in `config.yml`
3. `sudo mkdir -p /mnt/zurg` 3. `sudo mkdir -p /mnt/zurg`
4. Run `docker compose up -d` 4. Run `docker compose up -d`
5. `time ls -1R /mnt/zurg` You're done! If you do edits on your config.yml just do `docker compose restart zurg`. 5. `time ls -1R /mnt/zurg` You're done! If you do edits on your config.yml just do `docker compose restart zurg`.
A webdav server is also exposed to your localhost via port `9999`. A web server is now running at `localhost:9999`.
### Note: when using zurg in a server outside of your home network, ensure that "Use my Remote Traffic automatically when needed" is unchecked on your [Account page](https://real-debrid.com/account) ### Note: when using zurg in a server outside of your home network, ensure that "Use my Remote Traffic automatically when needed" is unchecked on your [Account page](https://real-debrid.com/account)
@@ -53,7 +63,7 @@ Use "zurg [command] --help" for more information about a command.
## Why zurg? Why not X? ## Why zurg? Why not X?
- Better performance than anything out there; changes in your library appear instantly ([assuming Plex picks it up fast enough](./plex_update.sh)) - Better performance than anything out there; changes in your library appear instantly ([assuming Plex picks it up fast enough](./plex_update.sh))
- You can configure a flexible directory structure in `config.yml`; you can select individual torrents that should appear on a directory by the ID you see in [DMM](https://debridmediamanager.com/). [Need help?](https://github.com/debridmediamanager/zurg/wiki/Config) - You can configure a flexible directory structure in `config.yml`; you can select individual torrents that should appear on a directory by the ID you see in [DMM](https://debridmediamanager.com/). [Need help?](https://github.com/debridmediamanager/zurg-testing/wiki/Config)
- If you've ever experienced Plex scanner being stuck on a file and thereby freezing Plex completely, it should not happen anymore because zurg does a comprehensive check if a torrent is dead or not. You can run `ps aux --sort=-time | grep "Plex Media Scanner"` to check for stuck scanner processes. - If you've ever experienced Plex scanner being stuck on a file and thereby freezing Plex completely, it should not happen anymore because zurg does a comprehensive check if a torrent is dead or not. You can run `ps aux --sort=-time | grep "Plex Media Scanner"` to check for stuck scanner processes.
- zurg guarantees that your library is **always available** because of its repair abilities! - zurg guarantees that your library is **always available** because of its repair abilities!
@@ -69,8 +79,7 @@ Use "zurg [command] --help" for more information about a command.
## Service Providers ## Service Providers
- [ElfHosted](https://elfhosted.com) - Easy, [open source](https://elfhosted.com/open/), Kubernetes / GitOps driven hosting of popular self-hosted apps - tested, tightly integrated, and secured. Apps start at $0.05/day, and new accounts get $10 credit, no commitment. - [ElfHosted](https://elfhosted.com) - Easy, [open source](https://elfhosted.com/open/), Kubernetes / GitOps driven hosting of popular self-hosted apps - tested, tightly integrated, and secured. Apps start at $0.05/day, and new accounts get $10 credit, no commitment.
- [zurg.club](http://zurg.club/) - optimized Plex+zurg server setup for $50/month
## Please read our [wiki](https://github.com/debridmediamanager/zurg/wiki) for more information! ## Please read our [wiki](https://github.com/debridmediamanager/zurg-testing/wiki) for more information!
## [zurg's version history](https://github.com/debridmediamanager/zurg/wiki/History) ## [zurg's version history](https://github.com/debridmediamanager/zurg-testing/wiki/History)