Skip to content

Latest commit

 

History

History
186 lines (127 loc) · 6.03 KB

README.md

File metadata and controls

186 lines (127 loc) · 6.03 KB
Raw

MediaFusion Local Deployment Guide For Docker Compose 🐳

This guide outlines the steps for deploying MediaFusion locally using Docker Compose. It is an alternative to Kubernetes-based deployment for users who prefer a simpler setup or have constraints running Kubernetes on their machines.

Local Deployment Video Tutorial 📹

Watch the video

Clone the Repository 📋

git clone https://github.com/mhdzumair/MediaFusion
cd MediaFusion

# goto deployment/docker-compose
cd deployment/docker-compose

Prerequisites 🛠️

Ensure the following tools are installed:

Configuration 📝

Rename .env-sample to .env and update the variables.

Tip

For more configuration options, refer to the Configuration documentation.

Linux/macOS

cp .env-sample .env
# Generate and update SECRET_KEY in the .env file
echo SECRET_KEY=$(openssl rand -hex 16) >> .env

# Set API Password to secure the API endpoints
echo API_PASSWORD=your_password >> .env

# Optional:
# Update .env with your Premiumize credentials if available
# You can obtain OAuth credentials from the https://www.premiumize.me/registerclient with free user account.
echo PREMIUMIZE_OAUTH_CLIENT_ID=your_client_id >> .env
echo PREMIUMIZE_OAUTH_CLIENT_SECRET=your_client_secret >> .env

# Open the .env file to verify the values
nano .env

Windows

# Copy .env-sample to .env
Copy-Item .env-sample .env

# Generate and update SECRET_KEY in the .env file
$guid = [System.Guid]::NewGuid().ToString("N").Substring(0, 32)
Add-Content -Path .env -Value "SECRET_KEY=$guid"

# Set API Password to secure the API endpoints
Add-Content -Path .env -Value "API_PASSWORD=your_password"

# Optional:
# Update .env with your Premiumize credentials if available
# You can obtain OAuth credentials from the https://www.premiumize.me/registerclient with free user account.
$clientId = 'your_client_id'
$clientSecret = 'your_client_secret'
Add-Content -Path .env -Value "PREMIUMIZE_OAUTH_CLIENT_ID=$clientId"
Add-Content -Path .env -Value "PREMIUMIZE_OAUTH_CLIENT_SECRET=$clientSecret"

# Open the .env file to verify the values
notepad.exe .env

Generate Self-Signed SSL Certificate 🔐

Generate a self-signed SSL certificate for local HTTPS:

mkcert -install
mkcert "mediafusion.local"

Tip

If you are using WSL to setup MediaFusion, You also need to run mkcert -install in Windows PowerShell to install the root certificate.

Prowlarr Configuration 🔄

To configure Prowlarr, Run the script based on your OS:

Warning

This script will clean up the existing configuration in Prowlarr and add the new configuration.

Linux/macOS

export FLARESOLVERR_HOST=http://flaresolverr:8191
./setup-prowlarr.sh

Windows

$env:FLARESOLVERR_HOST = "http://flaresolverr:8191"
.\setup-prowlarr.ps1

Tip

This script will setup Prowlarr API key to the .env file, Add tested Public trackers and flaresolverr configuration in Prowlarr. Additionally, You can also add or modify your own trackers and other configuration in Prowlarr by visiting the prowlarr web interface http://localhost:9696.

Deployment 🚢

Deploy MediaFusion using Docker Compose:

docker compose -f docker-compose.yml up -d

Warning

Note: If you have lower than armv8-2 architecture, you may not be able to run the mongodb container. In that case, you can use MongoDB Atlas Cluster.

Configuring MongoDB Atlas Cluster (Optional) (Not needed for local deployment) 🌐

If you want to use MongoDB atlas Cluster instead of local MongoDB, follow the documentation here.

  • Replace the MONGO_URI in the .env file with the connection string you copied from the previous step.
  • Make sure to add the Database name in the connection string. Example Database name is mediafusion.
MONGO_URI=mongodb+srv://<username>:<password>@<cluster-url>/<database-name>?retryWrites=true&w=majority
  • Remove the mongodb container and depends_on from the docker-compose.yml file.

Accessing MediaFusion 🌍

Update your system's hosts file to resolve mediafusion.local to 127.0.0.1:

Windows

Open PowerShell as Administrator:

Add-Content -Path C:\Windows\System32\drivers\etc\hosts -Value "127.0.0.1 mediafusion.local"

Linux/macOS

echo "127.0.0.1 mediafusion.local" | sudo tee -a /etc/hosts

Now, access MediaFusion at https://mediafusion.local 🎉

Tip

When you first access MediaFusion, scraped results may not be immediately available until background scheduled tasks are completed. You can manually trigger these tasks by visiting the scraper control interface at https://mediafusion.local/scraper.

Updating MediaFusion 🔄

To update MediaFusion, pull the latest changes from the repository and restart the containers:

git pull
docker compose -f docker-compose.yml down
docker compose -f docker-compose.yml pull
docker compose -f docker-compose.yml up -d

Stopping MediaFusion 🛑

To stop MediaFusion, run the following command:

docker compose -f docker-compose.yml down

Troubleshooting 🛠️

  • If you encounter any issues during the deployment, check the logs for the respective service using docker-compose -f docker-compose.yml logs <service-name>.
  • If you encounter any issues with the web interface, ensure that the SSL certificate is installed correctly.

Feedback 📢

If you have any feedback, please feel free to open an issue or submit a pull request. 🙏