dPanel deploys applications from GitHub repositories, so before your first application you link a GitHub account. You do it once per dPanel account, and dPanel then lists every repository and branch that account, and the GitHub organisations you install the dnocs-id GitHub App on, can read.
What you need first
- A GitHub account that can read the repositories you want to deploy.
- For an organisation's repositories, permission to install a GitHub App in that organisation, or someone who has it.
Connect
- Open Applications in the sidebar.
- Press Connect GitHub at the top of the page.
- GitHub asks you to sign in and approve dPanel. Approve it.
- You come back to dPanel. The button now shows your GitHub login with a check mark.
Your profile shows the same link under Account security: GitHub account reads Connected.
Add a GitHub organisation
The repository picker in Create Application lists your own account and every organisation dPanel can read.
- Open Applications, then Create Application.
- Open the GitHub team list.
- If the organisation is missing, choose Add GitHub account. It opens the dnocs-id GitHub App on GitHub.
- Install the app on the organisation, and give it access to the repositories you want.
- Back in dPanel, the organisation appears in GitHub team.
When GitHub stops answering
GitHub tokens expire. When dPanel can no longer confirm your account you see one of these:
- Reconnect GitHub on the Applications page.
- A banner on an application: GitHub session expired, with Relogin GitHub.
- In the branch list: "GitHub would not confirm your account".
Press the button and sign in to GitHub again. Nothing else changes. Your applications keep running while GitHub is disconnected; only reading repositories and branches stops.
What happens next
Create your first application. See How applications work and Create an application.
You can also ask Ask dPanel which repositories and branches it can see, or to deploy one; see Prompt cookbook.
Frequently asked questions
Does dPanel change my code on GitHub?
No. dPanel reads your repositories and branches to build them on your server. It does not push to them.
Do I connect GitHub once per workspace?
No, once per dPanel account. Every workspace you belong to uses the same link.
My repository is private. Can dPanel deploy it?
Yes, as long as the GitHub account you connected, or the dnocs-id GitHub App on the organisation, can read it.
What happens to my apps if I disconnect GitHub?
They keep running. Only reading repositories and branches stops, so you cannot start a new build until you reconnect.