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

https://github.com/pablopunk/notflix

Files to run a media server at home. All legal stuff.
https://github.com/pablopunk/notflix

Last synced: 3 months ago
JSON representation

Files to run a media server at home. All legal stuff.

Awesome Lists containing this project

README

          

# Notflix. Your media server

> Educational purposes only.

This project allows users to stream their own media files and automate
downloads of TV shows and movies with a BitTorrent client.
[Here's how it works](#how-the-f-does-this-work).

## Installation

Before installing the project, ensure that you have the following dependencies installed:

- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)

To install the project, follow these steps:

1. Clone the repository to your local machine.

``` bash
git clone https://github.com/pablopunk/notflix && cd notflix
```

2. Copy the example `.env` file and modify it to fit your needs:

``` bash
cp .env.example .env
```

3. Build and run all the images:

``` bash
docker-compose up -d
```

## Usage

Once the project is installed and running, you can access the following services at the specified ports:

| Service | Port |
|------------------|--------|
| Jellyfin | 8096 |
| Overseerr | 5055 |
| Sonarr | 8989 |
| Radarr | 7878 |
| Bazarr | 6767 |
| Jackett | 9117 |
| Transmission | 9091 |

To link containers, e.g. **Overseerr+Sonarr**, in the Overseerr configuration you can
specify the **container name** instead of the host IP: `http://sonarr:8989`.

- **Jellyfin**: Like Netflix for your own media files. You can also use Plex, it's basically the same.
- **Overseerr**: Allows users to request new shows/movies to be
downloaded.
- **Sonarr**: Monitors multiple RSS feeds for new episodes of TV shows
and will grab, sort and rename them.
- **Radarr**: Monitors multiple RSS feeds for new movies and will
grab, sort and rename them.
- **Bazarr**: Automatically download subtitles in your desired languages.
- **Jackett**: To find torrent trackers.
- **Transmission**: BitTorrent client.

## How the f does this work

### Big picture

![small](./diagram-small.png)

### Detailed version

![full](./diagram-full.png)

## Troubleshooting

If you encounter any issues while installing or using the media server, try the following solutions:

- Check that all dependencies are installed correctly.
- Ensure that the `.env` file is configured correctly.
- Check the logs of the Docker containers (in portainer, port 9000) for any error messages.

## License

MIT License