Skip to content

README.md

Latest commit

 

History

History
160 lines (125 loc) · 4.65 KB

README.md

File metadata and controls

160 lines (125 loc) · 4.65 KB

Make Movies API

.NET API for movie management via Jellyfin & Transmission.

Can scrape movies from YTS and meta from TMDB & OMDB.

This is a super simple, not scalable, toy project.

Test

There are some basic integration tests.

dotnet test

Run

Assuming you have:

  • Jellyfin:
    • Running locally on port 8096 (the default)
    • With a movie library in location /mnt/storage/movies
  • Transmission:
    • Running locally on port 9091 (the default)
    • Configured to download into /mnt/storage/downloads
    • Configured to run a script that will delete a torrent once completed e.g. 
      #!/bin/bash

LOGFILE="/mnt/storage/downloads/transmission-complete.log"

tee -a $LOGFILE <<EOF
_____NEW TORRENT_____
Version: $TR_APP_VERSION
Time: $TR_TIME_LOCALTIME
Directory: $TR_TORRENT_DIR
Hash: $TR_TORRENT_HASH
ID: $TR_TORRENT_ID
Name: $TR_TORRENT_NAME
User: `whoami`
EOF

transmission-remote -t $TR_TORRENT_ID -r | tee -a $LOGFILE

Dotnet

Requires .NET 8+.

# Create all required directories
mkdir -p /var/make-movies/images
mkdir -p /mnt/storage/movies
mkdir -p /mnt/storage/downloads

# Optional socks proxy for connections to torrent sites (recommended)
export Scrape__ProxyUrl=socks5://localhost:9050

# Path to a writeable folder for caching movie image files
export Meta__ImagePath=/var/make-movies/images

# Your access token for the TMDB API
export Meta__Tmdb__AccessToken=my-tmdb-access-token

# Your access token for the OMDB API
export Meta__Omdb__ApiKey=my-omdb-access-token

# URL & API key for your Jellyfin server
export Library__Jellyfin__Url=http://localhost:8096
export Library__Jellyfin__ApiKey=my-jellyfin-api-key

# Path to your Jellyfin movie library
export Library__MovieLibraryPath=/mnt/storage/movies

# Path to your Transmission download folder
export Library__DownloadsPath=/mnt/storage/downloads

# URL for your Transmission server
export Download__Transmission__Url=http://localhost:9091/transmission/

# Path to a writeable folder for saving app metadata
export Db__Path=/var/make-movies

dotnet run --project MakeMovies.Api

Docker

docker build -t make-movies-api .
docker run -it --rm -p 8080:8080 \
    --add-host=host.docker.internal:host-gateway \
    -v library:/library:/mnt/storage/movies \
    -v downloads:/downloads:/mnt/storage/downloads \
    -v data:/var/make-movies:/data \
    -e Meta__Tmdb__AccessToken=my-tmdb-access-token \
    -e Meta__Omdb__ApiKey=my-omdb-access-token \
    -e Library__Jellyfin__ApiKey=my-jellyfin-api-key \
    -e Library__Jellyfin__Url=http://host.docker.internal:8096 \
    -e Download__Transmission__Url=http://host.docker.internal:9091/transmission/ \
    make-movies-api

Deploy

Systemd

For simplicity, I run this on Ubuntu via systemd.

  1. Build and copy an export to a central place.

    mkdir -p /opt/make-movies/api
dotnet publish MakeMovies.Api/MakeMovies.Api.csproj  -c Release -o /opt/make-movies/api

  2. Create systemd unit in /etc/systemd/system/make-movies-api.service:

    [Unit]
Description=Make movies API
Wants=network-online.target
After=network-online.target

[Service]
User=alex
Group=alex
Type=notify
Restart=on-failure
EnvironmentFile=/var/make-movies/.env
WorkingDirectory=/opt/make-movies/api
ExecStart=/opt/make-movies/api/MakeMovies.Api --urls "http://0.0.0.0:5000" --environment Production

[Install]
WantedBy=default.target

    Note: set a user and group that has access to your movie library & transmission download folder.

  3. Create data directories: mkdir -p /var/make-movies/images

  4. Configure via environment variables in /var/make-movies/.env e.g.

    Scrape__ProxyUrl=socks5://localhost:9050
Meta__ImagePath=/var/make-movies/images
Meta__Tmdb__AccessToken=my-tmdb-access-token
Meta__Omdb__ApiKey=my-omdb-access-token
Library__Jellyfin__Url=http://localhost:8096
Library__Jellyfin__ApiKey=my-jellyfin-api-key
Library__MovieLibraryPath=/mnt/storage/movies
Library__DownloadsPath=/mnt/storage/downloads
Download__Transmission__Url=http://localhost:9091/transmission/
Db__Path=/var/make-movies

  5. Reload systemd, start and enable the service:

    sudo systemctl daemon-reload
sudo systemctl enable make-movies-api
sudo systemctl start make-movies-api

  6. Check health with curl http://localhost:5000/health/ready

k3s

See k3s/README.md