Installation

Option 1: Self-Hosted Deployment

Using Docker from Docker Hub

1. Pull & Run the Docker image:

   docker run -p 8888:8888 -e API_PASSWORD=your_password mhdzumair/mediaflow-proxy
   

   Custom listen port (host and container must match the chosen PORT):

   docker run -p 8889:8889 -e PORT=8889 -e API_PASSWORD=your_password mhdzumair/mediaflow-proxy
   

Using Docker Compose

1. Set the API_PASSWORD and other environment variables in .env:

echo "API_PASSWORD=your_password" > .env

2. Bring up the Docker Container:

docker compose up --detach

Using pip

[!IMPORTANT] Ensure that you have Python 3.10 or higher installed.

1. Install the package:

   pip install mediaflow-proxy
   

2. Set the API_PASSWORD and other environment variables in .env:

   echo "API_PASSWORD=your_password" > .env
   

3. Run the MediaFlow Proxy server:

   mediaflow-proxy
   

   You can access the server at http://localhost:8888 (or http://localhost:$PORT if you set the PORT environment variable).

4. To run the server with uvicorn options: (Optional)

   uvicorn mediaflow_proxy.main:app --host 0.0.0.0 --port 8888 --workers 4 --forwarded-allow-ips "*"
   

Note

Omit --forwarded-allow-ips "*" when running locally.

Using git & uv

[!IMPORTANT] Ensure that you have Python 3.10 or higher and uv installed.

1. Clone the repository:

   git clone https://github.com/mhdzumair/mediaflow-proxy.git
   cd mediaflow-proxy
   

2. Install dependencies using uv:

   uv sync
   

3. Set the API_PASSWORD environment variable in .env:

   echo "API_PASSWORD=your_password" > .env
   

4. Run the FastAPI server:

   uv run uvicorn mediaflow_proxy.main:app --host 0.0.0.0 --port 8888 --workers 4 --forwarded-allow-ips "*"
   

Note

Omit --forwarded-allow-ips "*" when running locally.

Build and Run Docker Image Locally

1. Build the Docker image:

   docker build -t mediaflow-proxy .
   

2. Run the Docker container:

   docker run -d -p 8888:8888 -e API_PASSWORD=your_password --restart unless-stopped --name mediaflow-proxy mediaflow-proxy
   

   Example with a non-default port:

   docker run -d -p 8889:8889 -e PORT=8889 -e API_PASSWORD=your_password --restart unless-stopped --name mediaflow-proxy mediaflow-proxy
   

Option 2: Premium Hosted Service (ElfHosted)

For a hassle-free, high-performance deployment of MediaFlow Proxy, consider the premium hosted service through ElfHosted.

To purchase: 1. Visit https://store.elfhosted.com/product/mediaflow-proxy 2. Follow ElfHosted's setup instructions

Benefits: - Instant setup and automatic updates - High performance and 24/7 availability - No server maintenance required

Ideal for users who want a reliable, plug-and-play solution without the technical overhead of self-hosting.

Option 3: Hugging Face Space Deployment (Guide from a MediaFlow Contributor)

1. Go to this repo and create a fork: https://github.com/UrloMythus/UnHided
2. Sign up or log in to Hugging Face: https://huggingface.co/
3. Create a new space with a random name: https://huggingface.co/new-space. Choose Docker as SDK and blank template and public visibility.
4. Go to the "Settings" tab and create a new secret with the name API_PASSWORD and set the value to your desired password.
5. Go to the "Files" tab and create a new file with the name Dockerfile and paste the following content. After that, replace YourUsername/YourRepoName in the Dockerfile with your username and the name of your fork. Finally, click on "Commit" to save the changes. Remember, your space might get banned if instead of using your fork, you use the main repo.

   FROM python:3.11-slim-bullseye
   
   WORKDIR /app
   
   RUN apt-get update && apt-get install -y git
   
   RUN git clone https://github.com/YourUsername/YourRepoName.git .
   
   RUN pip install --no-cache-dir -r requirements.txt
   
   EXPOSE 7860
   CMD ["uvicorn", "run:main_app", "--host", "0.0.0.0", "--port", "7860", "--workers", "4"]
   

6. Wait until the space gets built and deployed. Don't panic if you see "Your app is running" instead of the usual mediaflowproxy page. You can still use it as usual.
7. If the space is deployed successfully, you can click on the three dots in the top right corner and click on "Embed this space" and copy the "Direct URL".
8. To update your proxy to the newest release, go to your GitHub fork and click on Sync. After that, hop on your Hugging Face Space -> Settings and click on Factory Rebuild.
9. Use the above URL and API password on support addons like MediaFusion, MammaMia, Jackettio, etc.