README.md

Portiere

Symfony Console command to handle virtual hosts for a Symfony project in a Unix machine.

Supported Web Servers

Nginx

Installation

The installation is handled by composer and you can install it either globally or locally.

Globally

Require the library globally by executing:

composer global require nass600/portiere 0.4.0

and add composer global package binaries to your PATH if you didn't yet:

echo "export PATH=~/.composer/vendor/bin:$PATH" >> ~/.bashrc

You are ready to go by running wherever you want the commands vhost-createand vhost-delete

Locally

Require the library by executing:

composer require-dev nass600/portiere 0.4.0

You are ready to go by running from the root of your project the commands bin/vhost-createand bin/vhost-delete

Usage

Note: You probably need sudo permissions for executing this commands successfully

vhost:list

Lists all the virtual hosts

portiere vhost:list

vhost:create

This command will:

1. Create a virtual host file named serverName or vhost-filename if set
2. Create an error log file named vhost-filename.error.log and an access log file named vhost-filename.access.log in the web server default logs directory
3. Enable the virtual host
4. Restart the web server

portiere vhost:create dev.example.com /home/user/sites/project/web

Arguments

argument	description
serverName	The server name of the virtual host
documentRoot	The directory holding the front controller php file

Options

option	default	description
--vhost-filename, -vf	{{serverName}}	The virtual host filename
--no-dev		Don't add development environment to vhost file

vhost:delete

This command will:

1. Remove the virtual host file named vhostFilename
2. Remove both access and error log files from the web server default logs directory
3. Disable the virtual host
4. Restart the web server

portiere vhost:delete dev.example.com

Arguments

argument	description
vhostFilename	The virtual host filename

Future work

• Support more web servers
• Improve tests

License

MIT

Authors

• Ignacio Velazquez