Homeboy
Tool for automating sites using Laravel Homestead. With one command, Homeboy will be able to:, (*1)
- Install Laravel (or another project package) into a new directory via composer
- Update your host file to point your dev domain to your homestead IP
- Update your Homestead.yaml file mapping to include your new project
- Update your Homestead.yaml file to create a database for your project
- Re-provision Vagrant
You can also use homeboy to provision non-laravel websites!, (*2)
, (*3)
Table of Contents
Requirements
On your local (non homestead) machine, Homeboy requires:
- Git
- PHP
- Composer, (*4)
Installation
Install as a global composer package
composer global require "kilroyweb/homeboy" dev-master
Make sure to place the $HOME/.composer/vendor/bin directory (or the equivalent directory for your OS)
in your $PATH so the laravel executable can be located by your system., (*5)
Once installed, you can use homeboy command from anywhere on your system., (*6)
Run the setup command to generate a .env file, (*7)
php homeboy setup
Install using git clone
- On your local machine, clone Homeboy
cd ~
git clone https://github.com/kilroyweb/homeboy.git homeboy
- Within the homeboy directoy, run composer
cd homeboy
composer install
Run the setup command to generate a .env file, (*8)
php homeboy setup
By this point, you should be able to run homeboy within the directory using the command:, (*9)
php homeboy
- Create an alias to run homeboy from any directory:
On mac (in ~/.bash_profile) add:, (*10)
alias homeboy='php ~/homeboy/homeboy'
On windows, an alias can be added using something like if using a tool like Cmder, (*11)
homeboy=php C:\Users\[USER]\homeboy\homeboy $*
be sure to edit the path based on where homeboy is installed, (*12)
Setting Configuration
After running homeboy setup, you should have a .env file in your homeboy directory with a few defaults that have been generated., (*13)
These options will likely need to be updated based on your particular setup, details about each available setting are listed below:, (*14)
USE_COMPOSER
Default option to determine if homeboy should create a new composer project, (*15)
USE_COMPOSER=true
DEFAULT_COMPOSER_PROJECT
Default package used when creating a composer project, (*16)
DEFAULT_COMPOSER_PROJECT=laravel/laravel
DEFAULT_FOLDER_SUFFIX
When hosting a new project, the default directory that nginx would define as the document root. For Laravel projects, by default this is "/public", (*17)
DEFAULT_FOLDER_SUFFIX=/public
DEFAULT_DOMAIN_EXTENSION
When creating development domains, the default domain suffix given when a domain is generated, (*18)
DEFAULT_DOMAIN_EXTENSION=.app
HOSTS_FILE_PATH
The location to your local hosts file that homeboy will add to when hosting new projects, (*19)
This file will need to have permissions adjusted to be editable by homeboy, (*20)
HOSTS_FILE_PATH=/etc/hosts
HOMESTEAD_HOST_IP
The ip address given to your homestead virtual machine. This is likely found in your Homestead.yaml file, (*21)
HOMESTEAD_HOST_IP=192.168.10.10
HOMESTEAD_FILE_PATH
The location to your Homestead.yaml file. Homeboy will update this file's sites list and database list when creating new projects, (*22)
HOMESTEAD_FILE_PATH=/Users/Username/Homestead/Homestead.yaml
HOMESTEAD_SITES_PATH
The root path to your websites in your homestead virtual machine, (*23)
HOMESTEAD_SITES_PATH=/home/vagrant/Code/
HOMESTEAD_BOX_PATH
The path to your Homestead directory, (*24)
HOMESTEAD_BOX_PATH=/Users/Username/Homestead
LOCAL_SITES_PATH
The path on your local machine to where you store your projects. Homeboy will cd into this directory when running "composer create-project ...", (*25)
LOCAL_SITES_PATH=/Users/Username/Code
HOMESTEAD_ACCESS_DIRECTORY_COMMAND
In Windows if you are running Homestead on a different drive, an extra command may be required to switch drives before cd'ing into your directory., (*26)
This option will cause Homeboy to ignore the option: HOMESTEAD_BOX_PATH, (*27)
HOMESTEAD_ACCESS_DIRECTORY_COMMAND="cd /d D: && cd /Homestead"
ACCESS_LOCAL_SITES_DIRECTORY_COMMAND
Similar to HOMESTEAD_ACCESS_DIRECTORY_COMMAND, In Windows if your root project directory is on a different drive, an extra command may be required to switch drives before cd'ing into your directory., (*28)
This option will cause Homeboy to ignore the option: LOCAL_SITES_PATH, (*29)
ACCESS_LOCAL_SITES_DIRECTORY_COMMAND="cd /d D: && cd /Code"
Homeboy Commands
Host
homeboy host
Because this is the default command, you can run host by simply running:, (*30)
homeboy
Running this command automates the task of creating a new composer project, updating your hosts file and vagrant files when provisioning a new website, (*31)
When the command runs, it prompts for the sites directory name, database name, and dev url to update the needed files and then provisions vagrant, (*32)
A few options have been added to speed up the command. However because the command "homeboy" is simply a shortcut for "homeboy host" (allowing us to add additional commands in the future), options only work when calling "homeboy host" rather than just "homeboy"., (*33)
Some options available:, (*34)
-
--use-defaults : Automatically accept defaults before provisioning
-
--skip-confirmation : Automatically confirm before running task
-
--name : Directory name to create project in
-
--database : Database to add to homestead
-
--domain : Development domain
The following example will run all tasks automatically without any question prompts:, (*35)
homeboy host --name=my-project --use-defaults --skip-confirmation
Vagrant
Homeboy also contains the "vagrant:run" command, allowing you to quickly run any vagrant command without having to cd into that directory, ie:, (*36)
homeboy vagrant:run status
File
Quickly view a file contents by running:, (*37)
homeboy file hosts
or, (*38)
homeboy file homestead
Domain
The domain command lets you quickly add a new domain record to your hosts file., (*39)
homeboy domain
Composer
The composer:create-project command prompts you details on running a "composer create-project [composer-project] [project-name]" command, (*40)
homeboy composer:create-project
Troubleshooting
hosts file is not writable
Your host file will need to be writable by homeboy. In many cases this can be solved with a command like:, (*41)
sudo chmod 664 /etc/hosts, (*42)
This may vary depending on your platform / environment, (*43)
Homeboy is running composer install within my current directory, rather than my defined LOCAL_SITES_PATH
A common cause of this on Windows is when LOCAL_SITES_PATH is in a different drive than where the homeboy command is being run. Since Windows must first change drives before cd'ing into the directory, you can use the "ACCESS_LOCAL_SITES_DIRECTORY_COMMAND" to overwrite how homeboy accesses this directory. For example:, (*44)
ACCESS_LOCAL_SITES_DIRECTORY_COMMAND="cd /d D: && cd /Code"
Vagrant returns "A Vagrant environment or target machine is required to run this command"
This message will be displayed when Homeboy is unable to cd into the proper vagrant directory when running vagrant commands. Please verify your "HOMESTEAD_BOX_PATH" value to ensure it is correct., (*45)
On Windows, if your HOMESTEAD_BOX_PATH is in a different drive than the drive you are running your homeboy command, you may need to add the "HOMESTEAD_ACCESS_DIRECTORY_COMMAND" to add any additional commands (such as switching drives) when accessing the directory. For example:, (*46)
HOMESTEAD_ACCESS_DIRECTORY_COMMAND="cd /d D: && cd /Homestead"
Wallogit.com
