MediaFusion/deployment/k8s/README.md

MediaFusion Local Deployment Guide For Kubernetes 🚀

This guide provides instructions for deploying MediaFusion locally using Minikube, tailored for Windows, Linux, and macOS platforms. Follow these steps to set up MediaFusion on your local machine.

Clone the Repository

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

Prerequisites

Before you begin, ensure the following tools are installed on your system:

• Minikube: For local Kubernetes development. Install instructions are available in the Minikube documentation.

• kubectl: The Kubernetes command-line tool. Installation guidelines can be found in the Kubernetes documentation.

• mkcert: For generating self-signed SSL certificates. Installation guide.

Setting Up Secrets 🗝️

MediaFusion requires certain secrets for operation. Use the following commands to create them:

# Generate a random 32-character string for the SECRET_KEY
SECRET_KEY=$(openssl rand -hex 16)

# Generate a random API key for Prowlarr
PROWLARR_API_KEY=$(openssl rand -hex 16)

# Set a password to secure the API endpoints
API_PASSWORD="your_password"

# If using Premiumize, fill in your OAuth client ID and secret. Otherwise, leave these empty.
# You can obtain OAuth credentials from the https://www.premiumize.me/registerclient with free user account.
PREMIUMIZE_OAUTH_CLIENT_ID=""
PREMIUMIZE_OAUTH_CLIENT_SECRET=""

kubectl create secret generic mediafusion-secrets \
    --from-literal=SECRET_KEY=$SECRET_KEY \
    --from-literal=API_PASSWORD=$API_PASSWORD \
    --from-literal=PROWLARR_API_KEY=$PROWLARR_API_KEY \
    --from-literal=PREMIUMIZE_OAUTH_CLIENT_ID=$PREMIUMIZE_OAUTH_CLIENT_ID \
    --from-literal=PREMIUMIZE_OAUTH_CLIENT_SECRET=$PREMIUMIZE_OAUTH_CLIENT_SECRET

Updating Secrets

To update existing secrets, use the following command:

kubectl create secret generic mediafusion-secrets \
    --from-literal=SECRET_KEY=$SECRET_KEY \
    --from-literal=API_PASSWORD=$API_PASSWORD \
    --from-literal=PROWLARR_API_KEY=$PROWLARR_API_KEY \
    --from-literal=PREMIUMIZE_OAUTH_CLIENT_ID=$PREMIUMIZE_OAUTH_CLIENT_ID \
    --from-literal=PREMIUMIZE_OAUTH_CLIENT_SECRET=$PREMIUMIZE_OAUTH_CLIENT_SECRET \
    --dry-run=client -o yaml | kubectl apply -f -

Install Required Addons

Ingress 🌐

minikube addons enable ingress

Metrics Server 📊

Required for Horizontal Pod Autoscaler (HPA) functionality:

minikube addons enable metrics-server

Create SSL Certificate for Ingress 🔒

Generate and store a self-signed certificate:

mkcert -install
mkcert "mediafusion.local"

kubectl create secret tls mediafusion-tls \
    --cert=mediafusion.local.pem \
    --key=mediafusion.local-key.pem

Configuring MediaFusion 🛠️

Tip

For more configuration options, refer to the Configuration documentation.

Edit the deployment/local-deployment.yaml to set the required environment variables:

          - name: HOST_URL
            value: "https://mediafusion.local"
          - name: ENABLE_TAMILMV_SEARCH_SCRAPER
            value: "false"
          - name: PROWLARR_IMMEDIATE_MAX_PROCESS
            value: "3"
          - name: PROWLARR_SEARCH_INTERVAL_HOUR
            value: "24"
          - name: IS_SCRAP_FROM_TORRENTIO
            value: "false"

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 deployment/local-deployment.yaml 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.

          - name: MONGO_URI
            value: "mongodb+srv://<username>:<password>@<cluster-url>/<database-name>?retryWrites=true&w=majority"

• Set mongodb-deployment replica to 0 in the deployment/local-deployment.yaml file.

Deployment 🚢

Deploy MediaFusion to your local Kubernetes cluster:

kubectl apply -f deployment/local-deployment.yaml

Accessing MediaFusion 🌍

Add an entry to your system's hosts file to resolve mediafusion.local to the Minikube IP:

Windows

Open PowerShell as Administrator:

Add-Content -Path C:\Windows\System32\drivers\etc\hosts -Value "$(minikube ip) mediafusion.local"

Linux/macOS

echo "$(minikube ip) mediafusion.local" | sudo tee -a /etc/hosts

Now, you can 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.