Files
boxen/README.md
John Barnette b01e852cc6 Switch script/sync-puppet to an OAuth token
This also removes the redundant "puppet-" prefix on clones.
2012-11-28 11:28:25 -08:00

1.2 KiB

Boxen

Manage Mac development boxes with love (and Puppet).

Rules for Services

  1. Run on a nonstandard port, usually default port + 1000 or 10000.

  2. Install with a custom Boxen homebrew formula.

  3. Suffix the Homebrew package's version, starting with -boxen1.

  4. Run as a launchd service in the com.boxen namespace, e.g., com.boxen.dnsmasq.

  5. Store config, data, and log files in `$BOXEN_HOME/{config,data,log}. This will normally require customization of a service's Homebrew formula.

Sometimes it's not possible to follow these rules, but try hard.

Contributing

Use the OS X system Ruby (1.8.7). Run script/tests often. Open PR's.

Managing Boxen's Puppet Modules

There are roughly nine million puppet modules under the Boxen GitHub organization. To clone them all, run script/sync-puppet. This script will make sure every boxen/puppet-* repo is cloned under the ./puppet directory, which is ignored by Git.

Because it uses the GitHub API, script/sync-puppet will prompt you for your login and password. It'll use them to create an OAuth token and stash it in .github-oauth-token for future use.