adding docs for Github Enterprise users

This commit is contained in:
Morgan Delagrange 2013-05-13 16:13:46 -05:00
parent acf13e6e2d
commit 90837b5849
2 changed files with 11 additions and 0 deletions

View file

@ -258,6 +258,13 @@ fork.
You'll still be the maintainer, you'll still own the issues and PRs.
It'll just be listed under the boxen org so folks can find it more easily.
## Integrating with Github Enterprise
If you're using a Github Enterprise instance rather than github.com,
you will need to set the "BOXEN_GITHUB_ENTERPRISE_URL" and
"BOXEN_REPO_URL_TEMPLATE" variables in your
[Boxen config](config/boxen.rb).
## Halp!
See [FAQ](https://github.com/boxen/our-boxen/blob/master/docs/faq.md).

View file

@ -24,6 +24,10 @@ With the above, as long as our app is configured to listen on a **socket** at
`"#{ENV['BOXEN_SOCKET_DIR']}"/trollin`, you'll now be able to run its local
server and visit http://trollin.dev/ to access the app in dev.
Provide the full repository URL in the 'source' option when referencing
code that is not hosted at github.com, such as Github Enterprise
repositories.
For further documentation on how to use the `boxen::project` type,
take a look at the documentation in the
[source](https://github.com/boxen/puppet-boxen/blob/master/manifests/project.pp#L1-L46).