This is a Vagrant/Puppet configuration for the automated provisioning and setup of a Debian 8 virtual machine hosting the HUBzero example CMS.
Clone the repo, cd into the project directory, run vagrant up. The host
machine's port 8080 is forwarded to the website, so visit
https://localhost:8080/ in your browser.
The default administrator account is user admin with password password!.
The HUBzero CMS is located in /var/www/dev inside the virtual machine. Currently, the
most promising method to developing and testing CMS changes seems to be configuring an
rsync-type deployment method with your PHP IDE. eg. Get a local copy of CMS, change files,
deploy files to VM, check website in browser. If your IDE supports automatically pushing
newly changed files to deployment, you may wish to configure this as well.
In order to use xdebug you will need a local copy of the CMS and an IDE configured to accept xdebug connections on port 9000 (default xdebug port). You also need a browser plugin to send the cookie that triggers the debugger, like Xdebug helper.
When your IDE receives a connection, it may ask you to map the remote PHP files to their location on your local machine, and then you should be good to go.
MailHog is installed on the machine for mail debugging, but has not been thoroughly tested yet.
It is accessible at localhost:8025
vagrant up - Creates a machine if nonexistent, otherwise turns existing machine on
vagrant reload - Turn off and on machine
vagrant reload --provision - Turn off and on machine, and run the provisioners (puppet, shell
scripts)
vagrant destroy - Delete virtual machine
vagrant status - Self explanatory
vagrant ssh - Self explanatory
When you configure certain local services or programs to connect to the machine, you may do so
through SSH tunnel. This works when some other methods like port forwarding don't seem to be working
The best way to configure this is to configure the SSH connection to use a private
key pair, then select the private_key that appears in ./.vagrant/machines/***/private_key.
You will use vagrant as the user.
For connecting to the development database, I've found that the easiest way is to connect through an SSH tunnel using the above method. Forwarding the database port and connecting via said port has given me inexplicable trouble in the past.
...
This workflow has only been tested on Debian 8, but will likely work on most Linux distributions.
Using this workflow on Windows may pose additional concerns, specifically due to some unavoidable differences in the filesystem.
- Change network configuration to use a private network so you can map a local IP to the site rather than port forward
- Flexible modules that can be used with other site specifications
- Separate dev and production environment configurations
- Parameterization of more options such as PHP version selection
- Addition of hubzero_wrapper module, which wraps all main modules together for simpler site configuration in one module