In order to run instance_auditor.rb
you must have an environment capable of running Ruby scripts. This script generates a .xlsx
file so you'll also need a tool that can open it (such as Microsoft Excel, Libre Office, or Numbers).
To get an instance wide audit follow these steps:
- Log in as the GHE Site Admin and generate a personal access token with
read:org
scope - SSH into the GHE VM and run
ghe-org-owner-promote
. This will make the site admin an owner in all organizations. - Set GITHUB_TOKEN to the token you've just generated
- Set GITHUB_API_ENDPOINT to
http(s)://[your-hostname]/api/v3/
- Download the
instance_auditor.rb
andGemfile
to a new folder - Run
bundle install
to retrieve the script's dependencies - Run the script to generate the audit report:
ruby instance_auditor.rb