Registry Credentials
To run a private image, we need a login for its registry. Public images need no credentials.
Adding a credential
Section titled “Adding a credential”- Head over to your workspace’s “Registries” page, under “Security” in the sidebar
- Hit “New credential”
- Choose the registry: Docker Hub, GitHub Container Registry, GitLab Container Registry or “Custom…”
- Enter the username and a password or access token
- Hit “Save”
We check the login against the registry when you save. Each preset shows how to create a token for that registry. Use a token with only read access to images.
A workspace has one credential per registry. Saving another for the same registry replaces it.
How we use it
Section titled “How we use it”We match the credential to the registry in the app’s image, on every deploy and redeploy. An image without a registry, such as nginx, comes from Docker Hub.
Testing, rotating and deleting
Section titled “Testing, rotating and deleting”On the “Registries” page, each credential has:
| Action | What it does |
|---|---|
| Test | Checks the stored login against the registry |
| Edit | Changes the username or token. Leave the token empty to keep the current one |
| Delete | Removes the credential. Apps already running keep running. The next deploy pulls without a login |
Adding or changing credentials needs write access to apps. Read more in Roles and Permissions.