This is the general purpose development stack used at nœrdisch - digital solutions for legacy projects and fun & pleasure.
The GitHub version published here is known internally as v2.3.0 without some customer-specific, confidential modules. The release Versions might jump from time to time (e.g. from v2.18.0 to v2.20.0). This is due the fact we're using patches to update this OpenSource Version of our internal Version on spare-time base. We will however keep the versionnumbers in sync with the internal Version.
The stack is created in two machines. One box for anything web-related, the other box for anything database related. Both boxes have about 50 GB disk space (used for operating system, databases & stuff like that, excluding your projects), will use 25% of total RAM on the host system in total (e.g. 4 GB divided into two slices per 2 GB if you got 16 Gigs on your host) and all CPU cores of your system which should be suitable for most projects you run in this box.
If you're running 8 GB RAM or less on the host system the machines will get 1 GB of RAM each to provide a stable environment for your projects. That might be an issue for you in case you're running 4 GB or less on the host system.
Both boxes get /opt/transfer mounted via NFS (_transfer on your local disk) to make both boxes able to share data if needed.
These boxes are named after Phoenix which visited Mars back in 2008 - even though it does fit the german idiom "Phönix aus der Asche" too.
- a Git client
- Vagrant 1.8.4
- Vagrant Virtualbox Additions Plugin (installed during initial setup)
- Virtualbox 5.0.x
The combination of Vagrant & Virtualbox is critical. There are way to many issues with anything else.
- Mac OS X 10.11.x (please note there's an open issue affecting 10.12.x: GitHub #8061)
- Linux (Ubuntu 16.04 LTS, other Distributions to be tested)
- never to be added: any Windows Version (even though there are reports it works, it'll never going to be official)
Any other combination might work, but is neither tested nor supported by nœrdisch - digital solutions. The repository is provided as-is without warranty.
Clone this repository
git clone <the repository url> ~/VagrantNoerdisch
Change to the cloned repository
cd ~/VagrantNoerdisch
Update the Git Submodules used for external dependencies
git submodule update --init
Boot up the virtual box:
vagrant up --provision
If you are using a Mac (well .. you are since it's a requirement to run this box) you have to enter your password of your Mac while the boot up. This is caused by the NFS mounting process that requires root access (done by sudo) to modify your local /etc/exports.
Both boxes get one static IP addresses (web: 192.168.50.50, database: 192.168.50.51) which are only accessible from your local computer. You do need to be connected to the internet however while provisioning the box.
Please run a single vagrant reload --provision after initial setup. This is due to adjusting things like open files limits & stuff like that.
| Service | URL | Document Root | IP/Port | Protocol |
|---|---|---|---|---|
| Wildcard | project.local.noerdisch.net | /var/www/$project/Web/ |
192.168.50.50:80 | HTTP |
| Symfony2 Wildcard | project.local-sf2.noerdisch.net | /var/www/sf2/$project/web/ |
192.168.50.50:80 | HTTP |
| Shopware Wildcard | project.local-sw5.noerdisch.net | /var/www/sw5/$project/web/ |
192.168.50.50:80 | HTTP |
| Haproxy Stats | local.noerdisch.net:1936 | none | 192.168.50.50:1936 | HTTP |
| MailHog | local.noerdisch.net:8025 | none | 192.168.50.50:8025 | HTTP |
| Elasticsearch | local.noerdisch.net:9200 | none | 192.168.50.50:9200 | HTTP |
| Portainer | local.noerdisch.net:12468 | none | 192.168.50.50:12468 | HTTP |
| MySQL | db.local.noerdisch.net | none | 192.168.50.51:3306 | MySQL |
| PostgreSQL | db.local.noerdisch.net | none | 192.168.50.51:5432 | PostgreSQL |
As we've seen the majority of our projects use html as document root, nginx will prefer html over Web as document root. If however there is no html folder in place nginx will fall back to Web as document root to provide backwards compatibility.
Based on the awesome PPA of Ondřej Surý this box does provide a couple of different PHP versions.
The default engine used is PHP 7.0. To test your application with some different Version just prefix the project URL with one of the following values:
| PHP Version | Prefix | Dotfile | ionCube | Order |
|---|---|---|---|---|
| 5.6 | php56. |
.php56 |
yes | 1 |
| 7.0 (default) | php70. |
.php70 |
yes | 2 |
| 7.1 | php71. |
.php71 |
no | 3 |
Otherwise you can place a file in /var/www/$project to pin a project to a specific version of PHP (see Dotfile-Column above). That file may be empty, as it's checked for existance only. So to pin a project (e.g. test) to PHP 5.6 run the following command on the web-host (vagrant ssh phoenix-web => touch /var/www/test/.php56). This will make nginx always pass requests to PHP 5.6.
If you place multiple dotfiles in your project directory the engine used is evaluated in the order shown above.
When working on CLI you should specify your PHP Version in detail (e.g. php7.1 /my/awesome/script.php) to prevent falling back to some default (which is PHP 7.0).
ionCube Loader (needed for some commercial Shopware plugins) is available for PHP 5.6 & 7.0 too. It is installed for Cli & FPM. There is no ionCube Loader for PHP 7.1 currently. Keep this in mind while building your Shopware Projects.
All Sites are running under the local.noerdisch.net Domain which is setup on our (read: nœrdisch - digital solutions) internal/external DNS Servers. You should be able to use this box wherever you've access to some DNS Server which does resolve correctly.
There's a vHost in place which makes you able to run (almost) any PHP based application you want. Just put your application into a folder (called $project in the list above/below) underneath /var/www (_vHosts Folder within this repository on your Local Disk) and make sure your document root is living in its subfolder Web (note the uppercase "W"). In case of trouble: symlink (ln -s) is your friend - e.g. for running Laravel or some application which does expect a folder named public, html or anything else.
Your project will be available at: http://project.local.noerdisch.net
This box has been optimized a little to make it work with TYPO3s multi-tree capability (probably other CMS can do this as well) and hit the correct page-tree as configured in TYPO3 CMS backend. You can use your actual production URLs as a part of the request URL using the following pattern:
$engine . $productionurl . $project .local.noerdisch.net
php71 . www.noerdisch.de . noerd .local.noerdisch.net
The box (better: nginx) does set HTTP_HOST & SERVER_NAME to the same values to prevent falling into issues with TYPO3s trusted host patterns. Please keep that in mind and secure your installation accordingly!
Caches are written to /tmp/flow_$project to get them off the NFS shares to improve speed a little. That means you have to prefix your ./flow CLI calls with the environment variable FLOW_PATH_TEMPORARY_BASE pointing to the instance cache folder. Otherwise you might generate two cache versions (one for CLI, one for Web) which might cause unintended behaviour. So your CLI calls to flow should look like this in the end:
FLOW_PATH_TEMPORARY_BASE=/tmp/flow_neosio php71 ./flow doctrine:migrationstatus
Freezing packages (flow package:freeze) generally helps a lot. Keep in mind to unfreeze (flow package:freeze --packagekey=Your.PackageKey) the package(s) you're working on though.
There's another wildcard vHost configured to run Symfony projects. Symfony project are able to live underneath the folder /var/www/sf2/$project (_vHosts/sf2 folder within this repository on your Local Disk - created during vagrant provision).
This is another virtual host on the list as the default rewrite with which you're able to run virtually anything which rewrites its requests to /index.php won't fit for Symfony projects. We need /app.php respectively /app_dev.php here and a lowercase "web" as document root (which does matter on case sensitive filesystems).
Your project will be available at: http://project.local-sf2.noerdisch.net
Apart from Symfony we have another special wildcard vHost configured to run Shopware 5 projects. Shopware 5 project are running in the folder /var/www/sw5/$project (_vHosts/sw5 folder within this repository on your Local Disk - created during vagrant provision).
This is another virtual host on the list as the default rewrite on our "universal vHost" does not fit the needs for Shopware Projects as it needs to rewrite its requests to /shopware.php and has some other rewrites in place to operate properly.
Your project will be available at: http://project.local-sw5.noerdisch.net
If you should have more specific requirements to your nginx configuration (or one of the wildcard configs does not match your needs) you can place your configuration in _nginx-sites.d within this directory. Puppet will copy those files on vagrant provision and include them into nginx main configuration file (make sure your configuration uses suffix .conf to be included).
The stack comes with a MySQL & PostgreSQL database server installed on the host phoenix-db. Instead of typing some IP or long hostnames in your application you can use the shorthandle db as database host from within your applications. The Hostname db does resolve to 192.168.50.51.
You can however use 127.0.0.1:3306 (for MySQL) and 127.0.0.1:5432 (for PostgreSQL) as database server too to provide some sort of "quick-start". Haproxy is in place to handle this and pass traffic from the web- to the database-box.
| Server | Username | Password | Remarks |
|---|---|---|---|
| phoenix-web | vagrant | jolt200mg | your applications should use those credentials |
| phoenix-db | root | jolt200mg | used for maintenance & stuff (MySQL only) |
You can use the database user vagrant to access the MySQL-/PostgreSQL Server from your host using tools like Sequel Pro or MySQL Workbench using the host local.noerdisch.net so you won't need something like phpMyAdmin or Adminer.
The credentials for PostgreSQL are just the same for the user vagrant. You can use tools like phpPgAdmin to connect to PostgreSQL running on the Host db.
The box comes with 2 Elasticsearch nodes running as a cluster (Clustername is noerdlastic_2x_local, the version is pinned to 2.4.3 which marks the current stable 2.x Release).
To access Plugins (see below for a list of installed ones) or use Elasticsearch from your computer in other ways there's a proxy-configuration on haproxy in place which makes you able to use the host http://elasticsearch.local.noerdisch.net:9200.
The box is using Ubuntu 16.04. The base box image is kept up to date on a spare-time base. The box is custom built at nœrdisch - digital solutions for our needs and originally based upon ffuenf/vagrant-boxes.
- MySQL Server 5.7 (credentials: see above)
- PostgreSQL Server 9.5 (username:
vagrant, password:jolt200mg) - Memcached
- Redis Server
- nginx
- PHP (5.6, 7.0, 7.1) as CLI & FastCGI server, "batteries included" (PPA)
- MailHog docker container accessible at http://local.noerdisch.net:8025
- haproxy to pass traffic from web to database box (stats, PPA)
- Elasticsearch 2.x vendor package (accessible at http://elasticsearch.local.noerdisch.net:9200/)
- Docker Engine (vendor package)
- some other tools including:
- git
- tig
- ant
- htop
- mytop
- erlang
- golang
- dnsmasq
- nodejs & npm
- graphicsmagick
- java 1.8 (jre & jdk)
If you'd like to work full-time with this box in a clean, friendly & professional environment: We're looking for Symfony2 developers & Frontend / UI developers with experience in RWD and JavaScript (ES6).
If you're interested get in touch with us: nœrdisch - digital solutions
This Vagrant box is licensed under the permissive MIT license - have fun with it!