Connect a site
The GitHub App
What the Ulika GitHub App can do, which permissions it asks for and why, and how to add or change the repositories it can see.
Last updated
Ulika reaches your code through a GitHub App. A GitHub App is GitHub's safest way to give a tool access to specific repositories: you pick the repositories, GitHub shows the exact permissions, and you can remove access at any time. This page explains what the Ulika app can do, how to add repositories to it, and what to do when GitHub's permission screens appear.
How the access works#
You install the app on a GitHub account (your own, or an organization you own) and choose which repositories it may see. From then on, Ulika uses a short-lived credential for that one installation:
Ulika proves it is the app with a token that lasts under ten minutes. That token can only list installations and request access tokens. It cannot read any code.
It then asks GitHub for an installation token, valid for about an hour, limited to the repositories you selected and the permissions the app declared. This is the only thing that can read your repository.
Neither token is stored on disk or in a database. The installation token is kept in memory only and dies with the process.
Installing the app#
In the dashboard, check your site, then click Connect with GitHub and Continue with GitHub. See Connect from the dashboard.
On GitHub, choose the account that owns the repository.
Choose which repositories to share. GitHub lets you share all repositories or only selected ones. Sharing only the repository that builds your site is enough.
Confirm. GitHub sends you back to Ulika.
If the repository belongs to an organization and you are not an owner, GitHub sends a request to an owner instead. Ulika shows Your request was sent. An owner has to approve the installation on GitHub, then you connect again.
If you installed Ulika on more than one of your GitHub accounts, Ulika asks Which GitHub account is this website on? and you click Use this account on the right one.
Permissions#
This table lists what Ulika's code requests and checks. The installation page on GitHub shows what was actually granted to your account.
Ulika asks for these permissions. The first two are what reading your code needs. The rest are what writing the connector and verifying it needs.
| Permission | Level | What Ulika uses it for |
|---|---|---|
| Metadata | Read | Read the repository name, description and default branch so Ulika can show you which repository it found. GitHub requires this alongside any other permission. |
| Contents | Read | Read the source files of the repository you pick so Ulika can find the text on your pages. |
| Contents | Write | Later, and only after you have seen the complete diff and clicked: create a branch with the connector files. On Publish, commit one content file. Never a force push and never a history rewrite. |
| Pull requests | Write | Open the pull request you review in your own tools. Nothing merges unless you ask for it, and the only merge Ulika makes is the one you approved. Also used to close Ulika's own outdated connector pull request (never one anyone else opened or changed) when it replaces it. |
| Commit statuses | Read | Read build results your host reports, so Ulika can confirm a preview without a Vercel connection. |
| Checks | Read | Read check runs your host reports (for example from Cloudflare Pages). |
| Deployments | Read | Read deployments your host reports, including whether a production build failed. |
Why the app asks for more later#
Ulika first asks only for what it needs to read your code. Writing needs two more permissions, and verifying builds needs three more read-only ones. GitHub requires an account owner to accept a permission change before a wider grant takes effect. Until then Ulika tells you what is missing instead of failing with a vague error.
Accepting new permissions#
You see one of two messages, depending on which permissions are missing.
Ulika cannot write to this repository yet. The app was installed with read-only access. Click Open GitHub permissions, accept the update on the installation, then return and click I've accepted it — check again. The Turn on live editing button stays disabled until you do.
Approve Ulika's updated GitHub permissions. Ulika now asks to read your host's build results (commit statuses, checks and deployments), read-only. Click Review on GitHub. Until you approve, everything keeps working, and Ulika checks your live site after merging instead. The banner disappears by itself when you come back to the tab and the permissions are accepted.
Both buttons open the installation's own page on GitHub:
For a personal account, the Ulika installation under
https://github.com/settings/installations.For an organization, the Ulika installation under the organization's own Settings, in its installed GitHub Apps.
On that page GitHub shows the pending request at the top, and an owner can accept it there.
What Ulika will never do with these permissions#
Write the connector to your default branch. It always goes to a new branch and a pull request.
Force push, rewrite history or delete a branch.
Merge a commit it did not write.
Store your source code. Your code is read in memory for one scan and is never saved.
The only writes to your default branch are the merge you approved, an automatic revert of that merge if the live build fails, and, on Publish, one content file. See Approving a connection and Publish.
Adding repositories#
The repository you need may not be visible to Ulika, because an installation only includes the repositories you selected. You see this on the repository picker:
Add a repository to continue when Ulika is installed but no repository was shared.
Not seeing the repository you want? with an Add a repository on GitHub button when some are shared.
To add one:
Click Add a repository on GitHub. A new tab opens on GitHub, on the installation's page when the installation covers selected repositories, and on the Ulika app's install page otherwise.
Add the repository and save.
Return to the Ulika tab. The list refreshes on its own, or click Refresh list.
Ulika reads the whole list of repositories the installation can see before it searches it, because GitHub does not search inside an installation. Typing in Search your repositories reuses one read for about half a minute.
One repository, one workspace#
A repository can be connected in only one Ulika workspace at a time. Two workspaces publishing into one repository would overwrite each other. If the repository is already used elsewhere, you see This repository is connected in another workspace. Disconnect it there first, or pick another repository.
When access changes on GitHub#
If you or an owner change the installation on GitHub, Ulika tells you in plain words:
| What you see | What happened |
|---|---|
| Access to GitHub is suspended | The installation was suspended on GitHub. |
| Ulika's access to GitHub was removed | The app was uninstalled. Install it again to continue. |
| That repository is no longer reachable | GitHub no longer shows Ulika that repository, for example because it was removed from the installation. |
| Ulika no longer has permission to read the code | The permissions were lowered. |
| GitHub is asking us to slow down | GitHub's rate limit. Wait a few minutes. |
| GitHub could not be reached | A temporary problem. Try again. |
Removing the installation also revokes any AI agent that was approved through it. See Connect with AI agents.
If you are stuck, see Troubleshooting GitHub.
Removing access#
You can remove Ulika at any time on GitHub, in your account or organization settings under the installed apps. Removing it stops Ulika from reading or writing your repository. The connector files already merged stay in your repository because they are part of your code, and your site keeps building. If you also want them gone, remove them in a normal commit.
Was this page helpful?