This commit is contained in:
Brock H Caldwell
202
README.md
202
README.md
@@ -4,28 +4,6 @@ and download your favorite movies and tv shows. You can think of it like Stremio
|
||||
comparison to Stremio? That's because Torsearch uses the same source for media files that Stremio uses: Torrentio
|
||||
(hence the name: Torsearch).
|
||||
|
||||
After two failed attempts at running a media server, I decided to hang up my hat and give up my dream of a self-hosted
|
||||
media server. I figured the days of torrenting were mostly over and everybody ranting & raving about their media collections
|
||||
must be going to Walmart and buying up the bucket of old movies they have. That's until I stumbled across Stremio.
|
||||
|
||||
At first, it seemed too good to be true, but I was yearning for something just sketchy enough to try out. What could
|
||||
go wrong with handing over my card information to an unknown organization across the pond? At the end of the day,
|
||||
the cost benefit analysis landed in my favor, and about 30 minutes after purchasing my Real Debrid subscription and
|
||||
setting up Stremio, I was in business.
|
||||
|
||||
My mind was blown. I might not have the most "cultured" taste in media, but it had everything I searched for and more! After
|
||||
watching a few movies, I noticed the "Copy Download Link" button. "What's this lil guy do?" I asked myself. Duh, it
|
||||
downloads the f*****g movie. And there's the 💡flashing over my head. There's gotta be a way to automate this, I told myself.
|
||||
|
||||
After a month of studying Stremio's code and lots of tinkering, I finally figured it out. Torrentio is the magic behind
|
||||
the scenes. You feed it a Real Debrid API key and an IMDB ID, and it gives you a list of results to download that media.
|
||||
Easy peasy.
|
||||
|
||||
In about an hour I had a proof of concept working. It wasn't pretty, but it wasn't supposed to be. That proof-of-concept
|
||||
has blossomed into the beautiful Torsearch that I've been using nearly every day since then. The code in this repo
|
||||
is a complete re-write of the proof-of-concept that started out ugly and ended up even uglier. Knowing the core functionality
|
||||
required to make it work, I was able to re-write the app with some design patterns in place.
|
||||
|
||||
## Pics or didn't happen
|
||||
|
||||
|
||||
@@ -37,14 +15,180 @@ required to make it work, I was able to re-write the app with some design patter
|
||||
- Search for Movies & TV Shows by their name
|
||||
- Download directly to your NAS
|
||||
- Monitor TV Shows for new episodes and automatically download them
|
||||
- Browse popular media and view its download options
|
||||
- LDAP or local auth (OIDC coming soon)
|
||||
- Discover new media
|
||||
- OIDC
|
||||
|
||||
## Features on the roadmap
|
||||
- Requests - allow users to request new media
|
||||
- OIDC auth
|
||||
- Prometheus logging
|
||||
|
||||
## Getting Started
|
||||
1. Clone the repo
|
||||
1. Create a `compose.yml` file
|
||||
```yaml
|
||||
services:
|
||||
### The app contains the application and web server ###
|
||||
app:
|
||||
image: code.caldwell.digital/home/torsearch-app:${TAG}
|
||||
ports:
|
||||
- "${WEB_PORT}:80"
|
||||
env_file: .env
|
||||
depends_on:
|
||||
database:
|
||||
condition: service_healthy
|
||||
volumes:
|
||||
- ${LOCAL_MOVIES_DIR}:/var/download/movies
|
||||
- ${LOCAL_TVSHOWS_DIR}:/var/download/tvshows
|
||||
- mercure_data:/data
|
||||
- mercure_config:/config
|
||||
|
||||
|
||||
### The worker handles downloads and async jobs ###
|
||||
worker:
|
||||
image: code.caldwell.digital/home/torsearch-worker:${TAG}
|
||||
volumes:
|
||||
- ${LOCAL_MOVIES_DIR}:/var/download/movies
|
||||
- ${LOCAL_TVSHOWS_DIR}:/var/download/tvshows
|
||||
env_file: .env
|
||||
depends_on:
|
||||
- app
|
||||
|
||||
|
||||
### The scheduler processes monitored media ###
|
||||
scheduler:
|
||||
image: code.caldwell.digital/home/torsearch-scheduler:${TAG}
|
||||
volumes:
|
||||
- ${LOCAL_MOVIES_DIR}:/var/download/movies
|
||||
- ${LOCAL_TVSHOWS_DIR}:/var/download/tvshows
|
||||
env_file: .env
|
||||
depends_on:
|
||||
- app
|
||||
|
||||
|
||||
#!! If using your own database, this can be omitted !!#
|
||||
database:
|
||||
image: mariadb:10.11.2
|
||||
volumes:
|
||||
- mysql:/var/lib/mysql
|
||||
env_file: .env
|
||||
healthcheck:
|
||||
test: ["CMD", "mysqladmin", "ping"]
|
||||
interval: 5s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
|
||||
|
||||
#!! If using your own redis, this can be omitted !!#
|
||||
redis:
|
||||
image: redis:latest
|
||||
volumes:
|
||||
- redis_data:/data
|
||||
command: redis-server --maxmemory 512MB
|
||||
restart: unless-stopped
|
||||
|
||||
|
||||
volumes:
|
||||
mysql:
|
||||
mercure_config:
|
||||
mercure_data:
|
||||
redis_data:
|
||||
|
||||
```
|
||||
|
||||
2. Create a `.env` file
|
||||
```dotenv
|
||||
###################
|
||||
# Torsearch #
|
||||
###################
|
||||
# The version of Torsearch to run. Docker will this tag.
|
||||
TAG=latest
|
||||
|
||||
# The port for which the web server (app container) will
|
||||
# serve the application on the host.
|
||||
WEB_PORT=8004
|
||||
|
||||
# The host directories where your media is stored.
|
||||
# If you would like to use a docker driver for a network
|
||||
# share, update the compose.yml file to reflect that.
|
||||
# These are passed into the compose file as bind mounts.
|
||||
LOCAL_MOVIES_DIR="./movies"
|
||||
LOCAL_TVSHOWS_DIR="./tvshows"
|
||||
|
||||
# Set the timezone you're in. This helps render monitored items correctly on the calendar
|
||||
TZ=America/Chicago
|
||||
|
||||
###################
|
||||
# Symfony #
|
||||
###################
|
||||
# The external URL of the application where it can be reached by a browser.
|
||||
APP_URL="<enter url>"
|
||||
# Requried by Symfony Framework. Feel free to change.
|
||||
APP_SECRET="70169beadfbc8101c393cbfbba27a313"
|
||||
# Change to 'dev' to show logs in the browser.
|
||||
APP_ENV=prod
|
||||
|
||||
|
||||
###################
|
||||
# Mercure #
|
||||
###################
|
||||
# Mercure is a Caddy module built into the webserver
|
||||
# that facilitates the usage of websockets to transmit
|
||||
# real time data (download progress, etc.)
|
||||
# TBH, I've only run into issues when changing these. If
|
||||
# you have problems after changing them, just revert them.
|
||||
MERCURE_JWT_SECRET="!ChangeThisMercureHubJWTSecretKey!"
|
||||
MERCURE_PUBLISHER_JWT_KEY="!ChangeThisMercureHubJWTSecretKey!"
|
||||
MERCURE_SUBSCRIBER_JWT_KEY="!ChangeThisMercureHubJWTSecretKey!"
|
||||
|
||||
|
||||
###################
|
||||
# Database #
|
||||
###################
|
||||
# Use the DATABASE_URL below to use the MariaDB container
|
||||
# provided in the example.compose.yml file, or remove this
|
||||
# line and fill in the details of your own MySQL/MariaDB server
|
||||
MYSQL_USER=app
|
||||
MYSQL_PASSWORD="P@ssword123"
|
||||
MYSQL_DATABASE=app
|
||||
MYSQL_HOST=database
|
||||
MYSQL_RANDOM_ROOT_PASSWORD=true
|
||||
DATABASE_URL="mysql://${MYSQL_USER}:${MYSQL_PASSWORD}@${MYSQL_HOST}:3306/${MYSQL_DATABASE}?serverVersion=10.11.2-MariaDB&charset=utf8mb4"
|
||||
|
||||
|
||||
###################
|
||||
# Real Debrid #
|
||||
###################
|
||||
# Enter your Real Debrid API key is passed to Torrentio to retrieve download options
|
||||
REAL_DEBRID_KEY="<enter real debrid api key>"
|
||||
|
||||
|
||||
###################
|
||||
# Redis #
|
||||
###################
|
||||
# Use your own Redis instance or use the below value to use the
|
||||
# container included in the example compose.yml file.
|
||||
REDIS_HOST="redis://redis"
|
||||
|
||||
|
||||
###################
|
||||
# Auth #
|
||||
###################
|
||||
# Options: form_login, oidc, or ldap (experimental)
|
||||
# Fill the rest of the configuration based on your choice here
|
||||
# No additional config is required for form_login
|
||||
AUTH_METHOD=form_login
|
||||
|
||||
|
||||
### OIDC ###
|
||||
# To use OIDC, set the AUTH_METHOD to oidc and fill in the following properties
|
||||
#OIDC_WELL_KNOWN_URL=
|
||||
#OIDC_CLIENT_ID=
|
||||
#OIDC_CLIENT_SECRET=
|
||||
# Allows you to skip the login page and directly rely on your IdP for auth.
|
||||
#OIDC_BYPASS_FORM_LOGIN=
|
||||
|
||||
```
|
||||
|
||||
3. Run `docker compose up -d`
|
||||
4. Visit the app in the browser
|
||||
5. Create your first user
|
||||
6. Visit the Preferences page to set your filter. This filter is used whenever you don't choose a specific file to
|
||||
download (e.g. downloading via Monitor or clicking the "Download Season", "Download Selected", or "Download Episode" buttons).
|
||||
7. Start downloading media!
|
||||
|
||||
|
||||
@@ -1,40 +0,0 @@
|
||||
services:
|
||||
app:
|
||||
image: registry.caldwell.digital/home/torsearch-app:${TAG}
|
||||
ports:
|
||||
- "${SWARM_PORT}:80"
|
||||
environment:
|
||||
MERCURE_PUBLISHER_JWT_KEY: '!ChangeThisMercureHubJWTSecretKey!'
|
||||
MERCURE_SUBSCRIBER_JWT_KEY: '!ChangeThisMercureHubJWTSecretKey!'
|
||||
deploy:
|
||||
replicas: 2
|
||||
volumes:
|
||||
- /mnt/media/downloads/movies:/var/download/movies
|
||||
- /mnt/media/downloads/tvshows:/var/download/tvshows
|
||||
- mercure_data:/data
|
||||
- mercure_config:/config
|
||||
|
||||
|
||||
worker:
|
||||
image: registry.caldwell.digital/home/torsearch-worker:${TAG}
|
||||
volumes:
|
||||
- /mnt/media/downloads/movies:/var/download/movies
|
||||
- /mnt/media/downloads/tvshows:/var/download/tvshows
|
||||
deploy:
|
||||
replicas: 2
|
||||
depends_on:
|
||||
- app
|
||||
|
||||
|
||||
scheduler:
|
||||
image: registry.caldwell.digital/home/torsearch-scheduler:${TAG}
|
||||
volumes:
|
||||
- /mnt/media/downloads/movies:/var/download/movies
|
||||
- /mnt/media/downloads/tvshows:/var/download/tvshows
|
||||
depends_on:
|
||||
- app
|
||||
|
||||
|
||||
volumes:
|
||||
mercure_config:
|
||||
mercure_data:
|
||||
Reference in New Issue
Block a user