davidianbonner/aerys

A non-blocking HTTP application, WebSocket and file server.

aerys

Aerys is a non-blocking HTTP/1.1 and HTTP/2 application, WebSocket and static file server written in PHP based on the amp concurrency framework.

Aerys has currently a few 0.x tags. APIs are still subject to very small changes and you may run into rogue bugs features. We love PRs, though :-)

Selected Built-in Features ...

• Static file serving
• WebSockets
• Dynamic app endpoint routing
• Name-based virtual hosting
• Full TLS support
• Customizable GZIP output compression
• HTTP/2.0 support
• Middleware hooks

Requirements

• PHP 7

Installation

composer require amphp/aerys

Documentation

• Official Documentation
• Getting Started with Aerys
• Getting Started with Aerys WebSockets

Running a Server

php bin/aerys -c demo.php

Simply execute the aerys binary (with PHP 7) to start a server listening on http://localhost/ using the default configuration file (packaged with the repository).

Add a -d switch to see some debug output like the routes called etc.:

php bin/aerys -d -c demo.php

Config File

Use the -c, --config switches to define the config file:

php bin/aerys -c /path/to/my/config.php

Use the -h, --help switches for more instructions.

Static File Serving

To start a static file server simply pass a root handler as part of your config file.

(new Aerys\Host)
    ->expose("*", 1337)
    ->use(Aerys\root(__DIR__ . "/public"));

Security

If you discover any security related issues, please email [email protected] or [email protected] instead of using the issue tracker.

License

The MIT License (MIT). Please see LICENSE for more information.