Skip to content

docs(enterprise): tell self-hosted admins to upload the App logo #12391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 1 commit into from
Aug 14, 2026
+32 −0
Merged

docs(enterprise): tell self-hosted admins to upload the App logo #12391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file added public/mergify-github-app-logo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions src/content/docs/enterprise/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'Step-by-step process for deploying the on-premise image and wiring
---

import { Image } from "astro:assets"
import DownloadLink from "../../../components/DownloadLink.astro"
import installerScreen from "../../images/enterprise/installer.png"
import createGitHubAppScreen from "../../images/enterprise/create-github-app.png"
import installerEnvScreen from "../../images/enterprise/installer-env.png"
Expand Down Expand Up @@ -108,6 +109,34 @@ The GitHub App creation and installation is finished.

<Image src={installSuccessScreen} alt="Mergify App Installation Success" />

## Set the GitHub App Logo

The App you just created has no logo, so its check runs show GitHub's default
placeholder image on every pull request. Uploading a logo is a manual step: the
manifest the installer submits refuses any image field, and GitHub offers no API
to change an App registration once it exists. You only have to do it once, and it
applies to everything the App posts from then on.

Download <DownloadLink href="/mergify-github-app-logo.png">the Mergify
logo</DownloadLink>, or use your own image. GitHub accepts a PNG, JPG, or GIF
under 1 MB, and recommends 200 by 200 pixels.

Then:

1. Open your organization's **Settings → Developer settings → GitHub Apps** and
click **Edit** next to the App. The direct URL is
`https://<your-github-host>/organizations/<your-org>/settings/apps/<your-app-name>`,
where `<your-github-host>` is `github.com` or your GitHub Enterprise Server
host.

2. Under **Display information**, drag the image onto the logo area or click
**Upload a logo**.

3. Adjust the crop if you need to, then click **Set new avatar**.

A **Badge background color** field appears under the logo once one is uploaded.
It fills the background of the App's badge; `#000000` matches the Mergify logo.

## Stop the Installer

You can now stop the installer container:
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/enterprise/manual-installation-legacy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ description: 'Legacy process for provisioning the Mergify GitHub App and engine
From the GitHub App page, click **Install App**, pick your organization, choose the repositories to
manage, and complete the installation.

The App has no logo at this point, so its check runs show GitHub's default placeholder image. See
[Set the GitHub App Logo](/enterprise/installation/#set-the-github-app-logo) to upload one.

## 3. Build `mergify.env`

Create a file named `mergify.env` with at least:
Expand Down