bentools/proxy-server

A simple proxy server, written in Symfony 4.1.

dev-master / 1.0.x-dev 2018-09-17 15:15 UTC

Requires

• php: ^7.1.3
• ext-ctype: *
• ext-iconv: *
• bentools/guzzle-throttle-middleware: ^0.4.0
• guzzlehttp/guzzle: ^6.3
• predis/predis: ^1.1
• sensio/framework-extra-bundle: ^5.2
• symfony/cache: *
• symfony/console: *
• symfony/flex: ^1.1
• symfony/framework-bundle: *
• symfony/monolog-bundle: ^3.3
• symfony/psr-http-message-bridge: ^1.0
• symfony/yaml: *
• zendframework/zend-diactoros: ^1.8

Requires (Dev)

• php-pm/httpkernel-adapter: ^1.0
• php-pm/php-pm: ^1.0
• phpunit/phpunit: ^7.3
• symfony/dotenv: *
• symfony/test-pack: ^1.0
• symfony/var-dumper: *
• symfony/web-server-bundle: *

Conflicts

• symfony/symfony: *

Replaces

• paragonie/random_compat: *
• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *
• symfony/polyfill-php56: *
• symfony/polyfill-php70: *
• symfony/polyfill-php71: *

MIT

• symfony
• api
• server
• proxy
• proxy server
• php-pm

README

This small Symfony 4.1 application works as a proxy.

We assume you have a minimal knowledge of Symfony to customize it to your needs.

Installation

Clone the current project

composer create-project bentools/proxy-server:1.0.x-dev my-proxy && cd my-proxy

Init your environment variables

cp .env.dist .env

Create your PHP-PM config

./vendor/bin/ppm config

Serve your proxy

./vendor/bin/ppm start

Example configuration

# .env

PROXY_BASE_URI=https://some-api.example.org

# ppm.json

{
    "bridge": "HttpKernel",
    "host": "proxied-api.my-server.com",
    "port": 8080,
    "workers": 6,
    "app-env": "prod",
    "debug": 0,
    "logging": 0,
    "static-directory": "",
    "bootstrap": "PHPPM\\Bootstraps\\Symfony",
    "max-requests": 1000,
    "max-execution-time": 0,
    "ttl": 0,
    "populate-server-var": true,
    "socket-path": ".ppm\/run\/",
    "pidfile": ".ppm\/ppm.pid",
    "reload-timeout": 30,
    "cgi-path": "\/etc\/php\/7.2.8\/bin\/php-cgi"
}

Now if you try to access http://proxied-api.my-server.com:8080/some/endpoint?foo=bar you'll get the response of https://some-api.example.org/some/endpoint?foo=bar.

Throttling

Enable throttling via your environment variables:

# .env

PROXY_ENABLE_THROTTLING=true
PROXY_THROTTLING_MAX_REQUESTS=50
PROXY_THROTTLING_DURATION=10

This way you'll ensure than a maximum of 50 requests will be transferred to the real host in a 10 seconds window. All other requests will be delayed. Counting requests is shared via Redis, but feel free to implement a storage of your own.