From 90837b5849587abc3a6749b874e67d79c0fbd3c3 Mon Sep 17 00:00:00 2001 From: Morgan Delagrange Date: Mon, 13 May 2013 16:13:46 -0500 Subject: [PATCH] adding docs for Github Enterprise users --- README.md | 7 +++++++ modules/projects/README.md | 4 ++++ 2 files changed, 11 insertions(+) diff --git a/README.md b/README.md index 1f0e624..20a2be7 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/modules/projects/README.md b/modules/projects/README.md index f6a5f38..424195f 100644 --- a/modules/projects/README.md +++ b/modules/projects/README.md @@ -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).