Skip to content

Welcome to PyProxy Docs

pyproxy is a lightweight, fast, and customizable Python-based web proxy server designed to handle both HTTP and HTTPS traffic efficiently. It can be used for various purposes, including web scraping, traffic monitoring, and content filtering.

Key Features

  • Full HTTP and HTTPS support
  • Detailed web request and response logging
  • Domain and URL filtering (blacklist, remote blacklist)
  • SSL inspection with automatic certificate generation
  • Custom 403 Forbidden page
  • Smart shortcuts (quick rules and actions)
  • Automatic exclusion of banking websites from inspection
  • Custom headers injection
  • Built-in monitoring web interface
  • Lightweight Docker image ready for production
  • Proxy chaining (multi-proxy forwarding)
  • IP whitelist with subnet support

Where to Start

If you're new here, check out:

  • Installation
    Set up PyProxyTools from source, PyPI, or Docker.

  • Configuration
    Learn how to configure the proxy using .ini files, environment variables, or command-line flags.

  • Features
    Explore advanced capabilities like SSL inspection, filtering, monitoring, and chaining.

Project Repository

Source code is available on GitHub:
➡️ https://github.com/pyproxytools/pyproxy

About This Documentation

This site is built using MkDocs and the Material for MkDocs theme.
It provides a clean and versionable documentation hub for the entire PyProxyTools project.

If you'd like to contribute, fix something, or suggest improvements, drop by the documentation repo:
➡️ https://github.com/pyproxytools/pyproxy-docs