This repository is Cast Iron Coding's homebrew tap used to support setting up projects and running services on development workstations. It supports the one script to rule them all convention that we will use going forward. We used to use Boxen. Now we use Strap and this tap.
The functionality in this repository is not compatible with Boxen. Boxen should be completely removed from your machine before attempting to use this tap. Things will break if you try to use this alongside Boxen.
- Boxen has been fully removed from your machine.
- You have a current, up-to-date version of homebrew. Run
brew updateand address any problems until you can run it without issue. - You can run
brew doctorwithout any problems being reported.
Installation is simple. Run the following command to install. The tap command clones this repository to /usr/local/Homebrew/Library/Taps/castiron/homebrew-bootstrap. If you're going to be contributing to this repo, consider symlinking ~/src/homebrew-bootstrap to that path.
brew tap castiron/bootstrapThis tap provides homebrew commands and formulas. Any script (ruby or bash) in the cmd directory can be called through homebrew. For example, cmd/brew-bootstrap-rbenv-ruby.rb is executed with the following command:
brew bootstrap-rbenv-rubySome of the commands take arguments. Most do not.
Ensures that nodenv is installed, that your bash_profile is initializing nodenv correctly, and installs the version of node specified in .node-version if necessary. This command is a helper command meant to be called from scripts.
$ brew bootstrap-nodenv-node
Ensures that phpenv is installed, that your bash_profile is initializing phpenv correctly, and installs the version of php specified in .php-version if necessary. This command is a helper command meant to be called from scripts.
$ brew bootstrap-nodenv-node
Ensures that rbenv is installed, that your bash_profile is initializing rbenv correctly, and installs the version of ruby specified in .ruby-version if necessary. This command is a helper command meant to be called from scripts.
$ brew bootstrap-rbenv-ruby
Include any bootstrapping that is common to all languages and projects. Currently, it checks for a Brewfile and installs homebrew dependencies if it finds one. This command is a helper command meant to be called from scripts.
$ brew bootstrap-project-all
Include any bootstrapping that is common to all php projects. This command will 1) execute bootstrap-project-all; 2) install Node, Ruby, and PHP if necessary; 3) install any gem dependencies; 4) install node dependencies from package.json; 4) install composer; and 5) install composer dependencies. This command is a helper command meant to be called from scripts.
$ brew bootstrap-project-php
Include any bootstrapping that is common to all Rails projects. This command will 1) execute bootstrap-project-all; 2) install Node and Ruby if necessary; and 3) install any gem dependencies. This command is a helper command meant to be called from scripts.
$ brew bootstrap-project-rails
This command will ensure that the machine is ready to utilize the one script to rule them all approach. Currently, it assumes that any machine without Boxen installed is suitable. This command is a helper command meant to be called from scripts.
$ brew check-strta-enabled
To run nginx on port 80 and 443, which are privileged ports, nginx needs to run as root. This command modifies the nginx executable so that the non-privileged user can start and restart nginx. It needs to be run after any update to nginx, and it references in the caveats of our (slightly) modified nginx formula.
$ brew ensure-nginx-executable
Sets up an nginx virutal host file (typically in ./config/dev) and symlinks to it from global nginx configuration. It ensures nginx is installed and generates self-signed SSL certificates. It restarts nginx as necessary. This command is a helper command meant to be called from scripts.
$ brew setup-nginx-conf [--root] [--extra-val=variable=value] <project_name> <project_root_path> <nginx.conf.erb>
The scaffold command, which currently supports october, rails, and typo3 projects, will install scripts, a procfile, gitignores, and generally setup the project. Users will be prompted before files are overwritten. When starting a new project, the scaffold command should be run to get the various scripts in place.
$ brew scaffold october
$ brew scaffold docker_october
$ brew scaffold rails
$ brew scaffold typo3
$ brew scaffold wordpress
Generates a self-signed SSl certificate for the project
$ brew bootstrap-project-ssl <project_name> <ssl_storage>
- Homebrew Documentation
- The Launch Control application provides a gui for mananging launchd services, which can be useful.
- Homebrew Bundle README
- Zach's Boxen uninstall gist
To contribute, the first step is to tap this repository (see installation, above). If you've already tapped it, you'll want to "unshallow" the tap:
brew tap castiron/bootstrap --fullOnce that's done, this repository will be cloned at /usr/local/Homebrew/Library/Taps/castiron/homebrew-bootstrap. To make development easier, create a symlink to it in your ~/src directory:
cd ~/src
ln -s /usr/local/Homebrew/Library/Taps/castiron/homebrew-bootstrapAssuming this was done correctly, you should see the scripts listed at the top of this repo show up as homebrew commands:
brew commands listKeep in mind that brew will only include executable files as commands. If you add a new command to this repository, be sure to set permissions correctly. We can write our commands as shell scripts or using ruby. Read the homebrew documentation on external commands for more information.
This approach to managing development environments is being actively developed at Cast Iron Coding. Our current intention is to replace Boxen with this set of brew commands, Strap, brew bundle, and a customized version of Github's one script to rule them all.
Homebrew Bootstrap is licensed under the MIT License. The full license text is available in LICENSE.txt.