Skip to content

AmaseCocoa/media-proxy

Repository files navigation

Media-Proxy

Media-Proxy is a lightweight media proxy for Misskey servers. It is approximately 3KB in size and provides minimal functionality for proxying media.

Features

  • Lightweight and fast
  • Easy to set up
  • Responses are cached for a fixed period of time
  • Docker support

Install

Install from Source

  1. Clone the repository.
git clone https://github.com/AmaseCocoa/media-proxy.git
cd media-proxy
  1. Install the required dependencies.
pip install -r requirements.txt

Install With Docker

  1. Pull the Docker image.
docker pull amasecocoa/media-proxy:latest
  1. Start the container.
docker run -d --name media-proxy -p 3003:3003 -e PORT=3030 amasecocoa/media-proxy:latest

How To Use

Start Server

Start the server with the following command.

python server.py

Configuration

Use environment variables to configure settings.

  • PORT: The port number the server listens on (default: 3003)
  • EXPIRES: The length of time to cache media (default: 86400 (seconds)) CHUNK_SIZE: The chunk size of the file to be read at a time. (default: 1048576 (bytes)) Discontinued in 0.3.0

Example:

export PORT=8000
export EXPIRES=86400

Example

To send an image request to a media proxy, use the following URL format:

http://host/proxy/image.webp?url=https://example.com/image.png

The url parameter is the URL of the image you wish to proxy.

Develop

To set up the development environment, do the following:

  1. Install the dependencies.
pdm install
  1. Start the server.
pdm run python server.py

License

This project is released under the MIT License. See the LICENSE file for more information.