Django Admin View

Once setup is complete, it is time It's time to start configuring the app for your specific environment. The admin UI we use below will also be used to add new repositories to the system, unless you decide to use the Imports feature.

Organization Setup

Visit http://servername:8000/admin and create an Organization. Normally organizations represent something like departments or divisions (at a workplace) or courses at a university. You do not technically need to create more than one organization, but you can.

Credential Setup

You should also add some Credential objects, which are used when checking out private repositories. Credentials will hold on to your SSH private keys, which are automated behind the scenes with the system using SSH-agent. It's fine to create keys specifically for this purpose, and then add them to your repositories in GitHub, GitLab, and so on, and is preferred to using private keys that would have access to other software systems. This all being said, these keys are encrypted in the database using the key created during the 'generate_secret' part of the earlier install process.

Repository Setup

With these two configuration items in place, you may now add Repositories at this time using the admin web interface. For each repository, provide a name, select an Organization that it should belong to, and optionally pick a credential object to use if the repository is not public. You may also add repositories via the import command, see Imports.

About Merge Commits

The organization has a setting for whether or not repository merge commits should be included in statistical totals. The answer should probably be "no", but in the event git somehow does not have the source commits in the repo, you might want to try this as "yes". We could be hallucinating this possibility, but it was enough that we added a feature for it. To track statistics of merge commits, configure "include_merge_commits" on the organization object before running or rerunning scans. The merge commits will pad stats for merging others code, but may be needed if for some reason code is not showing up in the counts due to the way it is being merged, which should also be rare. This feature could be removed in a future release.

Next Steps: Scanning

Before proceeding further to the web interface, lets first scan the repository or repository you have added so there will be some graphs and statistics to view. We'll show how to do that below.

After setting up Django admin, it is time to import repository data. See Scanner.