Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export const siteMetadata = {
site: 'https://github.com/orgs/gitify-app/people',
},
keywords:
'gitify,desktop,application,github,gitea,codeberg,forgejo,bitbucket,notifications,unread,menu bar,electron,open source,mac,windows,linux',
'gitify,desktop,application,github,gitea,codeberg,forgejo,gitlab,bitbucket,notifications,unread,menu bar,electron,open source,mac,windows,linux',
google: {
gtags: ['G-QXML81DEDV', 'G-H4MTPZP3HW'],
siteVerification: 'jJNnPZ2wu7F1tlSab57og1N3RNrMqhzTCzRrbztY8WU',
Expand Down
9 changes: 4 additions & 5 deletions src/faqs/contributing/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: "How can I contribute to Gitify?"
category: "Contributing"
order: 1
---
You can contribute to Gitify by opening an issue or pull request on GitHub at [gitify-app/gitify](https://github.com/gitify-app/gitify).
You can help Gitify by opening an issue or pull request on GitHub at [gitify-app/gitify](https://github.com/gitify-app/gitify).

Before contributing, please review our [CONTRIBUTING.md](https://github.com/gitify-app/gitify/blob/main/CONTRIBUTING.md) guide for details on branch naming, the PR process, and code style.
1. Read [CONTRIBUTING.md](https://github.com/gitify-app/gitify/blob/main/CONTRIBUTING.md) for branch naming, the pull request process, and code style.
2. Browse [open issues](https://github.com/gitify-app/gitify/issues) and pick something you want to work on.

Check out our [open issues](https://github.com/gitify-app/gitify/issues) and see if there is an existing idea you would like to work on.

Not a developer? You can still help by reporting bugs, improving documentation, or starring and sharing the project.
Not a developer? You can still help by reporting bugs, improving docs, or starring and sharing the project.
28 changes: 19 additions & 9 deletions src/faqs/getting-started/authentication-methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,30 @@ title: "What authentication methods does Gitify support?"
category: "Getting Started"
order: 1
---
Authentication methods vary by forge:
How you sign in depends on the forge. On GitHub.com, start with **Login with GitHub**. On other GitHub hostnames, use a personal access token (PAT) or a GitHub OAuth app. On Gitea, Forgejo, Codeberg, and GitLab, use a PAT. On Bitbucket Cloud, use an app password.

### GitHub Cloud & GitHub Enterprise Server
### GitHub

- **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.
- **Personal Access Token (PAT)** — Authenticate with a token generated in your GitHub account settings. Supports both GitHub Cloud and GitHub Enterprise Server.
- **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.
GitHub.com, GitHub Enterprise Cloud, and GitHub Enterprise Server:

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.
- **Login with GitHub** — The simplest option on GitHub.com. Gitify shows a code, opens `github.com/login/device` in your browser, and finishes sign-in for you. This method is for GitHub.com only.
- **Personal access token (classic)** — A classic token from your GitHub account settings. Works on GitHub.com, GitHub Enterprise Cloud, and GitHub Enterprise Server.
- **GitHub OAuth app** — A Client ID and Client Secret from an OAuth app you create. Works on GitHub.com, GitHub Enterprise Cloud, and GitHub Enterprise Server.

### Gitea, Forgejo & Codeberg
If you are unsure, use **Login with GitHub** on GitHub.com. On GitHub Enterprise Cloud or GitHub Enterprise Server, use a classic personal access token or a GitHub OAuth app.

- **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).
### Gitea, Forgejo, Codeberg

- **Personal access token (PAT)** — Create a token under _Settings → Applications_, then enter it in Gitify with your instance hostname (for example `codeberg.org` or your self-hosted URL).

### Bitbucket Cloud

- **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.
- **App password** — Create an app password under _Personal settings → App passwords_ and enter it as your token in Gitify.

### GitLab

GitLab Cloud and Self-Managed:

- **Personal access token (PAT)** — Create a token under _User settings → Access tokens_, then enter it in Gitify with your instance hostname.

**Related:** [Which Git forges does Gitify support?](/faq/#supported-forges) · [How do I configure GitHub OAuth app authentication?](/faq/#oauth-app-setup) · [What GitHub scopes does Gitify require?](/faq/#github-scopes)
18 changes: 10 additions & 8 deletions src/faqs/getting-started/github-enterprise-server.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
---
title: "Does Gitify support GitHub Enterprise Server?"
title: "Does Gitify support GitHub Enterprise Cloud and GitHub Enterprise Server?"
category: "Getting Started"
order: 3
---
Yes. Gitify supports **GitHub Enterprise Server (GHES)** and **GitHub Enterprise Cloud with Data Residency** alongside GitHub Cloud.
Yes. Gitify works with **GitHub.com**, **GitHub Enterprise Cloud** (including **GitHub Enterprise Cloud with data residency (GHDR)**), and **GitHub Enterprise Server (GHES)**.

> **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).
When you sign in with a **personal access token (classic)** or a **GitHub OAuth app**, Gitify shows a **Hostname** field. It defaults to `github.com`. Change it to match your instance:

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:
- **GitHub Enterprise Server**: your self-hosted hostname, e.g. `github.mycompany.com`
- **GitHub Enterprise Cloud (Data Residency)**: your tenant hostname, e.g. `myorg.ghe.com`
- **GitHub Enterprise Server (GHES):** your self-hosted hostname, for example `github.mycompany.com`
- **GitHub Enterprise Cloud with data residency (GHDR):** your tenant hostname, for example `myorg.ghe.com`
- **GitHub.com / GitHub Enterprise Cloud on github.com:** leave the hostname as `github.com`

> **Note:** The **Login with GitHub** (Device Flow) method only supports GitHub Cloud (`github.com`) and does not expose a hostname field.
> **Note:** Enterprise Managed Users (EMU) is an account model, not a separate forge. Your enterprise policy may limit which sign-in methods you can use.

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.
> **Note:** **Login with GitHub** only works on GitHub.com (`github.com`) and does not show a hostname field.

**Related:** [What authentication methods does Gitify support?](/faq/#authentication-methods) · [How do I add multiple accounts?](/faq/#multiple-accounts) · [Which Git forges does Gitify support?](/faq/#supported-forges)
22 changes: 13 additions & 9 deletions src/faqs/getting-started/github-scopes.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
---
title: "What GitHub scopes does Gitify require?"
category: "Getting Started"
order: 6
order: 4
---
Gitify needs specific GitHub permissions so it can read your notifications and profile. The required GitHub scopes depend on how you sign in.

> **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).
This article covers **GitHub.com, GitHub Enterprise Cloud, and GitHub Enterprise Server** only.

The required GitHub scopes depend on your chosen authentication method.
#### Login with GitHub and GitHub OAuth app

**Login with GitHub** (Device Flow) and **OAuth App**:
Gitify requests the scopes for you during sign-in. You do not choose them yourself.

Scopes are pre-configured by Gitify and requested automatically during sign-in. No manual scope selection is required.
#### Classic personal access token (PAT)

**Personal Access Token (PAT)**:
When you create a classic PAT, select:

When generating a PAT, the following scopes are required:
- `notifications` — to read GitHub notifications
- `read:user` — to read your GitHub user details (name, profile, avatar)
- `repo` — to enrich notification details for public and private repositories

> **Note:** If you only need access to public repositories, you can use `public_repo` instead of `repo`.
> **Note:** If you only need public repositories, you can use `public_repo` instead of `repo`.

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).
Fine-grained PATs use repository and account permissions instead of these classic scopes. Confirm that your Gitify version and GitHub deployment support the permissions required by fine-grained PATs before using one.

On GitHub.com, create a classic token at [GitHub → Settings → Developer settings → Personal access tokens](https://github.com/settings/tokens). On GitHub Enterprise Cloud or GitHub Enterprise Server, open the same page on your GitHub hostname.

**Related:** [What authentication methods does Gitify support?](/faq/#authentication-methods) · [Why aren't my notifications showing?](/faq/#notifications-not-showing)
24 changes: 13 additions & 11 deletions src/faqs/getting-started/github-sso-pat-authorization.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
---
title: "How do I authorize my PAT for a GitHub SSO organization?"
title: "How do I authorize my classic PAT for a GitHub SSO organization?"
category: "Getting Started"
order: 7
order: 5
---
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.
If your GitHub organization uses SAML single sign-on (SSO), you must authorize your classic personal access token (PAT) for that organization. Until you do, Gitify will not show notifications from that organization's repositories, even if the token has the right scopes.

To authorize a PAT for SSO:
- Open [GitHub → Settings → Personal access tokens](https://github.com/settings/tokens)
- Find the token you use with Gitify
- Click **Configure SSO** next to the token
- Click **Authorize** next to each SSO-enabled organization you want to grant access
- Complete the SSO authentication flow for each organization
1. On GitHub.com, open [GitHub → Settings → Personal access tokens](https://github.com/settings/tokens). On GitHub Enterprise Cloud or GitHub Enterprise Server, open the same page on your GitHub hostname.
2. Find the token you use with Gitify.
3. Click **Configure SSO** next to the token.
4. Click **Authorize** next to each SSO-enabled organization you want to allow.
5. Complete the SSO sign-in for each organization.

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.
After that, Gitify can fetch notifications from those organizations. You may need to authorize again if your SSO session expires or your organization's SSO setup changes.

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).
Fine-grained PATs use different SSO and repository-permission controls.

For more detail, see [GitHub's documentation on authorizing a PAT for 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).

**Related:** [What GitHub scopes does Gitify require?](/faq/#github-scopes) · [Why aren't my notifications showing?](/faq/#notifications-not-showing)
13 changes: 6 additions & 7 deletions src/faqs/getting-started/launch-at-login.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
title: "How do I launch Gitify at login?"
category: "Getting Started"
order: 5
order: 7
---
Gitify can be configured to start automatically when you log in to your computer.
Gitify can start automatically when you log in to your computer.

To enable this:
- Open **Settings** in Gitify
- Navigate to the **System** section
- Toggle **Open at startup**
1. Open **Settings** in Gitify.
2. Go to the **System** section.
3. Turn on **Open at startup**.

> **Note:** This setting is available on **macOS and Windows** only. On Linux, startup behaviour is managed by your desktop environment or init system.
> **Note:** This setting is available on **macOS and Windows** only. On Linux, use your desktop environment or init system to start Gitify at login.
17 changes: 8 additions & 9 deletions src/faqs/getting-started/multiple-accounts.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
---
title: "How do I add multiple accounts?"
category: "Getting Started"
order: 4
order: 6
---
Gitify supports signing in to multiple accounts simultaneously — for example, a personal GitHub Cloud account alongside a Gitea or Bitbucket Cloud account.
Gitify can stay signed in to more than one account at once. You can add several GitHub.com accounts, or mix accounts from different forges — for example GitHub.com with GitHub Enterprise Server, Gitea, or Bitbucket Cloud.

To add an account:
- Open the **Accounts** screen from the Gitify sidebar
- Click **Add new account** and choose your forge and preferred authentication method
- Complete the sign-in flow for the additional account
1. Open the **Accounts** screen from the Gitify sidebar.
2. Click **Add new account** and choose your forge and sign-in method.
3. Finish sign-in for the extra account.

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.
All signed-in accounts appear on the Accounts screen. Click the star next to an account to make it the **primary account** — Gitify uses that account as the default where it needs one.

Each account can be individually refreshed or signed out at any time.
You can refresh or sign out of each account on its own.

For a full list of supported forges, see [Which Git forges does Gitify support?](/faq/#supported-forges).
**Related:** [Which Git forges does Gitify support?](/faq/#supported-forges) · [What authentication methods does Gitify support?](/faq/#authentication-methods)
23 changes: 13 additions & 10 deletions src/faqs/getting-started/oauth-app-setup.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
---
title: "How do I configure OAuth App authentication?"
title: "How do I configure GitHub OAuth app authentication?"
category: "Getting Started"
order: 2
---
> **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).
You can sign in with a GitHub OAuth app on GitHub.com, GitHub Enterprise Cloud, and GitHub Enterprise Server by registering an app and pasting its client ID and secret into Gitify.

To authenticate via an **OAuth App** with GitHub:
- Open [GitHub → Settings → Developer settings → OAuth Apps](https://github.com/settings/developers)
- Click _New OAuth App_
- Set _Authorization callback URL_ to `gitify://oauth`
- Complete all remaining mandatory fields
- Click _Register application_
- Click _Generate a new client secret_
- Use this client/secret pair within Gitify to authenticate.
1. On GitHub.com, open [GitHub → Settings → Developer settings → OAuth Apps](https://github.com/settings/developers). On GitHub Enterprise Cloud or GitHub Enterprise Server, open the same page on your GitHub hostname.
2. Click **New OAuth App**.
3. Set **Authorization callback URL** to `gitify://oauth`.
4. Fill in the other required fields.
5. Click **Register application**.
6. Click **Generate a new client secret**.
7. Enter the client ID and secret in Gitify.

> **Note:** Create a separate OAuth app for each GitHub hostname. Enterprise Managed Users (EMU) and enterprise policies may block OAuth apps. For Gitea, Forgejo, Codeberg, GitLab, and Bitbucket Cloud, use a [personal access token or app password](/faq/#authentication-methods) instead.

**Related:** [What authentication methods does Gitify support?](/faq/#authentication-methods) · [Does Gitify support GitHub Enterprise Cloud and GitHub Enterprise Server?](/faq/#github-enterprise-server)
17 changes: 9 additions & 8 deletions src/faqs/getting-started/supported-forges.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,17 @@ title: "Which Git forges does Gitify support?"
category: "Getting Started"
order: 0
---
Gitify supports notifications from the following Git forges:
Gitify can show notifications from several Git hosts, not only GitHub.com.

- **GitHub Cloud** — `github.com`
- **GitHub Enterprise Server (GHES)** — self-hosted GitHub instances
- **GitHub Enterprise Cloud (Data Residency)** — `[tenant].ghe.com`
- **GitHub.com** — the public `github.com` service, including GitHub Enterprise Cloud organizations hosted there
- **GitHub Enterprise Server (GHES)** — a self-hosted GitHub instance
- **GitHub Enterprise Cloud with data residency (GHDR)** — GitHub Enterprise Cloud on `[tenant].ghe.com`
- **Gitea** — including self-hosted instances
- **Forgejo** — compatible with the Gitea authentication flow
- **Codeberg** — powered by Forgejo, fully supported
- **Forgejo** — uses the same sign-in flow as Gitea
- **Codeberg** — powered by Forgejo
- **Bitbucket Cloud** — `bitbucket.org`
- **GitLab Cloud and Self-Managed** — GitLab.com and self-hosted GitLab

Multiple accounts across different forges can be signed in simultaneously. See [How do I add multiple accounts?](/faq/#multiple-accounts) for details.
You can stay signed in to more than one account at the same time, including accounts on different forges.

For authentication setup, see [What authentication methods does Gitify support?](/faq/#authentication-methods).
**Related:** [What authentication methods does Gitify support?](/faq/#authentication-methods) · [How do I add multiple accounts?](/faq/#multiple-accounts)
11 changes: 7 additions & 4 deletions src/faqs/troubleshooting/chrome-sandbox-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,19 @@ title: "How do I fix Chrome Sandbox permissions on Linux?"
category: "Troubleshooting"
order: 3
---
If you experience issues opening Gitify on Linux due to `Chrome Sandbox` permissions, the Electron sandbox requires root ownership and the SUID bit to be set on the sandbox binary. Run the following commands to fix this:
If Gitify will not open on Linux because of `Chrome Sandbox` permissions, the Electron sandbox binary must be owned by root and have the set-user-ID (SUID) bit set.

1. Run:

```
sudo chown root:root /opt/Gitify/chrome-sandbox
sudo chmod 4755 /opt/Gitify/chrome-sandbox
```

> **Note:** The path `/opt/Gitify/chrome-sandbox` assumes a standard installation. If you installed Gitify via AppImage or to a custom directory, adjust the path accordingly.
2. If Gitify still fails to start, check logs with:

To check for startup errors:
```
journalctl -xe | grep gitify
```
```

> **Note:** `/opt/Gitify/chrome-sandbox` is the path for a standard install. If you installed Gitify as an AppImage or in a custom directory, change the path to match.
Loading