/scripts/homestead.rb
# Main Homestead Class
class Homestead
def self.configure(config, settings)
# 仮想マシンプロバイダの設定 [ => Virtualbox]
# Set The VM Provider
ENV['VAGRANT_DEFAULT_PROVIDER'] = settings['provider'] ||= 'virtualbox'
# 仮想マシン外からスクリプトへアクセスできるように設定していく
# Configure Local Variable To Access Scripts From Remote Location
script_dir = File.dirname(__FILE__)
# Allow SSH Agent Forward from The Box
config.ssh.forward_agent = true
# Configure Verify Host Key
if settings.has_key?('verify_host_key')
config.ssh.verify_host_key = settings['verify_host_key']
end
# 使用する仮想マシンのイメージは、laravel/homesteadを適用
# Configure The Box
config.vm.define settings['name'] ||= 'homestead'
config.vm.box = settings['box'] ||= 'laravel/homestead'
unless settings.has_key?('SpeakFriendAndEnter')
config.vm.box_version = settings['version'] ||= '>= 9.0.0'
end
config.vm.hostname = settings['hostname'] ||= 'homestead'
# 仮想マシンとホストマシンのやり取りをする為に、プライベートIPの設定
# Configure A Private Network IP
if settings['ip'] != 'autonetwork'
config.vm.network :private_network, ip: settings['ip'] ||= '192.168.10.10'
else
config.vm.network :private_network, ip: '0.0.0.0', auto_network: true
end
# Configure Additional Networks
if settings.has_key?('networks')
settings['networks'].each do |network|
config.vm.network network['type'], ip: network['ip'], mac: network['mac'], bridge: network['bridge'] ||= nil, netmask: network['netmask'] ||= '255.255.255.0'
end
end
# Configure A Few VirtualBox Settings
config.vm.provider 'virtualbox' do |vb|
vb.name = settings['name'] ||= 'homestead'
vb.customize ['modifyvm', :id, '--memory', settings['memory'] ||= '2048']
vb.customize ['modifyvm', :id, '--cpus', settings['cpus'] ||= '1']
vb.customize ['modifyvm', :id, '--natdnsproxy1', 'on']
vb.customize ['modifyvm', :id, '--natdnshostresolver1', settings['natdnshostresolver'] ||= 'on']
vb.customize ['modifyvm', :id, '--ostype', 'Ubuntu_64']
if settings.has_key?('gui') && settings['gui']
vb.gui = true
end
end
# 仮想マシン側で解放するSSHポート番号を変更
# Override Default SSH port on the host
if settings.has_key?('default_ssh_port')
config.vm.network :forwarded_port, guest: 22, host: settings['default_ssh_port'], auto_correct: false, id: "ssh"
end
# (プロバイダにVirtualboxを使用しているので省略)
# Configure A Few VMware Settings
['vmware_fusion', 'vmware_workstation'].each do |vmware|
config.vm.provider vmware do |v|
v.vmx['displayName'] = settings['name'] ||= 'homestead'
v.vmx['memsize'] = settings['memory'] ||= 2048
v.vmx['numvcpus'] = settings['cpus'] ||= 1
v.vmx['guestOS'] = 'ubuntu-64'
if settings.has_key?('gui') && settings['gui']
v.gui = true
end
end
end
# (プロバイダにVirtualboxを使用しているので省略)
# Configure A Few Hyper-V Settings
config.vm.provider "hyperv" do |h, override|
h.vmname = settings['name'] ||= 'homestead'
h.cpus = settings['cpus'] ||= 1
h.memory = settings['memory'] ||= 2048
h.linked_clone = true
if Vagrant.has_plugin?('vagrant-hostmanager')
override.hostmanager.ignore_private_ip = true
end
end
# Configure A Few Parallels Settings
config.vm.provider 'parallels' do |v|
v.name = settings['name'] ||= 'homestead'
v.update_guest_tools = settings['update_parallels_tools'] ||= false
v.memory = settings['memory'] ||= 2048
v.cpus = settings['cpus'] ||= 1
end
# Standardize Ports Naming Schema
if settings.has_key?('ports')
settings['ports'].each do |port|
port['guest'] ||= port['to']
port['host'] ||= port['send']
port['protocol'] ||= 'tcp'
end
else
settings['ports'] = []
end
# ポートフォワーディングを設定
# HTTP, HTTPS, MySQL(3306), Postgre(5432), mongoDB(27017)
# Default Port Forwarding
default_ports = {
80 => 8000,
443 => 44300,
3306 => 33060,
4040 => 4040,
5432 => 54320,
8025 => 8025,
9600 => 9600,
27017 => 27017
}
# Use Default Port Forwarding Unless Overridden
unless settings.has_key?('default_ports') && settings['default_ports'] == false
default_ports.each do |guest, host|
unless settings['ports'].any? { |mapping| mapping['guest'] == guest }
config.vm.network 'forwarded_port', guest: guest, host: host, auto_correct: true
end
end
end
# Add Custom Ports From Configuration
if settings.has_key?('ports')
settings['ports'].each do |port|
config.vm.network 'forwarded_port', guest: port['guest'], host: port['host'], protocol: port['protocol'], auto_correct: true
end
end
# Configure The Public Key For SSH Access
if settings.include? 'authorize'
if File.exist? File.expand_path(settings['authorize'])
config.vm.provision 'shell' do |s|
s.inline = "echo $1 | grep -xq \"$1\" /home/vagrant/.ssh/authorized_keys || echo \"\n$1\" | tee -a /home/vagrant/.ssh/authorized_keys"
s.args = [File.read(File.expand_path(settings['authorize']))]
end
end
end
# Copy The SSH Private Keys To The Box
if settings.include? 'keys'
if settings['keys'].to_s.length.zero?
puts 'Check your Homestead.yaml file, you have no private key(s) specified.'
exit
end
settings['keys'].each do |key|
if File.exist? File.expand_path(key)
config.vm.provision 'shell' do |s|
s.privileged = false
s.inline = "echo \"$1\" > /home/vagrant/.ssh/$2 && chmod 600 /home/vagrant/.ssh/$2"
s.args = [File.read(File.expand_path(key)), key.split('/').last]
end
else
puts 'Check your Homestead.yaml (or Homestead.json) file, the path to your private key does not exist.'
exit
end
end
end
# Copy User Files Over to VM
if settings.include? 'copy'
settings['copy'].each do |file|
config.vm.provision 'file' do |f|
f.source = File.expand_path(file['from'])
f.destination = file['to'].chomp('/') + '/' + file['from'].split('/').last
end
end
end
# Register All Of The Configured Shared Folders
if settings.include? 'folders'
settings['folders'].each do |folder|
if File.exist? File.expand_path(folder['map'])
mount_opts = []
if ENV['VAGRANT_DEFAULT_PROVIDER'] == 'hyperv'
folder['type'] = 'smb'
end
if folder['type'] == 'nfs'
mount_opts = folder['mount_options'] ? folder['mount_options'] : ['actimeo=1', 'nolock']
elsif folder['type'] == 'smb'
mount_opts = folder['mount_options'] ? folder['mount_options'] : ['vers=3.02', 'mfsymlinks']
smb_creds = {smb_host: folder['smb_host'], smb_username: folder['smb_username'], smb_password: folder['smb_password']}
end
# For b/w compatibility keep separate 'mount_opts', but merge with options
options = (folder['options'] || {}).merge({ mount_options: mount_opts }).merge(smb_creds || {})
# Double-splat (**) operator only works with symbol keys, so convert
options.keys.each{|k| options[k.to_sym] = options.delete(k) }
config.vm.synced_folder folder['map'], folder['to'], type: folder['type'] ||= nil, **options
# Bindfs support to fix shared folder (NFS) permission issue on Mac
if folder['type'] == 'nfs' && Vagrant.has_plugin?('vagrant-bindfs')
config.bindfs.bind_folder folder['to'], folder['to']
end
else
config.vm.provision 'shell' do |s|
s.inline = ">&2 echo \"Unable to mount one of your folders. Please check your folders in Homestead.yaml\""
end
end
end
end
# Change PHP CLI version based on configuration
if settings.has_key?('php') && settings['php']
config.vm.provision 'shell' do |s|
s.name = 'Changing PHP CLI Version'
s.inline = "sudo update-alternatives --set php /usr/bin/php#{settings['php']}; sudo update-alternatives --set php-config /usr/bin/php-config#{settings['php']}; sudo update-alternatives --set phpize /usr/bin/phpize#{settings['php']}"
end
end
# Creates folder for opt-in features lockfiles
config.vm.provision "shell", inline: "mkdir -p /home/vagrant/.homestead-features"
config.vm.provision "shell", inline: "chown -Rf vagrant:vagrant /home/vagrant/.homestead-features"
# Install opt-in features
if settings.has_key?('features')
settings['features'].each do |feature|
feature_name = feature.keys[0]
feature_variables = feature[feature_name]
feature_path = script_dir + "/features/" + feature_name + ".sh"
# Check for boolean parameters
# Compares against true/false to show that it really means "<feature>: <boolean>"
if feature_variables == false
config.vm.provision "shell", inline: "echo Ignoring feature: #{feature_name} because it is set to false \n"
next
elsif feature_variables == true
# If feature_arguments is true, set it to empty, so it could be passed to script without problem
feature_variables = {}
end
# Check if feature really exists
if !File.exist? File.expand_path(feature_path)
config.vm.provision "shell", inline: "echo Invalid feature: #{feature_name} \n"
next
end
config.vm.provision "shell" do |s|
s.name = "Installing " + feature_name
s.path = feature_path
s.env = feature_variables
end
end
end
# Clear any existing nginx sites
config.vm.provision 'shell' do |s|
s.path = script_dir + '/clear-nginx.sh'
end
# Clear any Homestead sites and insert markers in /etc/hosts
config.vm.provision 'shell' do |s|
s.path = script_dir + '/hosts-reset.sh'
end
# Install All The Configured Nginx Sites
if settings.include? 'sites'
domains = []
settings['sites'].each do |site|
domains.push(site['map'])
# Create SSL certificate
config.vm.provision 'shell' do |s|
s.name = 'Creating Certificate: ' + site['map']
s.path = script_dir + '/create-certificate.sh'
s.args = [site['map']]
end
type = site['type'] ||= 'laravel'
load_balancer = settings['load_balancer'] ||= false
http_port = load_balancer ? '8111' : '80'
https_port = load_balancer ? '8112' : '443'
if load_balancer
config.vm.provision 'shell' do |s|
s.path = script_dir + '/install-load-balancer.sh'
end
end
case type
when 'apigility'
type = 'zf'
when 'expressive'
type = 'zf'
when 'symfony'
type = 'symfony2'
end
config.vm.provision 'shell' do |s|
s.name = 'Creating Site: ' + site['map']
if site.include? 'params'
params = '('
site['params'].each do |param|
params += ' [' + param['key'] + ']=' + param['value']
end
params += ' )'
end
if site.include? 'headers'
headers = '('
site['headers'].each do |header|
headers += ' [' + header['key'] + ']=' + header['value']
end
headers += ' )'
end
if site.include? 'rewrites'
rewrites = '('
site['rewrites'].each do |rewrite|
rewrites += ' [' + rewrite['map'] + ']=' + "'" + rewrite['to'] + "'"
end
rewrites += ' )'
# Escape variables for bash
rewrites.gsub! '$', '\$'
end
# Convert the site & any options to an array of arguments passed to the
# specific site type script (defaults to laravel)
s.path = script_dir + "/site-types/#{type}.sh"
s.args = [
site['map'], # $1
site['to'], # $2
site['port'] ||= http_port, # $3
site['ssl'] ||= https_port, # $4
site['php'] ||= '7.4', # $5
params ||= '', # $6
site['xhgui'] ||= '', # $7
site['exec'] ||= 'false', # $8
headers ||= '', # $9
rewrites ||= '' # $10
]
# generate pm2 json config file
if site['pm2']
config.vm.provision "shell" do |s2|
s2.name = 'Creating Site Ecosystem for pm2: ' + site['map']
s2.path = script_dir + "/create-ecosystem.sh"
s2.args = Array.new
s2.args << site['pm2'][0]['name']
s2.args << site['pm2'][0]['script'] ||= "npm"
s2.args << site['pm2'][0]['args'] ||= "run serve"
s2.args << site['pm2'][0]['cwd']
end
end
if site['xhgui'] == 'true'
config.vm.provision 'shell' do |s|
s.path = script_dir + '/features/mongodb.sh'
end
config.vm.provision 'shell' do |s|
s.path = script_dir + '/install-xhgui.sh'
end
config.vm.provision 'shell' do |s|
s.inline = 'ln -sf /opt/xhgui/webroot ' + site['to'] + '/xhgui'
end
else
config.vm.provision 'shell' do |s|
s.inline = 'rm -rf ' + site['to'].to_s + '/xhgui'
end
end
end
config.vm.provision 'shell' do |s|
s.path = script_dir + "/hosts-add.sh"
s.args = ['127.0.0.1', site['map']]
end
# Configure The Cron Schedule
if site.has_key?('schedule')
config.vm.provision 'shell' do |s|
s.name = 'Creating Schedule'
if site['schedule']
s.path = script_dir + '/cron-schedule.sh'
s.args = [site['map'].tr('^A-Za-z0-9', ''), site['to']]
else
s.inline = "rm -f /etc/cron.d/$1"
s.args = [site['map'].tr('^A-Za-z0-9', '')]
end
end
else
config.vm.provision 'shell' do |s|
s.name = 'Checking for old Schedule'
s.inline = "rm -f /etc/cron.d/$1"
s.args = [site['map'].tr('^A-Za-z0-9', '')]
end
end
end
# config.vm.provision 'shell' do |s|
# s.name = 'Configure Avahi Service'
# s.path = script_dir + '/configure-avahi.sh'
# s.args = domains.join(",")
# end
end
# Configure All Of The Server Environment Variables
config.vm.provision 'shell' do |s|
s.name = 'Clear Variables'
s.path = script_dir + '/clear-variables.sh'
end
if settings.has_key?('variables')
settings['variables'].each do |var|
config.vm.provision 'shell' do |s|
s.inline = "echo \"\nenv[$1] = '$2'\" >> /etc/php/5.6/fpm/pool.d/www.conf"
s.args = [var['key'], var['value']]
end
config.vm.provision 'shell' do |s|
s.inline = "echo \"\nenv[$1] = '$2'\" >> /etc/php/7.0/fpm/pool.d/www.conf"
s.args = [var['key'], var['value']]
end
config.vm.provision 'shell' do |s|
s.inline = "echo \"\nenv[$1] = '$2'\" >> /etc/php/7.1/fpm/pool.d/www.conf"
s.args = [var['key'], var['value']]
end
config.vm.provision 'shell' do |s|
s.inline = "echo \"\nenv[$1] = '$2'\" >> /etc/php/7.2/fpm/pool.d/www.conf"
s.args = [var['key'], var['value']]
end
config.vm.provision 'shell' do |s|
s.inline = "echo \"\nenv[$1] = '$2'\" >> /etc/php/7.3/fpm/pool.d/www.conf"
s.args = [var['key'], var['value']]
end
config.vm.provision 'shell' do |s|
s.inline = "echo \"\nenv[$1] = '$2'\" >> /etc/php/7.4/fpm/pool.d/www.conf"
s.args = [var['key'], var['value']]
end
config.vm.provision 'shell' do |s|
s.inline = "echo \"\n# Set Homestead Environment Variable\nexport $1=$2\" >> /home/vagrant/.profile"
s.args = [var['key'], var['value']]
end
end
config.vm.provision 'shell' do |s|
s.inline = 'service php5.6-fpm restart;service php7.0-fpm restart;service php7.1-fpm restart; service php7.2-fpm restart; service php7.3-fpm restart; service php7.4-fpm restart;'
end
end
config.vm.provision 'shell' do |s|
s.name = 'Restarting Cron'
s.inline = 'sudo service cron restart'
end
config.vm.provision 'shell' do |s|
s.name = 'Restarting Nginx'
s.inline = 'sudo service nginx restart;sudo service php5.6-fpm restart;sudo service php7.0-fpm restart;sudo service php7.1-fpm restart; sudo service php7.2-fpm restart; sudo service php7.3-fpm restart; sudo service php7.4-fpm restart;'
end
# Configure All Of The Configured Databases
if settings.has_key?('databases')
# Check which databases are enabled
enabled_databases = Array.new
if settings.has_key?('features')
settings['features'].each do |feature|
feature_name = feature.keys[0]
feature_arguments = feature[feature_name]
# If feature is set to false, ignore
if feature_arguments == false
next
end
enabled_databases.push feature_name
end
end
settings['databases'].each do |db|
config.vm.provision 'shell' do |s|
s.name = 'Creating MySQL Database: ' + db
s.path = script_dir + '/create-mysql.sh'
s.args = [db]
end
config.vm.provision 'shell' do |s|
s.name = 'Creating Postgres Database: ' + db
s.path = script_dir + '/create-postgres.sh'
s.args = [db]
end
if enabled_databases.include? 'mongodb'
config.vm.provision 'shell' do |s|
s.name = 'Creating Mongo Database: ' + db
s.path = script_dir + '/create-mongo.sh'
s.args = [db]
end
end
if enabled_databases.include? 'couchdb'
config.vm.provision 'shell' do |s|
s.name = 'Creating Couch Database: ' + db
s.path = script_dir + '/create-couch.sh'
s.args = [db]
end
end
if enabled_databases.include? 'influxdb'
config.vm.provision 'shell' do |s|
s.name = 'Creating InfluxDB Database: ' + db
s.path = script_dir + '/create-influxdb.sh'
s.args = [db]
end
end
end
end
# Create Minio Buckets
if settings.has_key?('buckets') && settings['features'].any? { |feature| feature.include?('minio') }
settings['buckets'].each do |bucket|
config.vm.provision 'shell' do |s|
s.name = 'Creating Minio Bucket: ' + bucket['name']
s.path = script_dir + '/create-minio-bucket.sh'
s.args = [bucket['name'], bucket['policy'] || 'none']
end
end
end
# Update Composer On Every Provision
config.vm.provision 'shell' do |s|
s.name = 'Update Composer'
s.inline = 'sudo chown -R vagrant:vagrant /usr/local/bin && sudo -u vagrant /usr/local/bin/composer self-update --no-progress && sudo chown -R vagrant:vagrant /home/vagrant/.composer/'
s.privileged = false
end
# Add config file for ngrok
config.vm.provision 'shell' do |s|
s.path = script_dir + '/create-ngrok.sh'
s.args = [settings['ip']]
s.privileged = false
end
config.vm.provision 'shell' do |s|
s.name = 'Update motd'
s.inline = 'sudo service motd-news restart'
end
if settings.has_key?('backup') && settings['backup'] && (Vagrant::VERSION >= '2.1.0' || Vagrant.has_plugin?('vagrant-triggers'))
dir_prefix = '/vagrant/'
settings['databases'].each do |database|
Homestead.backup_mysql(database, "#{dir_prefix}/mysql_backup", config)
Homestead.backup_postgres(database, "#{dir_prefix}/postgres_backup", config)
end
end
# Turn off CFQ scheduler idling https://github.com/laravel/homestead/issues/896
if settings.has_key?('disable_cfq')
config.vm.provision 'shell' do |s|
s.inline = 'sudo sh -c "echo 0 >> /sys/block/sda/queue/iosched/slice_idle"'
end
config.vm.provision 'shell' do |s|
s.inline = 'sudo sh -c "echo 0 >> /sys/block/sda/queue/iosched/group_idle"'
end
end
end
def self.backup_mysql(database, dir, config)
now = Time.now.strftime("%Y%m%d%H%M")
config.trigger.before :destroy do |trigger|
trigger.warn = "Backing up mysql database #{database}..."
trigger.run_remote = { inline: "mkdir -p #{dir} && mysqldump --routines #{database} > #{dir}/#{database}-#{now}.sql" }
end
end
def self.backup_postgres(database, dir, config)
now = Time.now.strftime("%Y%m%d%H%M")
config.trigger.before :destroy do |trigger|
trigger.warn = "Backing up postgres database #{database}..."
trigger.run_remote = { inline: "mkdir -p #{dir} && echo localhost:5432:#{database}:homestead:secret > ~/.pgpass && chmod 600 ~/.pgpass && pg_dump -U homestead -h localhost #{database} > #{dir}/#{database}-#{now}.sql" }
end
end
end