Skip to content
This repository has been archived by the owner on Feb 8, 2019. It is now read-only.
Charlie Rosenbury edited this page Jan 11, 2015 · 6 revisions
"apache": {
	"scheme": "vhost",
	"vhost_dir": "/etc/apache2/extra/vhosts"
	"sites_dir": "/User/me/Sites",
	"logs_dir": "/my-sites/logs"
	"a2ensite": false
	"as_service": false
	"url_scheme": "*.local"
}

Required

HelperPress configures your Apache and hosts settings so that your local environment is ready to go for you as soon as you install the project. Since this is probably the same for all projects, this settings should go in your global config file (~/.helperpress).

Scheme

"scheme": "vhost"

Required

Do you use vhosts for each individual site or a subdirectory?

Values

"vhost": HelperPress will setup a vhost configuration file & host entry for you.

"subdir": HelperPress will setup a symlink in your localhost root to your dev build.

Virtual Host Directory

"vhost_dir": "/etc/apache2/extra/vhosts"

Required only if "scheme" is set to "vhost"

HelperPress assumes you use a directory in which each vhost gets its own configuration file. It will automatically generate a vhost configuration file and place it in that directory. To set this up, add Include /private/etc/apache2/extra/vhosts/*.conf the end of your current vhost config file, and then create the directory you are including.

Sites Directory

"sites_dir": "/User/me/Sites"

Required only if "scheme" is set to "subdir"

The directory that you localhost root domain serves sites from. A symlink will be placed in here to your dev build.

Logs Directory

"logs_dir": "/my-sites/logs"

Required, and the directory must already exist

A logfile will be placed in here for your site's PHP logs.

Use a2ensite

"a2ensite": false

Default: false

Indicate whether the a2ensite command should be run to enable vhost configurations like on Ubuntu

Run Apache as a Service

"as_service": false

Default: false

Indicate whether Apache is being run as a service and should be reloaded that way. If false, apache2ctl will be used to restart Apache.

URL Scheme

"url_scheme": "*.local"

Required

The scheme you use for local Virtual Hosts. The asterisk will be replaced with the slug of the project.