GitHub

Configure GitHub as an authentication provider so users can log in to Zammad with their GitHub account. For details about OAuth apps, see the GitHub developer documentation.

Register a GitHub App

Create the OAuth App

In GitHub, click on your profile picture, go to Settings > Developer settings > OAuth apps and click New OAuth App. Provide the following information:

Application name

Enter a name for your app, for example Zammad. This is what users see when they authorize the login.

Homepage URL

Enter the URL of your Zammad instance, for example https://zammad.example.com.

Authorization callback URL

Enter https://zammad.example.com/auth/github/callback and replace zammad.example.com with the FQDN of your Zammad instance. You can also copy the callback URL from the Authentication via GitHub section in Zammad’s admin settings.

Finally, click Register application.

Get Your App Credentials

After registering, GitHub displays the Client ID. Note it down. Now generate a client secret with the Generate a new client secret button and note it down too. You can retrieve both values later in this OAuth apps screen in the developer settings.

Configure Zammad

Navigate to Settings > Security > Third-party Applications and scroll to the Authentication via GitHub section. Enter your App ID and App Secret, enable the toggle, and click Submit.

After submitting, the GitHub button appears on the login page and users can log in with their GitHub account. On first login, GitHub asks them to authorize the access.