Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/alehkot/druphpet

[The project is on hold] A Puppet-based Vagrant VM suitable for instant and unified configuration of Drupal environments.
https://github.com/alehkot/druphpet
Last synced: 2 months ago
JSON representation
[The project is on hold] A Puppet-based Vagrant VM suitable for instant and unified configuration of Drupal environments.
Host: GitHub
URL: https://github.com/alehkot/druphpet
Owner: alehkot
License: gpl-2.0
Archived: true
Created: 2014-05-30T10:18:20.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2017-12-11T18:15:49.000Z (about 7 years ago)
Last Synced: 2024-07-31T18:21:22.126Z (5 months ago)
Language: HTML
Homepage:
Size: 284 KB
Stars: 39
Watchers: 10
Forks: 12
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project

README

        # Druphpet Virtual Machine #

A very fast and Puppet-based Drupal-ready VM suitable for instant and unified configuration of local environments. The ultimate goal of Druphpet is to provide a powerful set of tools out-of-the-box to develop typical enterprise websites with Drupal. You can easily add sites, databases, packages, etc. simply be editing `puphpet/config.yaml` file in YAML format.

Based on VMs by [Puphpet](http://puphpet.com "Puphpet").

The VM includes the fastest option available to synchronize folders in Windows - via SMB share. Please find the instructions below on how to map a network drive.

## Install ##

- Make sure you have the most recent versions of VirtualBox and Vagrant installed (see 'minimum requirements' section).

- Clone the repository `git clone https://github.com/alehkot/druphpet.git`.

- Add any number of Apache hosts and databases you want in appropriate sections of 'puphpet/config.yaml' file.

- Edit your hosts file and add entries for the following (on Windows, `C:\Windows\System32\drivers\etc\hosts`):

```

192.168.9.10 druphpet.dev

192.168.9.10 phpmyadmin.druphpet.dev

192.168.9.10 webgrind.druphpet.dev

192.168.9.10 opcachegui.druphpet.dev

192.168.9.10 phpmemcacheadmin.druphpet.dev

192.168.9.10 pimpmylog.druphpet.dev

```

- Add your hosts, e.g. `192.168.9.10 [yourhost]`

- In the folder with Druphpet in your command line execute `vagrant up`.

- Important! In case of any errors during the initial setup, try to run provision the VM once again: `vagrant reload --provision`. It usually resolves any issues. In the worst case, please follow the instructions in [Known issues](#known-issues).

- If you later decide to expose your VM to the internet, then follow the instructions on [Vagrant Share](http://www.vagrantup.com/blog/feature-preview-vagrant-1-5-share.html).

## Modification ##

- In case you later decide to add new hosts, PHP packages and/or install an additional software, then edit 'puphpet/config.yaml' file.

- Execute `vagrant provision`.

- Execute `vagrant reload`.

## Included ##

- [Ubuntu 64-bit Precise 14.04](http://www.ubuntu.com/)

- [Drush 7.x](http://drush.org/en/master/)

- [Apache 2.4.x](http://httpd.apache.org/) 

- [PHP 5.6.x](http://php.net/) with extensions:

  - _(debugger, pecl)_ [XDebug](http://xdebug.org/)

  - _(profiler, tool, pecl)_ [XHProf](https://github.com/phacility/xhprof)

  - _(pecl)_ [SOAP](http://php.net/manual/en/intro.soap.php)

  - _(pecl)_ [Uploadprogress](http://pecl.php.net/package/uploadprogress)

  - _(pecl)_ [APCu](https://github.com/krakjoe/apcu/blob/simplify/INSTALL)

  - _(pecl)_ [Memcached](http://php.net/manual/en/intro.memcached.php)

  - _(tool, PEAR)_ [PHP_CodeSniffer](http://pear.php.net/package/PHP_CodeSniffer/redirected)

  - _(PEAR)_ [PHP_Console_Table](http://pear.php.net/package/Console_Table)

- [Apache Solr 4.x](http://lucene.apache.org/solr/)

- [OPCacheGUI](https://github.com/PeeHaa/OpCacheGUI)

- [PHPMemcacheAdmin](https://code.google.com/p/phpmemcacheadmin)

- [MySQL 5.6.x](http://www.mysql.com/)

- [dos2unix](http://linuxcommand.org/man_pages/dos2unix1.html)

- [Percona Toolkit](http://www.percona.com/software/percona-toolkit)

- [phpMyAdmin](http://www.phpmyadmin.net/home_page/index.php)

- [PimpMyLog](http://pimpmylog.com/)

- [MailCatcher](http://mailcatcher.me/)

- [ImageMagick](http://www.imagemagick.org/)

- [Webgrind](https://github.com/jokkedk/webgrind)

- [Curl](http://curl.haxx.se/)

- [Sendmail](http://www.linuxserverhowto.com/linux-mail-server-sendmail/index.html)

- [Unzip](http://www.cyberciti.biz/tips/how-can-i-zipping-and-unzipping-files-under-linux.html)

- [Git](http://git-scm.com/)

- [Siege](http://manpages.ubuntu.com/manpages/hardy/man1/siege.1.html)

- [Graphviz](http://www.graphviz.org/)

- [Vsftpd](https://security.appspot.com/vsftpd.html)

- [MC](http://linux.die.net/man/1/mc)

- [Vim](http://www.vim.org/)

- [Samba Server](https://www.samba.org/samba/docs/using_samba/ch02.html)

- [Memcached](http://memcached.org/)

- [Ruby 1.9.3](https://www.ruby-lang.org/) using [RVM](https://rvm.io/) with gems:

  - [Sass](http://sass-lang.com/)

  - [Compass](http://compass-style.org/)

  - [Bundler](http://bundler.io/)

  - [Guard](https://github.com/guard/guard)

  - [Guard-livereload](https://github.com/guard/guard-livereload)

- [Node.js](http://nodejs.org/) with packages:

    - [Yeoman](http://yeoman.io/)

    - [Bower](http://bower.io/)

    - [Grunt](http://gruntjs.com/)

    - [Gulp](http://gulpjs.com/)

    - [Coffee-script](http://coffeescript.org/)

    - [JSHint](http://jshint.com/)

    - [CSSLint](http://csslint.net/)

    - [ESLint](http://eslint.org/)

    - [Nodemon](http://nodemon.io/)

    

## Optional ##

There are the following modules are also preconfigured, but disabled by default:

- [PostgreSQL 9.3](http://www.postgresql.org/)

- [Adminer](http://www.adminer.org/)

- [Varnish](https://www.varnish-cache.org/)

- [New Relic](http://newrelic.com/)

- [RabbitMQ](http://www.rabbitmq.com/) or [Beanstalkd](http://kr.github.io/beanstalkd/)

- [Python](https://www.python.org/)

- [PostgreSQL 9.3](http://www.postgresql.org/)

You can edit `puphpet/config.yaml` file and execute `vagrant reload --provision` to enable the software. Moreover, using this file you can switch from Apache web server to Nginx (but some exclusive Druphpet features might become unavailable, because they are preconfigured for Apache) and/or install additional software packages and PHP extensions.

## Defaults

**Hosts**

- http://druphpet.dev

**FTP**

* Host: 192.168.9.10

* User: vagrant

* Pass: vagrant

**Database Credentials (MySQL, PostgreSQL)**

* Host: 192.168.9.10

* Name: druphpet

* User: druphpet

* Pass: druphpet

* To connect using a MySQL client other than Phpmyadmin, after initial `vagrant up` it's recommended to reboot the VM using `vagrant reload`.

**Mailcatcher**

- http://192.168.9.10:1080

**Xdebug**

- Xdebug is configured to automatically connect back to host if _XDEBUG_SESSION_START_ query parameter is set, e.g. if you access http://druphpet.dev/index.php?XDEBUG_SESSION_START=PHPSTORM.

- To use Xdebug with [Jetbrains PHPStorm](https://www.jetbrains.com/phpstorm/) please follow the [instructions](http://randyfay.com/content/remote-drupalphp-debugging-xdebug-and-phpstorm).

- If upon accessing pages of your website _XDEBUG_SESSION_START_ Xdebug ignores breakpoints you set in your IDE, it might be a case of a misconfigured firewall in your host environment. Try disabling the firewall to see if the issue is resolved.

**XHProf**

- http://192.168.9.10/xhprof/xhprof_html

**PimpMyLog**

- http://pimpmylog.druphpet.dev

**Memcached**

- host: localhost (from VM)

- port: 11211

**Phpmyadmin**

- http://phpmyadmin.druphpet.dev

**Webgrind**

- http://webgrind.druphpet.dev

**OPCacheGUI**

- http://opcachegui.druphpet.dev

- username: druphpet

- password: druphpet

**PHPMemcacheAdmin**

- http://phpmemcacheadmin.druphpet.dev

**RabbitMQ**

- port: 5672

**Apache Solr**

- http://druphpet.dev:8984/solr

**Samba server share (default)**

- \\\192.168.9.10\data

On Windows, after `vagrant up`, you can just open "My computer", click "Map network drive" and enter the address above.

On Mac, In the Finder, choose Go > 'Connect to Server.' Type the following network address: `smb://192.168.9.10/data`

**Varnish**

- Varnish proxifies all requests from port 8080 to port 80, e.g. you can access http://192.168.9.10:8080/webgrind.

- You can edit its config in '/etc/varnish/default.vcl' file.

## Minimum requirements ##

* Git

* VirtualBox 4.3.10

* Vagrant 1.5.4

## Download links (Windows) ##

- [VirtualBox](http://download.virtualbox.org/virtualbox/4.3.10/VirtualBox-4.3.10-93012-Win.exe "Download VirtualBox 4.3.10")

- [Vagrant](https://dl.bintray.com/mitchellh/vagrant/vagrant_1.5.4.msi "Download Vagrant 1.5.4")

- [PowerShell 3](http://www.microsoft.com/en-us/download/details.aspx?id=34595 "Download PowerShell 3")

## Known issues ##

- If you use Vagrant 1.7.3 on Windows and get an error regarding `chown: changing ownership of ???/vagrant???: Not a directory`, then patch your Vagrant `environment.rb` file (e.g. directory location `c:\Vagrant\embedded\gems\gems\vagrant-1.7.3\lib\vagrant\util\`) and replace `def windows_unc_path(path)` method with the following:

```

        # Converts a given path to UNC format by adding a prefix and converting slashes.

        # @param [String] path Path to convert to UNC for Windows

        # @return [String]

        def windows_unc_path(path)

          path.gsub('/', '\\')

        end 

```

- If during `vagrant up` or `vagrant reload` you stuck with a looping error like this `Error: Connection timeout. Retrying...`, then delete all files except `insecure_private_key` in folder `puphpet/files/dot` and try again. 

- If during `vagrant up` or `vagrant reload --provision` or `vagrant provision` you get errors like `default: Stderr: ==> default: error: Your local changes to the following files would be overwritten by checkout:`, then delete all folders in `puphpet/puppet/modules` folder except `.gitkeep` file and try again.

- Windows-only, to enable Samba, follow the instuctions in Vagrantfile.

- Windows-only, if during `vagrant up` you receive the following error:

> "Failed to mount folders in Linux guest. This is usually because the "vboxsf" file system is not available. Please verify that the guest additions are properly installed in the guest and can work properly."

- execute the following statements:

	- `vagrant ssh`

	- `sudo ln -s /opt/VBoxGuestAdditions-4.3.10/lib/VBoxGuestAdditions /usr/lib/VBoxGuestAdditions`

	- `exit`

	- `vagrant reload`

- Windows-only, to enable "rsync", install the latest version of [Cygwin](http://www.cygwin.com) and in setup wizard pick "rsync" package to be installed (it's not included by default). Because Vagrant on Windows uses Cygdrive for rsync, you should `vagrant up` under Cygwin shell (an example location is 'c:\cygwin64\Cygwin.bat').

- Windows only, if during `vagrant up` using Cygwin you receive an error about "nio4r", execute the following statements:

	- `export NIO4R_PURE="yes"`

- Windows-only, if you receive the following error:

> "Vagrant uses the `VBoxManage` binary that ships with VirtualBox, and requires this to be available on the PATH. If VirtualBox is installed, please find the `VBoxManage` binary and add it to the PATH environmental variable."

- during `vagrant up` execution, then execute the following command:

	- `set PATH=%PATH%;C:\Program Files\Oracle\VirtualBox`

- If you experience problems with remote debugging (PHP, NodeJS) and don't want (or can't) configure your firewall try creating SSH-tunnels as following:

  - PHP: `ssh -R 9000:localhost:9000 [email protected]`

  - NodeJS: `ssh -L 5858:127.0.0.1:5858 [email protected] -N`

- It is strongly recommended to reboot the VM after successful provisioning using `vagrant reload`.

- 

- In case of a public key warning with the previous commands try to delete your known_hosts file.

- You can change the sync_modules variable to false after the first time your box is provisioned.

- If you receive the error `Error: Unknown function loadyaml`, switch 'sync_modules' property in config.yaml to `true`.