Skip to content

Latest commit

 

History

History
executable file
·
55 lines (42 loc) · 2.13 KB

README.md

File metadata and controls

executable file
·
55 lines (42 loc) · 2.13 KB
Raw

Github Enterprise Org Explorer

UI to help with GHE org exploration and discovery.

Why?

Github Enterprise is an amazing tool if you already know what you're looking for, but we've found that the exploration and discovery aspect of the product is really lacking. The goal of this project is to create a simple and easy to deploy UI to help enterprise developers find out about the available organizations in their Github Enterprise instance.

Requirements

This project was built internally and tested with:

  • NPM >=3.0.0
  • Node >=6.0.0

Required environment variables on startup:

  • github_url - The domain name (and port if needed) of your Github Enterprise instance in the format of domain[:port] without a protocol. The Github API is via basic auth so HTTPS is enforced. Not using HTTPS for your Github Enterprise instance? Why the heck not?
  • github_user - The user name of whoever will be running the UI.
  • github_pac - A personal access token from the provided user with the default grants.

Optional environment variables:

  • port - Used to override the port that the application will start on

Running in development mode

Running in production

  • npm i
  • npm run package
  • npm prune --production
  • Push the final code wherever it needs to be (we use CloudFoundy so for us it's a push to the cloud. For you it might be zipping up the current folder)
  • Make sure your environment variables are set wherever the code is going to run
  • npm start - If you're not running in something that will monitor your application I would suggest a tool like forever

Running with Docker

  1. Build with
docker build -t nameX .
  1. Create a docker env file with the needed keys
# your_env_file
github_url=my.github.com
github_user=johndoe
github_pac=xyzabc
  1. Run with
docker run -d --rm -p 8080:3099 --env-file your_env_file nameX