A Docker image for DrKylstein's retro-proxy, a vintage-friendly proxy service.

Run this container from the command line:

docker run -it -e PORT=8080 -p 8080:8080/tcp ghcr.io/danclough/retro-proxy

Or as a docker-compose service:

version: '2.4'
services:
  retro-proxy:
    image: ghcr.io/danclough/retro-proxy
    volumes:
      # If you need to override the default list of allowed sites
      - ./allowed.txt:/proxy/allowed.txt
    ports:
      - 3000:3000/tcp
    restart: unless-stopped

By default, retro-proxy listens on port 3000. This can be mapped to another port in Docker, or can be overridden using an environment variable as described below.

The retro-proxy service can be configured using environment variables.

• IP: The IP address to listen on
  • default: any
• PORT: The port to listen on
  • default: 3000
• NO_CSS: If true, CSS will be blocked from all sites, except those on the allowed list.
  • default: true
• NO_JS: If true, JavaScript will be blocked from all sites, except those on the allowed list.
  • default: true
• RESIZE_TO: Maximum image size in pixels to return to client browsers. Any images greater than this resolution will be resized and compressed. Mostly benefits small screens and systems with less RAM.
  • default: 800
• SCALE_TO: Maximum image size on the rendered pages. Any images greater than this resolution will be scaled to this size in the resulting HTML. Recommended if you have NO_CSS enabled, as many sites rely on CSS to scale images to fit the screen.
  • default: 608
• ALLOWLIST: The list of sites that are excluded from any CSS/JS stripping.
  • default: allowed.txt