Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mplewis/coaxist

Single Docker container for running Plex with a Debrid service.
https://github.com/mplewis/coaxist

Last synced: about 2 months ago
JSON representation

Single Docker container for running Plex with a Debrid service.

Awesome Lists containing this project

README 

        
Text that says Coaxist over a sprawling heap of computer equipment on a rainbow-colored floor, generated by SDXL 1.0. Positive prompt: A brightly colored stylized digital illustration for a magazine cover. The camera is placed at an isometric angle. In a brightly-lit outdoor space, piles of computer monitors, televisions, and server racks are stacked on top of each other. Brightly-colored bundles of rainbow ethernet cables connect the displays and the server racks. Circuit traces are visible everywhere. The entire image is covered in a smooth rainbow gradient.



Coaxist is a self-hosted Docker container that makes it easy to watch your

favorite movies and TV shows on demand. Connect to your Debrid provider, add

content to your watchlist, and it appears in your Plex library in minutes.



[![Docker Hub: mplewis/coaxist](https://img.shields.io/badge/Docker%20Hub-mplewis%2Fcoaxist-blue?logo=docker)](https://hub.docker.com/r/mplewis/coaxist/tags)



# Get Started



```sh

docker run \

  --device /dev/fuse:/dev/fuse \

  --cap-add SYS_ADMIN \

  --mount type=bind,source="/home/myuser/coaxist/config,target=/config" \

  --mount type=bind,source="/home/myuser/coaxist/transcode,target=/transcode" \

  -p 5055:5055 \

  -p 32400:32400 \

  --name "coaxist" \

  --restart always \

  --detach \

  mplewis/coaxist:latest

```



For detailed instructions, see the [Quick Start](docs/quick-start.md) guide.



# Tech Stack



System Diagram



Coaxist is a **single Docker container** containing:



- [**Plex**](https://plex.tv): Excellent server for self-hosting media. Plex has

  high-quality native apps for TV boxes, mobile devices, and desktop.

- [**Overseerr**](https://overseerr.dev): Request management software for Plex

  which doubles as an excellent server for media metadata.

- [**Rclone**](https://rclone.org/): Mounts WebDAV directories locally so that

  Plex can stream media files without copying them to local storage.

- [**Connector**](connector/README.md): Watches for media requests from

  Overseerr, searches for media sources using Torrentio, and sends selected

  torrents to a Debrid service for download.



Coaxist uses the following public cloud services:



- [**Torrentio**](https://torrentio.strem.fun/configure): Searches for media

  sources on torrent sites and converts magnet links to Debrid request links.

- **Debrid**: A paid service which downloads torrents and serves their contents.



# FAQ



## I'm having trouble running Coaxist. Can you help me?



Please try the following first and see if you notice anything:



- Review the [Quick Start](docs/quick-start.md) guide from top to bottom.

- Look for relevant messages in the container logs.

- Run the Coaxist container with the `LOG_LEVEL=debug` environment variable set

  (Docker flag: `-e LOG_LEVEL=debug`) and look for relevant messages at the

  debug level.



If you're still having trouble, I can provide limited support via GitHub Issues.

[Open an issue](https://github.com/mplewis/coaxist/issues/new/choose) and I'll

do my best to help.



## How long does it take for media that I request to appear in Plex?



Connector scans for new requests every 15 seconds by default. When it finds a

new request, it immediately starts searching for content.



The Debrid service can vary – if the content is cached, it might appear in your

user directory in seconds, but uncached content must be downloaded from the

torrent swarm.



I recommend setting your Plex server to scan its library as frequently as

possible to ensure it finds your new Debrid content quickly. See the

[Quick Start](docs/quick-start.md#enable-periodic-scan) guide.



## What is a Debrid service?



A Debrid service is a paid commercial subscription service that works in a way

similar to a hosted seedbox. This service takes a torrent file, magnet link, or

link to a file hosting service such as Mediafire. It downloads the content to

its own servers, then makes the content available to the subscriber.



Many providers support "instant" downloads, where content you request is

immediately copied into your storage if another subscriber has requested it in

the past. In Coaxist, we tag these results as `cached`, and you can prefer these

results in your [Media Profile](docs/profiles.md#tags).



## Where does the media come from?



Coaxist uses [Torrentio](https://github.com/TheBeastLT/torrentio-scraper) to

search

[public torrent trackers](https://github.com/TheBeastLT/torrentio-scraper/blob/d89ff904758d71172a406e73efe7acbef41f4860/addon/lib/magnetHelper.js)

for requested media.



## What am I connecting to exactly?



Coaxist uses a Debrid service to access all media. When downloading through a

Debrid service, the Debrid service is connecting to the P2P torrent swarm and

downloading files on your behalf. You connect directly to the Debrid service to

access this content.



## What does my ISP see?



Your ISP may be able to see that you are searching public torrent trackers or

connecting to the Debrid service.



## Is this legal and safe to use?



This software is provided as-is. I make no guarantees or warranties about

legality or safety. You are responsible for understanding if use of this

software is legal to use in your jurisdiction and compatible with your personal

risk profile.