Skip to content

Autodesk/hubble

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hubble Enterprise

Hubble Enterprise visualizes GitHub Enterprise usage and health data. Explore our interactive demo to learn more!

⚠️ Attention: Hubble Enterprise is not supported by or affiliated with GitHub. Use it at your own risk! Autodesk assumes no responsibility for any data loss or hardship incurred directly or indirectly by using Hubble Enterprise.

Hubble Enterprise runs all queries through the GitHub Enterprise administrative shell and ignores repository visibility settings to generate statistics over all repositories on your appliance. Consequently, the names (no content!) of private repositories could show up on the Hubble dashboard published via GitHub Pages on your appliance. If you have enabled Public Pages on your GitHub Enterprise management console, then everyone on your network would be able to see the Hubble dashboard!

Please use Hubble Enterprise on your production instance only after careful review of the source code!

Getting Started

Hubble Enterprise consists of two components. The updater component runs once a day; queries relevant data from a GitHub Enterprise appliance and stores the results in a Git repository. The docs component uses GitHub Pages to visualize the collected data on the GitHub Enterprise appliance.

  1. Create a new, initialized, public repository for Hubble data on your GitHub Enterprise appliance (e.g. https://git.company.com/scm/hubble-data).
  2. Publish the Hubble data repository on GitHub Pages. Go to repository Settings, Option Tab, GitHub Pages section, choose Source "master branch", and click "Save". GitHub Enterprise will tell you a publish URL. Note that down as dataURL. We need it in a second.
  3. Create a new, uninitialized, public repository for Hubble on your GitHub Enterprise appliance (e.g. to https://git.company.com/scm/hubble).
  4. Clone this repository to your local machine, add your new Hubble repository as remote, and push the Hubble master branch to this remote:
    git clone https://github.com/autodesk/hubble
    cd hubble
    git remote add ghe https://git.company.com/scm/hubble
    git push -u ghe master
  5. Open docs/_config.yml in your editor and set the dataURL that we generated earlier. Commit and push the change to your Hubble repository.
  6. Publish the docs component on GitHub Pages. Go to repository Settings, Option Tab, GitHub Pages section, choose Source "master branch /docs folder", and click "Save". GitHub Enterprise will tell you a publish URL. Save this URL to your bookmark. This will be the link the to access Hubble Enterprise.
  7. Configure the updater component.

Contributing

See CONTRIBUTING.md for info on working on Hubble Enterprise and sending patches.

Core Team

These are the humans that form the Hubble Enterprise core team, which runs the project. In alphabetical order:

@larsxschneider @pluehne

License

Apache License 2.0