Easily keep your nginx virtual hosts and /etc/hosts file up to date with this tool.
It is primarily intended for developers who work on multiple projects.
It allows you to have a single shared nginx service running on your system which directs traffic to each of your projects/apps based on host name.
Each of your projects should have a config/dev directory containing:
config.jsoncontaining the project name and a list of host namesnginxdirectory containing at a minimum:index.confcontaining (orincludeing) aserverblock for each virtual host used by this project
When you run vhost install, this tool will automatically add or update your nginx config and
/etc/hosts file based on your project's configuration.
From the root of your project, run vhost, which will show you the usage instructions:
Usage:
vhost <command> [<options>]
vhost new <vhost_name> [<options>]
vhost install [<options>]
Commands:
new Generate config for a new vhost and copy it into your current project's 'config/dev'
install Installs the contents of your project's 'config/dev' into your system nginx config
Options:
-r, -restart Restart server even if no config changes are detected.
--config-dir=<path> Read/update virtual host config from this directory instead of 'config/dev'
--sites-dir=<path> Install virtual hosts to this directory instead of to '/etc/nginx/sites-enabled'
Each project should have a config file at config/dev/config.json.
If a config/dev/config.local.json is present, its contents will be merged in as well. This allows
you to have local overrides that are not committed to the repository.
Example:
{
"name": "my_project_name",
"hosts": [
"host1.test",
"host2.test"
],
"env": {
"PORT": null,
"OVERRIDE_SOMETHING": "overridden"
}
}The variables $project_dir and $config_dir are provided for you and available for use in your
config/dev/nginx/vhosts/*conf files.
If an env section is provided, it lists additional variables that will be passed to envsubst.
Similar to
docker-compose files,
if a value is provided, it will be used (and override anything set in your environment). If no value
is provided (null), the value must already be provided by your environment.
You need at least Bash 4.2. Mac may not have this up to date.
On Mac:
brew install bash
You must have nginx running locally on your system.
On Mac:
brew-install nginx
On Linux:
apt-install nginx
vhost will automatically detect your nginx "sites" directory, if it is one of
/usr/local/etc/nginx/servers/etc/nginx/sites-enabled
Otherwise, you must provide it with the --sites-dir option.
brew install jq
apt-install jq
brew install gettext; brew link --force gettext
apt install gettext-base
Add the bin directory from this project to your $PATH.