# GitHub

### GitHub as OAuth Identity Provider

To use GitHub as Auth Provider, you must setup a so-called "OAuth App". You can do so in your Github Profile > Settings <https://github.com/settings/developers>

<figure><img src="/files/ERwM7neli5xCd0Gqjq9b" alt=""><figcaption></figcaption></figure>

On GitHub the creation of an OAuth Client Registration is comparatively simple.

<figure><img src="/files/V7eOIYbH4vwLTEcjEkjR" alt=""><figcaption><p>GitHub Client Registration Settings</p></figcaption></figure>

After configuring the Callback URLs, you can "Generate a new client secret".

{% hint style="warning" %}
Make sure you copy the client secret directly, as it is displayed only once. Later you cannot copy it again.
{% endhint %}

Now you go back to OpenFlower Settings > Auth Providers and click "Add OAuth Provider" and select GitHub from the list of Auth Providers.

<figure><img src="/files/KU2C8NGPpZ3rUZWoACsw" alt=""><figcaption></figcaption></figure>

You can copy and paste now the Client ID and Client Secret from the GitHub Client App Registration.

<figure><img src="/files/3bpfyKeOsqNjtsPH96Ag" alt=""><figcaption></figcaption></figure>

Thats it! Now you can invite new Users to OpenFlower. They can choose GitHub to Sign Up (register) or Sign in / log in.

<figure><img src="/files/TCILd0j6r5YAhn2zbjPy" alt=""><figcaption></figcaption></figure>

When users chose to Sign in or Sign up with GitHub, they will get redirected to the GitHub Login page of the registered Client App

<figure><img src="/files/ixBWfnssnoVMNjj95Uz1" alt=""><figcaption></figcaption></figure>

Here they have to Authorize your registered Client App to act and impersonate your users.

<figure><img src="/files/VxC9ZyKEqOn9hFJOPmhx" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.openflower.org/workspaces-and-teamwork/oauth/github.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
