Skip to content

Commit 77f898e

Browse files
committed
docs: update faqs for v7 features
Signed-off-by: Adam Setch <adam.setch@outlook.com>
1 parent 1ba7dcf commit 77f898e

14 files changed

Lines changed: 99 additions & 21 deletions

.vscode/settings.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,8 @@
1414
},
1515
"[typescript]": {
1616
"editor.defaultFormatter": "biomejs.biome"
17-
}
17+
},
18+
"cSpell.words": [
19+
"Gitify"
20+
]
1821
}

src/components/Footer.astro

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ const isHomepage = currentPathname === '/';
2525
</a>
2626

2727
<div class="my-3">
28-
Copyright ©
28+
Copyright ©{' '}
2929
<a href={siteMetadata.author.site}>{siteMetadata.author.name}</a>
30+
{' '}
3031
{new Date().getFullYear()}
3132
</div>
3233
</div>

src/constants.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export const siteMetadata = {
1212
site: 'https://github.com/orgs/gitify-app/people',
1313
},
1414
keywords:
15-
'gitify,desktop,application,github,notifications,unread,menu bar,electron,open source,mac,windows,linux',
15+
'gitify,desktop,application,github,gitea,codeberg,forgejo,bitbucket,notifications,unread,menu bar,electron,open source,mac,windows,linux',
1616
google: {
1717
gtags: ['G-QXML81DEDV', 'G-H4MTPZP3HW'],
1818
siteVerification: 'jJNnPZ2wu7F1tlSab57og1N3RNrMqhzTCzRrbztY8WU',

src/faqs/getting-started/authentication-methods.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,20 @@ title: "What authentication methods does Gitify support?"
33
category: "Getting Started"
44
order: 1
55
---
6-
Gitify offers three ways to authenticate with GitHub:
6+
Authentication methods vary by forge:
7+
8+
### GitHub Cloud & GitHub Enterprise Server
79

810
- **Login with GitHub** — The easiest option. Uses the OAuth Device Flow: Gitify generates a code, opens `github.com/login/device` in your browser, and completes authentication automatically. Supports GitHub Cloud only.
911
- **Personal Access Token (PAT)** — Authenticate with a token generated in your GitHub account settings. Supports both GitHub Cloud and GitHub Enterprise Server.
1012
- **OAuth App** — Authenticate using a Client ID and Client Secret from a GitHub OAuth App you create. Supports both GitHub Cloud and GitHub Enterprise Server.
1113

1214
If you are unsure which method to use, **Login with GitHub** is recommended for most users on GitHub Cloud. For GitHub Enterprise Server, use a PAT or OAuth App.
15+
16+
### Gitea, Forgejo & Codeberg
17+
18+
- **Personal Access Token (PAT)** — Generate a token in your Gitea/Forgejo/Codeberg account under _Settings → Applications_, then enter it in Gitify along with your instance hostname (e.g. `codeberg.org` or your self-hosted URL).
19+
20+
### Bitbucket Cloud
21+
22+
- **Personal Access Token (PAT)** — Generate an app password in your Bitbucket account under _Personal settings → App passwords_ and use it as your token in Gitify.

src/faqs/getting-started/github-enterprise-server.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@ title: "Does Gitify support GitHub Enterprise Server?"
33
category: "Getting Started"
44
order: 3
55
---
6-
Yes. Gitify supports both GitHub Cloud and **GitHub Enterprise Server (GHES)**.
6+
Yes. Gitify supports **GitHub Enterprise Server (GHES)** and **GitHub Enterprise Cloud with Data Residency** alongside GitHub Cloud.
77

8-
When signing in via **Personal Access Token** or **OAuth App**, you will see a _Hostname_ field that defaults to `github.com`. Replace this with your GHES hostname (e.g. `github.mycompany.com`) to connect to your Enterprise instance.
8+
> **Note:** This entry covers GitHub-specific setup. If you are using Gitea, Forgejo, Codeberg, or Bitbucket Cloud, see [Which Git forges does Gitify support?](/faq/#supported-forges) and [What authentication methods does Gitify support?](/faq/#authentication-methods).
99
10-
> **Note:** The **Login with GitHub** (Device Flow) method only supports GitHub Cloud and does not expose a hostname field.
10+
When signing in via **Personal Access Token** or **OAuth App**, you will see a _Hostname_ field that defaults to `github.com`. Replace this with your instance hostname to connect:
11+
- **GitHub Enterprise Server**: your self-hosted hostname, e.g. `github.mycompany.com`
12+
- **GitHub Enterprise Cloud (Data Residency)**: your tenant hostname, e.g. `myorg.ghe.com`
1113

12-
Multiple accounts across different hostnames (e.g. `github.com` and your GHES instance) can be signed in simultaneously — see _"How do I add multiple GitHub accounts?"_ for details.
14+
> **Note:** The **Login with GitHub** (Device Flow) method only supports GitHub Cloud (`github.com`) and does not expose a hostname field.
15+
16+
Multiple accounts across different hostnames (e.g. `github.com` and your GHES instance) can be signed in simultaneously — see [How do I add multiple accounts?](/faq/#multiple-accounts) for details.

src/faqs/getting-started/github-scopes.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: "What GitHub scopes does Gitify require?"
33
category: "Getting Started"
4-
order: 3
4+
order: 6
55
---
66

7+
> **Note:** This entry covers **GitHub Cloud and GitHub Enterprise Server** only. Gitea, Forgejo, Codeberg, and Bitbucket Cloud use standard read access tokens — see [What authentication methods does Gitify support?](/faq/#authentication-methods).
8+
79
The required GitHub scopes depend on your chosen authentication method.
810

911
**Login with GitHub** (Device Flow) and **OAuth App**:
@@ -18,3 +20,5 @@ When generating a PAT, the following scopes are required:
1820
- `repo` — to enrich notification details for public and private repositories
1921

2022
> **Note:** If you only need access to public repositories, you can use `public_repo` instead of `repo`.
23+
24+
For help generating a PAT, see [GitHub → Settings → Developer settings → Personal access tokens](https://github.com/settings/tokens). If notifications still aren't appearing after setting up a PAT, see [Why aren't my notifications showing?](/faq/#notifications-not-showing).
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "How do I authorize my PAT for a GitHub SSO organization?"
3+
category: "Getting Started"
4+
order: 7
5+
---
6+
If your GitHub organization enforces **SAML single sign-on (SSO)**, you must explicitly authorize your Personal Access Token to access that organization's data — including notifications. Without this step, Gitify will not show notifications from repositories in that organization even if your PAT has the correct scopes.
7+
8+
To authorize a PAT for SSO:
9+
- Open [GitHub → Settings → Personal access tokens](https://github.com/settings/tokens)
10+
- Find the token you use with Gitify
11+
- Click **Configure SSO** next to the token
12+
- Click **Authorize** next to each SSO-enabled organization you want to grant access
13+
- Complete the SSO authentication flow for each organization
14+
15+
Once authorized, Gitify will be able to fetch notifications from repositories in those organizations. Re-authorization may be required if your SSO session expires or your organization's SSO configuration changes.
16+
17+
For more details, see the [GitHub documentation on authorizing a PAT for use with SSO](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on).
18+
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
---
2-
title: "How do I add multiple GitHub accounts?"
2+
title: "How do I add multiple accounts?"
33
category: "Getting Started"
44
order: 4
55
---
6-
Gitify supports signing in to multiple accounts simultaneously — for example, a personal GitHub Cloud account alongside a GitHub Enterprise Server account.
6+
Gitify supports signing in to multiple accounts simultaneously — for example, a personal GitHub Cloud account alongside a Gitea or Bitbucket Cloud account.
77

88
To add an account:
99
- Open the **Accounts** screen from the Gitify sidebar
10-
- Click **Add new account** and choose your preferred authentication method
10+
- Click **Add new account** and choose your forge and preferred authentication method
1111
- Complete the sign-in flow for the additional account
1212

1313
All signed-in accounts will appear on the Accounts screen. You can designate a **primary account** by clicking the star icon next to an account — the primary account is used as the default where applicable.
1414

1515
Each account can be individually refreshed or signed out at any time.
16+
17+
For a full list of supported forges, see [Which Git forges does Gitify support?](/faq/#supported-forges).

src/faqs/getting-started/oauth-app-setup.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: "How do I configure OAuth App authentication?"
33
category: "Getting Started"
44
order: 2
55
---
6-
To authenticate via an **OAuth App**:
6+
> **Note:** OAuth App authentication is available for **GitHub Cloud and GitHub Enterprise Server only**. For Gitea, Forgejo, Codeberg, and Bitbucket Cloud, use a [Personal Access Token](/faq/#authentication-methods).
7+
8+
To authenticate via an **OAuth App** with GitHub:
79
- Open [GitHub → Settings → Developer settings → OAuth Apps](https://github.com/settings/developers)
810
- Click _New OAuth App_
911
- Set _Authorization callback URL_ to `gitify://oauth`
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "Which Git forges does Gitify support?"
3+
category: "Getting Started"
4+
order: 0
5+
---
6+
Gitify supports notifications from the following Git forges:
7+
8+
- **GitHub Cloud**`github.com`
9+
- **GitHub Enterprise Server (GHES)** — self-hosted GitHub instances
10+
- **GitHub Enterprise Cloud (Data Residency)**`[tenant].ghe.com`
11+
- **Gitea** — including self-hosted instances
12+
- **Forgejo** — compatible with the Gitea authentication flow
13+
- **Codeberg** — powered by Forgejo, fully supported
14+
- **Bitbucket Cloud**`bitbucket.org`
15+
16+
Multiple accounts across different forges can be signed in simultaneously. See [How do I add multiple accounts?](/faq/#multiple-accounts) for details.
17+
18+
For authentication setup, see [What authentication methods does Gitify support?](/faq/#authentication-methods).

0 commit comments

Comments
 (0)