Getting Started
Basic Account Setup
After you’ve signed up, you will be redirected to the Gaffer dashboard.
The first thing you’ll need to do is create a new organization. The user that creates the organization will automatically be made the owner of the organization and given admin privileges, including the ability to invite other users to the organization.
At the moment, we only offer local authentication (username or email, and password) or Github OAuth authentication. If you’d like to use a different authentication method, please contact us.
Create a new project
Once you have created an organization, you will be redirected to the dashboard. From here you can click the “Create Project” button to create a new project.
To enable Github integration, you will need to first need to install the Gaffer.sh Github application for your organization. We have strived to limit the amount of permissions we request from Github, but please review them before installing.
Once this is done, you can create a new project by clicking the “Import from Github” project creation method. This will list all the repositories available to the application and allow you to create Gaffer projects for each repository.
The simplest way to create a new project is to use the “Manual” project creation method. This will create a new project with an API keys, but will lack all integration with Github.
API Keys
When you create a new project, an API key will be automatically created for you. This API key will be used to upload test reports to the Gaffer API.
You can generate as many new API keys as you need from the project settings page.