MediaFlick

Description

MediaFlick is a media management tool that allows you to scan your media library and automatically organize your files into folders based on their metadata. It uses the TMDb API to get information about movies and TV shows, and it can also detect and rename files based on their metadata.

Installation

MediaFlick can be installed in multiple ways:

Docker Installation (Recommended)

Using Docker Run

docker run -d \
  --name mediaflick \
  -p 3000:3000 \
  -v /mnt/zurg:/mnt/zurg \
  -v /opt/mediaflick/config:/config \
  -v /opt/mediaflick/logs:/logs \
  ghcr.io/phob/mediaflick:latest

Using Docker Compose

Create a docker-compose.yml file:

services:
  mediaflick:
    image: ghcr.io/phob/mediaflick:latest
    container_name: mediaflick
    ports:
      - "3000:3000"
    volumes:
      - /mnt/zurg:/mnt/zurg
      - /opt/mediaflick/config:/config
      - /opt/mediaflick/logs:/logs
    restart: unless-stopped

Then run:

docker-compose up -d

Manual Installation

MediaFlick consists of two components: a backend service (.NET) and a frontend web application (Next.js). Both need to be installed and running for the application to work properly.

Backend Installation

1. Download the appropriate backend package for your operating system from the latest release:

   • For Windows: mediaflick-backend-windows.zip
   • For Linux: mediaflick-backend-linux.tar.gz

2. Extract the archive to your desired location:

   • Windows:

     Expand-Archive mediaflick-backend-windows.zip -DestinationPath C:\mediaflick

   • Linux:

     mkdir -p /opt/mediaflick
     tar -xzf mediaflick-backend-linux.tar.gz -C /opt/mediaflick

3. Start the backend service:

   • Windows:

     cd C:\mediaflick
     .\PlexLocalScan.Api.exe

   • Linux:

     cd /opt/mediaflick
     chmod +x PlexLocalScan.Api
     ./PlexLocalScan.Api

Frontend Installation

1. Download the frontend package mediaflick-frontend.zip from the latest release

2. Extract the archive to a web server directory:

   • For nginx:

     unzip mediaflick-frontend.zip -d /var/www/mediaflick

   • For Apache:

     unzip mediaflick-frontend.zip -d /var/www/html/mediaflick

3. Configure your web server to serve the Next.js application. Example nginx configuration:

   server {
       listen 80;
       server_name mediaflick.local;
       root /var/www/mediaflick;
       
       location / {
           try_files $uri $uri/ /_next/static/$uri /_next/static/$uri/ =404;
       }
       
       location /_next/ {
           alias /var/www/mediaflick/_next/;
       }
   }

4. Access the application through your web browser at http://localhost or your configured domain.

Configuration

After installation, you'll need to configure both components:

1. Backend configuration file is located at:

   • Windows: C:\mediaflick\appsettings.json
   • Linux: /opt/mediaflick/appsettings.json

2. Frontend configuration can be done through the web interface under Settings.

For detailed configuration options, please refer to the Configuration Guide.

Saltbox Installation

For Saltbox users, you can integrate MediaFlick with Authelia authentication and Traefik. Create a docker-compose.yml file in your /opt/mediaflick/ directory:

services:
  mediaflick:
    restart: unless-stopped
    container_name: mediaflick
    image: ghcr.io/phob/mediaflick:latest
    hostname: mediaflick
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - ASPNETCORE_ENVIRONMENT=Production
      - ASPNETCORE_URLS=http://+:5000
      - NODE_ENV=production
      - CORS_ORIGINS=http://localhost:3000
    networks:
      - saltbox
    labels:
      com.github.saltbox.saltbox_managed: true
      traefik.enable: true
      traefik.http.routers.mediaflick-http.entrypoints: web
      traefik.http.routers.mediaflick-http.middlewares: globalHeaders@file,redirect-to-https@docker,robotHeaders@file,cloudflarewarp@docker,authelia@docker
      traefik.http.routers.mediaflick-http.rule: Host(`mediaflick.yourdomain.com`)
      traefik.http.routers.mediaflick-http.service: mediaflick
      traefik.http.routers.mediaflick.entrypoints: websecure
      traefik.http.routers.mediaflick.middlewares: globalHeaders@file,secureHeaders@file,robotHeaders@file,cloudflarewarp@docker,authelia@docker
      traefik.http.routers.mediaflick.rule: Host(`mediaflick.yourdomain.com`)
      traefik.http.routers.mediaflick.service: mediaflick
      traefik.http.routers.mediaflick.tls.certresolver: cfdns
      traefik.http.routers.mediaflick.tls.options: securetls@file
      traefik.http.services.mediaflick.loadbalancer.server.port: 3000
    volumes:
      - /opt/mediaflick:/app/config
      - /opt/mediaflick/logs:/app/logs
      - /mnt/unionfs:/mnt/unionfs
      - /etc/localtime:/etc/localtime:ro
      - /mnt/zurg:/mnt/zurg
      - /mnt/organized:/mnt/organized

networks:
  saltbox:
    external: true

Then create the necessary directories and set permissions:

mkdir -p /opt/mediaflick/logs
chown -R 1000:1000 /opt/mediaflick

Start the container:

cd /opt/mediaflick
docker-compose up -d

MediaFlick will be available at https://mediaflick.yourdomain.com with Authelia authentication through Traefik.

Note: Make sure you have properly configured your Saltbox installation with Traefik and Authelia before proceeding.