For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

Settings

Settings holds the configuration that applies to the whole installation and is only available to administrators. Portainer-IDP stores these settings in Portainer's add-on configuration, not in the Helm chart, so installing the add-on asks for no values.

Edge Admin credential

Portainer-IDP deploys every Edge Stack and Edge Group with one Portainer account that has the Edge Administrator role. This card manages that account's access token. See Architecture for why it works this way.

Action
What it does

Set up the Edge Admin account

Creates a Portainer user named portainer-idp-edge-admin with the Edge Administrator role, creates an access token for it, checks the token works, and stores it.

Rotate credentials

Creates and checks a new token before revoking the old one, so deploys keep working throughout.

Save pasted key

Stores an access token you created yourself, pasted into Edge Admin API key, after checking it works. It must belong to an account with the Edge Administrator role.

Create a dedicated account

Shown when the stored key belongs to another account. Replaces it with the dedicated portainer-idp-edge-admin account.

Test credential

Checks the stored credential again.

When Portainer signs users in with LDAP or OAuth, it can't issue a token to a user created through its API, so the one-click setup isn't available. Create the account and its access token in Portainer, then paste the token.

Undeployed manifests

Reports on manifest files that nothing deploys now run from Doctor, only when you ask.

System applications in Git

Where system applications, such as the Sealed Secrets controller, are committed: a Git repository, branch and folder only administrators write to. Choose Change to move it.

System applications already deployed keep their current file. See Cluster Readiness.

Source hosts

The hosts Source Deploy may read public repositories from, one per line. Only https URLs without credentials are accepted.

GitHub, GitLab and Bitbucket are read through their public APIs, and other hosts are treated as GitLab or Gitea compatible. Private and internal addresses are always refused, whatever the list says.

Where other settings live

Setting
Where it lives

Encryption key

Generated by the Helm chart on install, and kept across upgrades and uninstalls. It encrypts the personal access tokens users save. You never need to enter it.

Machine credential

Mounted into the add-on's pod by Portainer, as the Secret portainer-idp-token, whenever it installs, upgrades or repairs the add-on. It can only reach Portainer's add-on configuration store.

Git commit identities

Each user's own, in the add-on's database with the token encrypted. See Git commit identity.

Chart hosts and curated charts

On the Helm Charts page.

Audit retention

Helm chart values. See Audit log.

Last updated

Was this helpful?