README

Horizom Dev Server

Reverse proxy for PHP built-in server which supports multiprocessing and TLS/SSL encryption.

Installing

Global install

composer global require horizom/dev-server

If not yet, you must add ~/.composer/vendor/bin to $PATH.
Append the following statement to ~/.bashrc, ~/.zshrc or what not.

export PATH="$HOME/.composer/vendor/bin:$PATH"

Local install only for development environment

composer require --dev horizom/dev-server

Use vendor/bin/horizom-serve as the execution path.

Usage

Quick start

horizom-serve -S localhost -s localhost -t public

2 servers will start with the directory public as the document root:

• http://localhost:8000
• https://localhost:44300

Servers start with first unoccupied port within range depending on a scheme.

Customize ports

horizom-serve -S localhost:8080 -s localhost:4000 -t public

2 servers will start with the directory public as the document root:

• http://localhost:8080
• https://localhost:4000

Command Reference

mpyw@localhost:~$ horizom-serve -h

Usage:
    horizom-serve <options>

Example:
    horizom-serve -S localhost:8000 -s localhost:44300

[Required]
    -S   "<Host>:<Port>" of an HTTP server. Multiple arguments can be accepted.
    -s   "<Host>:<Port>" of an HTTPS server. Multiple arguments can be accepted.

[Optional]
    -n   The number of PHP built-in server clusters, from 1 to 20. Default is 10.
    -t   Path for the document root. Default is the current directory.
    -r   Path for the router script. Default is empty.
    -c   Path for the PEM-encoded certificate.
         Default is "/Users/username/.composer/vendor/horizom/dev-server/certificate.pem".

Restrictions:
    - The option -s is only supported on PHP 5.6.0 or later.
    - Access logs will not be displayed on Windows.

username@localhost:~$

Note for Windows users

Unfortunately, cmd.exe has no option to run via shebang #!/usr/bin/env php, so you need to create the following batch file in the proper directory.

For Standalone PHP

@echo OFF
"C:\php\php.exe" "%HOMEPATH%\.composer\vendor\horizom\dev-server\horizom-serve" %*

For XAMPP

@echo OFF
"C:\xampp\php\php.exe" "%HOMEPATH%\.composer\vendor\horizom\dev-server\horizom-serve" %*

License

MIT license