|
1 | | -# fast-hypernode |
| 1 | +# Fast Hypernode Vagrant Box |
| 2 | + |
| 3 | +**The fastest Magento Vagrant VM** |
2 | 4 | Fast Byte Hypernode Box (Uses nfs_guest plugin for file shares) |
| 5 | + |
| 6 | +Based on images from https://github.com/byteinternet/hypernode-vagrant |
| 7 | + |
| 8 | +# Installation |
| 9 | + |
| 10 | +Installation is possible via composer: |
| 11 | + |
| 12 | +```bash |
| 13 | +composer create-project --keep-vcs ecomdev/fast-hypernode |
| 14 | +``` |
| 15 | + |
| 16 | + |
| 17 | + |
| 18 | +# Required Vagrant plugins |
| 19 | + |
| 20 | +* vagrant-hostmanager |
| 21 | +* vagrant-auto_network |
| 22 | +* vagrant-nfs_guest |
| 23 | + |
| 24 | + |
| 25 | +# Usage |
| 26 | + |
| 27 | +1. Copy config.rb.dst to config.rb |
| 28 | +2. Edit it to reflect your project settings |
| 29 | +```ruby |
| 30 | +name 'your-project-name' |
| 31 | +hostname name + '.box' # will be your main url http://your-project-name.box/ |
| 32 | +domains %w(www.your-project-name-additional.box) # additional domain names separated by space |
| 33 | +profiler true # Add tideways-profiler ? |
| 34 | +developer true # Enable development mode? |
| 35 | +directory 'server' # Directory into which NFS share will be mounted on your host |
| 36 | +``` |
| 37 | + |
| 38 | +# Configuration Options |
| 39 | + |
| 40 | +* `name` - name of your node |
| 41 | +* `hostname` - default project hostname |
| 42 | +* `domains` - list of additional domain names for your project |
| 43 | +* `varnish` - enable or disable varnish for your project (default: `false`) |
| 44 | +* `profiler` - enable or disable tideways-profiler (default: `false`) |
| 45 | +* `developer` - enable or disable developer mode in Magento (default: `false`) |
| 46 | +* `magento2` - Magento 2.0 installment? (default: `false`) |
| 47 | +* `install` - Shall Magento be installed? (default: `false`, only Magento 2.0 installation supported) |
| 48 | +* `shell` - Install FishShell? (default: `false`) |
| 49 | +* `php7` - PHP7 instead of PHP5? (default: `false`) |
| 50 | +* `cpu` - number of CPUs to dedicate to your VM (default: `1`) |
| 51 | +* `memory` - memory in MB to dedicate to your VM (default: `1024`) |
| 52 | +* `user` - User name for nfs share permissions (default: `app`) |
| 53 | +* `group` - Group name for nfs share permissions (default: `app`) |
| 54 | +* `uid` - User ID of your host to be mapped to linux VM (default: `Process.euid`) |
| 55 | +* `gid` - Group ID of your host to be mapped to linux VM (default: `Process.egid`) |
| 56 | +* `directory` - Directory to be used as mount on host machine (default: `server`) |
| 57 | +* `network` - Network mast for automatical network assignment to VM (default: `33.33.33.0/24`) |
| 58 | + |
| 59 | +# Adding custom shell provisioners |
| 60 | + |
| 61 | +You can easily add more provision shell scripts from configuration file (config.rb): |
| 62 | +```ruby |
| 63 | +add_shell 'some-custom-shell-script.sh' |
| 64 | + |
| 65 | +# Will provision only if PHP7 flag is turned on |
| 66 | +add_shell 'some-custom-script-for-php7.sh', :php7 |
| 67 | +``` |
0 commit comments