Download the PHP package kilroyweb/homeboy without Composer
On this page you can find all versions of the php package kilroyweb/homeboy. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kilroyweb/homeboy
More information about kilroyweb/homeboy
Files in kilroyweb/homeboy
Package homeboy
Short Description Tool for automating sites using Laravel Homestead
License
Informations about the package homeboy
Homeboy
Tool for automating sites using Laravel Homestead. With one command, Homeboy will be able to:
- 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!
Table of Contents
- Requirements
- Installation
- Install as a global composer package (recommended)
- Install using git clone
- Setting Configuration
- Homeboy Commands
- Host
- File
- Vagrant
- Domain
- Composer
- Troubleshooting
Requirements
On your local (non homestead) machine, Homeboy requires:
- Git
- PHP
- Composer
Installation
Install as a global composer package
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.
Once installed, you can use homeboy
command from anywhere on your system.
Run the setup command to generate a .env file
Install using git clone
-
On your local machine, clone Homeboy
- Within the homeboy directoy, run composer
Run the setup command to generate a .env file
By this point, you should be able to run homeboy within the directory using the command:
- Create an alias to run homeboy from any directory:
On mac (in ~/.bash_profile) add:
On windows, an alias can be added using something like if using a tool like Cmder
be sure to edit the path based on where homeboy is installed
Setting Configuration
After running , you should have a .env file in your homeboy directory with a few defaults that have been generated.
These options will likely need to be updated based on your particular setup, details about each available setting are listed below:
USE_COMPOSER
Default option to determine if homeboy should create a new composer project
DEFAULT_COMPOSER_PROJECT
Default package used when creating a composer project
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"
DEFAULT_DOMAIN_EXTENSION
When creating development domains, the default domain suffix given when a domain is generated
HOSTS_FILE_PATH
The location to your local hosts file that homeboy will add to when hosting new projects
This file will need to have permissions adjusted to be editable by homeboy
HOMESTEAD_HOST_IP
The ip address given to your homestead virtual machine. This is likely found in your Homestead.yaml file
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
HOMESTEAD_SITES_PATH
The root path to your websites in your homestead virtual machine
HOMESTEAD_BOX_PATH
The path to your Homestead directory
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 ..."
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.
This option will cause Homeboy to ignore the option: HOMESTEAD_BOX_PATH
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.
This option will cause Homeboy to ignore the option: LOCAL_SITES_PATH
Homeboy Commands
Host
Because this is the default command, you can run host by simply running:
Running this command automates the task of creating a new composer project, updating your hosts file and vagrant files when provisioning a new website
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
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".
Some options available:
- : Automatically accept defaults before provisioning
- : Automatically confirm before running task
- : Directory name to create project in
- : Database to add to homestead
- : Development domain
The following example will run all tasks automatically without any question prompts:
Vagrant
Homeboy also contains the "vagrant:run" command, allowing you to quickly run any vagrant command without having to cd into that directory, ie:
File
Quickly view a file contents by running:
or
Domain
The domain command lets you quickly add a new domain record to your hosts file.
Composer
The composer:create-project command prompts you details on running a "composer create-project [composer-project] [project-name]" command
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:
This may vary depending on your platform / environment
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:
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.
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: