Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/autodesk/hubble
🛰 Collaboration, usage, and health data visualization for GitHub Enterprise
https://github.com/autodesk/hubble
analytics git github github-enterprise hubble-enterprise
Last synced: 7 days ago
JSON representation
🛰 Collaboration, usage, and health data visualization for GitHub Enterprise
- Host: GitHub
- URL: https://github.com/autodesk/hubble
- Owner: Autodesk
- License: mit
- Created: 2017-09-26T10:47:07.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T21:49:14.000Z (over 1 year ago)
- Last Synced: 2024-12-11T08:51:29.389Z (15 days ago)
- Topics: analytics, git, github, github-enterprise, hubble-enterprise
- Language: Python
- Homepage: https://autodesk.github.io/hubble
- Size: 1.41 MB
- Stars: 176
- Watchers: 16
- Forks: 47
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://autodesk.github.io/hubble/)
# Hubble Enterprise [](https://github.com/autodesk/hubble/releases) [](https://travis-ci.org/Autodesk/hubble) [](https://codecov.io/gh/Autodesk/hubble)
_Hubble Enterprise_ visualizes [GitHub Enterprise](https://enterprise.github.com) collaboration, usage, and health data.
Explore our [interactive demo](https://autodesk.github.io/hubble/) or watch the recording of our [GitHub Universe talk](https://youtu.be/v9v6BUTrK_g?t=29m18s) to learn more!
> :warning: **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](https://help.github.com/enterprise/2.11/admin/guides/installation/administrative-shell-ssh-access/) 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](https://help.github.com/enterprise/2.10/admin/guides/installation/configuring-github-enterprise-pages/#setting-github-enterprise-pages-to-be-publicly-accessible) on your GitHub Enterprise management console, then everyone on your network will be able to see the Hubble dashboard!
>
> Please use Hubble Enterprise on your production instance only after reviewing the source code carefully!
## Getting Started
Hubble Enterprise consists of two components.
The [*updater component*](updater/) is a Python script that queries relevant data from a GitHub Enterprise appliance and stores the results in a Git repository once a day.
The [*docs component*](docs/) is a web application that visualizes the collected data and is hosted with [GitHub Pages](https://pages.github.com/).
1. Create a new, initialized, public repository for Hubble’s data on your GitHub Enterprise appliance (for instance, `https://git.company.com/scm/hubble-data`).
1. Publish Hubble’s [data repository on GitHub Pages](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages).
Go to the repository settings, *options* tab, *GitHub Pages* section, then choose *master branch* as *source*, and click *save*.
GitHub Enterprise will now tell you the URL of the published data pages (for instance, `https://pages.git.company.com/scm/hubble-data` if you have [subdomain isolation enabled](https://help.github.com/enterprise/2.1/admin/articles/configuring-dns-ssl-and-subdomain-settings/#enabling-subdomain-isolation)).
Please be aware that this is a *GitHub Pages URL* and not just the repository’s URL.
Note this URL down as `dataURL`, as you will need it later.
1. Create a new, uninitialized, public repository for Hubble on your GitHub Enterprise appliance (for instance, `https://git.company.com/scm/hubble`).
1. Clone [this repository](https://github.com/autodesk/hubble) to your local machine, add your new Hubble repository as a remote, and push Hubble’s *master* branch to this remote:
```sh
git clone https://github.com/autodesk/hubble
cd hubble
git remote add ghe https://git.company.com/scm/hubble
git push -u ghe master
```
1. Open [`docs/_config.yml`](docs/_config.yml) in your editor and set the `dataURL` that you noted earlier. Commit and push the change to your Hubble repository:
```sh
git add docs/_config.yml
git commit -m "Adjusting dataURL to our own instance"
git push
```
1. Publish Hubble’s [docs folder on GitHub Pages](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#publishing-your-github-pages-site-from-a-docs-folder-on-your-master-branch).
Go to the repository settings, *options* tab, *GitHub Pages* section, then choose *master branch/docs folder* as *source*, and click *save*.
GitHub Enterprise will now tell the URL of the published dashboard pages.
You may want to bookmark this URL to conveniently access the dashboard of Hubble Enterprise.
1. [Configure the updater component](updater/README.md).
## Contributing
Review [the contributing guidelines](CONTRIBUTING.md) before you consider working on Hubble Enterprise and proposing contributions.
## Core Team
These are the humans that form the core team of Hubble Enterprise, in alphabetical order:
| [](https://github.com/larsxschneider)
[@larsxschneider](https://github.com/larsxschneider) | [](https://github.com/pluehne)
[@pluehne](https://github.com/pluehne) |
|---|---|
## License
SPDX-License-Identifier: [MIT](LICENSE.md)