Automate your team's Boxen installations.
We assume you already have Boxen working on your machine. You also need PostgreSQL installed.
$ cd ~/src/boxen-web $ script/bootstrap $ script/tests $ bin/rake db:schema:load $ script/server $ open http://localhost:9393
The tl;dr version is you can run something like this:
Make a new GitHub OAuth Application. Then, run:
heroku create my-new-boxen heroku config:set \ REPOSITORY="our-org/our-boxen" \ GITHUB_CLIENT_ID="REDACTED" \ GITHUB_CLIENT_SECRET="REDACTED" \ GITHUB_ORG=my-github-org \ GITHUB_TEAM_ID=99999999 \ GITHUB_LOGIN=my-github-login \ SECONDARY_MESSAGE="Do a thing before running the command below." \ SECRET_TOKEN="your cookie signing token here" \ USER_ORG="your org name" \ GITHUB_ENTERPRISE_URL="https://github..com" \ REF="master" git push heroku master heroku run bundle exec rake db:migrate
For details as to how and why, see the sections below.
Boxen Web utilizes GitHub OAuth to authenticate users because most Boxen configurations for organizations will be private -- this requires an access token to fetch the repository in the install script.
If your deployment lives at
https://example.herokuapp.com, you will need to create a GitHub OAuth application with the following config:
You must use the Heroku Cedar stack (now the default with
Additionally there are some required and optional environment variables that should be set via
REPOSITORYto know which repo to download/setup
SECRET_TOKENfor cookie signing. Minimum length is 30 characters.
GITHUB_ORGto restrict access to members of an organization.
GITHUB_TEAM_IDto restrict access to members of a team.
GITHUB_LOGINto restrict access to a single user by login name.
SECONDARY_MESSAGEto display an optional message on the main page.
USER_ORGto display an optional stamp with your username or organization.
GITHUB_ENTERPRISE_URLto use GHE for OAuth and
REFto fetch a specific reference from REPOSITORY.
Use Issues or #boxen on irc.freenode.net.