Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nass600/portiere
Symfony console command for managing vhosts
https://github.com/nass600/portiere
nginx symfony-console vhost vhost-builder
Last synced: about 1 month ago
JSON representation
Symfony console command for managing vhosts
- Host: GitHub
- URL: https://github.com/nass600/portiere
- Owner: nass600
- License: mit
- Created: 2015-01-05T12:05:17.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-13T00:14:41.000Z (almost 8 years ago)
- Last Synced: 2024-04-14T06:27:23.073Z (9 months ago)
- Topics: nginx, symfony-console, vhost, vhost-builder
- Language: PHP
- Homepage:
- Size: 95.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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:
````bash
composer global require nass600/portiere 0.4.0
````
and add composer global package binaries to your PATH if you didn't yet:
````bash
echo "export PATH=~/.composer/vendor/bin:$PATH" >> ~/.bashrc
````
You are ready to go by running wherever you want the commands `vhost-create`and `vhost-delete`
### Locally
Require the library by executing:
````bash
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-create`and `bin/vhost-delete`
## Usage
**Note**: You probably need `sudo` permissions for executing this commands successfully
### vhost:list
Lists all the virtual hosts
````bash
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
````bash
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
````bash
portiere vhost:delete dev.example.com
````
__Arguments__
| argument | description |
| -------------- | ------------------------- |
| vhostFilename | The virtual host filename |
## Future work
+ Support more web servers
+ Improve tests
## License
[MIT](LICENSE)
## Authors
+ [Ignacio Velazquez](http://ignaciovelazquez.es)