Skip to main content

Quick start

Step 1 : Create your GitGuardian workspace#

Sign up here to create a free user account on GitGuardian. GitGuardian automatically creates a workspace and makes you its owner. You can either decide to keep this workspace personal or collaborate with your teammates.

You can also sign up for GitGuardian through GitHub SSO.

Step 2 : Integrate your source code for secrets monitoring#

The very first step you need to take in order to set up your GitGuardian workspace is to integrate your source code monitoring integration (typically the VCS you are using). That is why, right upon sign up, we prompt you to integrate a supported VCS:


Note that if you signed up using GitHub SSO, we assume that you leverage GitHub and therefore automatically prompt that integration.

Depending on your preference, you can also decide to exclusively leverage our API for secrets detection.

Step 3 : Choose the repositories you want to monitor#

Once your source code integration has been successful, you need to decide which repositories you want GitGuardian to monitor in real time for secrets detection and other security policies.

choose repositories

We recommend that you activate GitGuardian monitoring on as many repositories as possible since you never know where a leak could happen. This might seem obvious, but the broader the coverage you have, the better protected you are.

If some of your repositories are dedicated to testing (and you regularly leak fake secrets there) you might want to deactivate them in order to reduce potential noise on your GitGuardian dashboard.

Step 4 : Review your perimeter and scan your entire git history#

One final step, you are almost done.

GitGuardian gives you the ability to scan the entire git history (across all git branches) of your repositories in order to check if they are completely safe. We believe it is essential for you to start on a clean basis and remediate all existing incidents.

Just go to your Perimeter page and launch your historical scans!

perimeter historical scanning

That's it! Start remediating#

Congratulations! You are now all set up with continuous and automated monitoring of your repositories for secrets. We at GitGuardian are proud to be helping you develop swiftly and with peace of mind!

If your first historical scan has uncovered incidents, go to the Incidents section of our documentation to learn how to remediate them.

If you are interested in learning more about how GitGuardian really works and how to make the most of its capabilities, please feel free to dive into the next section: