3.1 PostgreSQL user and database
You need to set up a user and a database in PostgreSQL for Gitrob. Execute the following commands in a terminal:

sudo su postgres # Not necessary on Mac OS X
createuser -s gitrob --pwprompt
createdb -O gitrob gitrob

You now have a new PostgreSQL user with the name gitrob and with the password you typed into the prompt. You also created a database with the name gitrob which is owned by the gitrob user.

4. GitHub access tokens
Gitrob works by querying the GitHub API for interesting information, so you need at least one access token to get up and running. The easiest way is to create a Personal Access Token. Press the Generate new token button and give the token a description. If you intend on using Gitrob against organizations you're not a member of you don't need to give the token any scopes, as we will only be accessing public data. If you intend to run Gitrob against your own organization, you'll need to check the read:org scope to get full coverage.
If you plan on using Gitrob extensively or against a very large organization, it might be necessary to have multiple access tokens to avoid running into rate limiting. These access tokens will have to be from different user accounts.

5. Gitrob
With all the previous steps completed, you can now finally install Gitrob itself with the following command in a terminal:

gem install gitrob

This will install the Gitrob Ruby gem along with all its dependencies. Congratulations!

6. Configuring Gitrob
Gitrob needs to know how to talk to the PostgreSQL database as well as what access token to use to access the GitHub API. Gitrob comes with a convenient configuration wizard which can be invoked with the following command in a terminal:

gitrob configure

The configuration wizard will ask you for the information needed to set up Gitrob. All the information is saved to ~/.gitrobrc and yes, Gitrob will be looking for this file too, so watch out!

Usage

Analyzing organizations and users
Analyzing organizations and users is the main feature of Gitrob. The analyze command accepts an arbitrary amount of organization and user logins, which will be bundled into an assessment:

gitrob analyze acme,johndoe,janedoe

Mixing organizations and users is convenient if you know that a certain user is part of an organization but they do not have their membership public.
When the assessment is finished, the analyze command will automatically start up the web server to present the results. This can be avoided by adding the --no-server option to the command.
See gitrob help analyze for more options.

Running Gitrob against custom GitHub Enterprise installations
Gitrob can analyze organizations and users on custom GitHub Enterprise installations instead of the official GitHub site. The analyze command takes several options to control this:

gitrob analyze johndoe --site=https://github.acme.com --endpoint=https://github.acme.com/api/v3 --access-tokens=token1,token2

See gitrob help analyze for more options.

Starting the Gitrob web server
The Gitrob web server can be started with the server command:

gitrob server

By default, the server will listen on localhost:9393. This can, of course, all be controlled:

gitrob server --bind-address=0.0.0.0 --port=8000

See for gitrob help servermore options.

Adding custom signatures
If you want to look for files that are specific to your organisation or projects, it is easy to add custom signatures.
When Gitrob starts it looks for a file at ~/.gitrobsignatures which it expects to be a JSON document with signatures that follow the same structure as the main signatures.json file. Here is an example:

[
  {
    "part": "filename",
    "type": "match",
    "pattern": "otr.private_key",
    "caption": "Pidgin OTR private key",
    "description": null
  }
]

This signature instructs Gitrob to flag files where the filename exactly matches otr.private_key. The caption and description are used in the web interface when displaying the findings.

Signature keys

• part: Can be one of:
  • path: The complete file path
  • filename: Only the filename
  • extension: Only the file extension
• type: Can be one of:
  • match: Simple match of part and pattern
  • regex: Regular expression matching of part and pattern
• pattern: The value or regular expression to match with
• caption: A short description of the finding
• description: More detailed description if needed (set to null if not).

Have a look at the main signatures.json file for more examples of signatures.