Portainer Documentation
Official WebsiteKnowledge BasePricingGet 3 Nodes of BE Free
2.29 STS
2.29 STS
  • Welcome
  • What's new in version 2.29
  • Release Notes
  • Getting Started
    • Introduction
    • Portainer architecture
    • Lifecycle policy
    • Requirements and prerequisites
    • Install Portainer BE
      • Set up a new Portainer BE Server installation
        • Docker Standalone
          • Install Portainer BE with Docker on Linux
          • Install Portainer BE with Docker on WSL / Docker Desktop
          • Install Portainer BE with Docker on Windows Container Service
        • Docker Swarm
          • Install Portainer BE with Docker Swarm on Linux
          • Install Portainer BE with Docker Swarm on WSL / Docker Desktop
          • Install Portainer BE with Docker Swarm on Windows Container Service
        • Podman
          • Install Portainer BE with Podman on Linux
        • Kubernetes
          • Install Portainer BE on your Kubernetes environment
          • Install Portainer BE with Kubernetes on WSL / Docker Desktop
        • Initial setup
    • Install Portainer CE
      • Set up a new Portainer CE Server installation
        • Docker Standalone
          • Install Portainer CE with Docker on Linux
          • Install Portainer CE with Docker on WSL / Docker Desktop
          • Install Portainer CE with Docker on Windows Container Service
        • Docker Swarm
          • Install Portainer CE with Docker Swarm on Linux
          • Install Portainer CE with Docker Swarm on WSL / Docker Desktop
          • Install Portainer CE with Docker Swarm on Windows Container Service
        • Podman
          • Install Portainer CE with Podman on Linux
        • Kubernetes
          • Install Portainer CE on your Kubernetes environment
          • Install Portainer CE with Kubernetes on WSL / Docker Desktop
        • Initial setup
    • Add an environment to an existing installation
    • Updating Portainer
      • Updating on Docker Standalone
      • Updating on Docker Swarm
      • Updating on Podman
      • Updating on Kubernetes
      • Updating on Nomad
      • Updating the Edge Agent
      • Updating from Portainer 1.x
      • Switching to Portainer Business Edition
        • Upgrade to Business Edition from within Portainer Community Edition
        • Docker Standalone
        • Docker Swarm
        • Podman
        • Kubernetes
        • Upgrading Agent-only deployments
  • Using Portainer
    • Home
      • Snapshot browsing
      • OpenAMT
    • Docker/Swarm/Podman
      • Dashboard
      • Templates
        • Application
        • Custom templates
        • Deploy a stack
        • Deploy a container
      • Stacks
        • Add a new stack
        • Inspect or edit a stack
        • Create a template from a deployed stack
        • Webhooks
        • Migrate or duplicate a stack
        • Remove a stack
      • Services
        • Add a new service
        • Configure service options
        • Scale a service
        • View the status of a service task
        • View service logs
        • Roll back a service
        • Webhooks
      • Containers
        • Add a new container
        • View a container's details
        • Inspect a container
        • Edit or duplicate a container
        • Advanced container settings
        • Webhooks
        • Attach a volume to a container
        • View container logs
        • View container statistics
        • Access a container's console
        • Change container ownership
        • Remove a container
      • Images
        • Pull an image
        • Build a new image
        • Import an image
        • Export an image
      • Networks
        • Add a new network
        • Remove a network
      • Volumes
        • Add a new volume
        • Browse a volume
        • Remove a volume
      • Configs
        • Add a new config
        • Remove a config
      • Secrets
        • Add a new secret
        • Remove a secret
      • Events
      • Host
        • Details
        • Setup
        • Registries
      • Swarm
        • Details
        • Cluster visualizer
        • Setup
        • Registries
    • Kubernetes
      • Dashboard
      • kubectl shell
      • Kubeconfig
      • Custom Templates
        • Add a new custom template
        • Edit a custom template
        • Remove a custom template
      • Namespaces
        • Add a new namespace
        • Manage a namespace
        • Manage access to a namespace
        • Remove a namespace
      • Applications
        • Add a new application using a form
        • Add a new application using code
        • Inspect an application
        • Inspect a Helm application
        • Edit an application
        • Webhooks
        • Detach a volume from an application
        • Remove an application
      • Networking
        • Services
        • Ingresses
          • Add an Ingress manually
          • Add an Ingress using a manifest
          • Remove an Ingress
      • ConfigMaps & Secrets
        • Add a ConfigMap
        • Add a Secret
      • Volumes
        • Inspect a volume
        • Remove a volume
      • More Resources
        • Cron Jobs & Jobs
        • Service Accounts
        • Cluster Roles
        • Roles
      • Cluster
        • Details
        • Inspect a node
        • Setup
        • Security constraints
        • Registries
    • Azure ACI
      • Dashboard
      • Container instances
        • Add a new container
        • View container details
        • Remove a container
    • Nomad
    • Edge Compute
      • Edge Groups
      • Edge Stacks
        • Add a new Edge Stack
      • Edge Jobs
      • Edge Configurations
      • Waiting Room
      • Edge Templates
        • Application
        • Custom
    • Account settings
  • Administering Portainer
    • User-related
      • Users
      • Add a new user
      • Turn a user into an administrator
      • Reset a user's password
      • Teams
        • Add a new team
        • Add a user to a team
      • Roles
    • Environment-related
      • Environments
      • Add a new environment
        • Add a local environment
        • Add a Docker Standalone environment
          • Install Portainer Agent on Docker Standalone
          • Connect to the Docker API
          • Connect to the Docker Socket
          • Install Edge Agent Standard on Docker Standalone
          • Install Edge Agent Async on Docker Standalone
        • Add a Docker Swarm environment
          • Install Portainer Agent on Docker Swarm
          • Connect to the Docker API
          • Connect to the Docker Socket
          • Install Edge Agent Standard on Docker Swarm
          • Install Edge Agent Async on Docker Swarm
        • Add a Podman environment
          • Install Portainer Agent on Podman
          • Connect to the Podman Socket
          • Install Edge Agent Standard on Podman
          • Install Edge Agent Async on Podman
        • Add a Kubernetes environment
          • Install Portainer Agent on your Kubernetes environment
          • Install Edge Agent Standard on Kubernetes
          • Install Edge Agent Async on Kubernetes
          • Import an existing Kubernetes environment
        • Add an ACI environment
        • Add a Nomad environment
        • Provision KaaS Cluster
          • Civo
          • Akamai Connected Cloud
          • DigitalOcean
          • Google Cloud
          • AWS
          • Azure
        • Create a Kubernetes cluster
          • Talos Kubernetes
          • MicroK8s
            • Offline installation
        • Add an environment via the Portainer API
      • Auto onboarding
      • Groups
      • Tags
      • Manage access to environments
      • Manage access to environment groups
      • Update & Rollback
    • Registries
      • Add a new registry
        • Add a DockerHub account
        • Add an AWS ECR registry
        • Add a Quay.io registry
        • Add a ProGet registry
        • Add an Azure registry
        • Add a Gitlab registry
        • Add a GitHub registry
        • Add a custom registry
      • Browse a registry
      • Manage a registry
    • Licenses
    • Logs
      • Authentication
      • Activity
    • Notifications
    • Settings
      • General
      • Authentication
        • Authenticate via LDAP
        • Authenticate via Active Directory
        • Authenticate via OAuth
      • Shared credentials
        • Add Sidero Omni credentials
        • Add Civo credentials
        • Add Akamai Connected Cloud credentials
        • Add DigitalOcean credentials
        • Add Google Cloud credentials
        • Add AWS credentials
        • Add Azure credentials
        • Add SSH credentials
      • Edge Compute
  • Frequently Asked Questions
    • Portainer Concepts
    • Installing
    • Upgrading
    • Troubleshooting
    • Contributing
  • Advanced Topics
    • CLI configuration options
    • App templates
      • Build and host your own app templates
      • App template JSON format
    • The Portainer Edge Agent
    • Access control
    • Reset the admin user's password
    • Security and compliance
    • Encrypting the Portainer database
    • Using your own SSL certificate with Portainer
    • Using mTLS with Portainer
    • Stream auth and activity logs to an external provider
    • Using Portainer with reverse proxies
      • Deploying Portainer behind Traefik Proxy
      • Deploying Portainer behind nginx reverse proxy
    • How Relative Path Support works in Portainer
    • Helm chart configuration options
    • Docker roles and permissions
    • Kubernetes roles and bindings
    • Deprecated and removed features
  • API
    • Accessing the Portainer API
    • API documentation
    • API usage examples
  • Get More Help
    • Knowledge Base
    • Portainer Academy
    • YouTube
    • GitHub
    • Slack
    • Discord
    • Open a support request
  • Contribute to Portainer
    • Contribute
    • Build instructions
      • Set up a macOS build environment
      • Set up a Linux build environment
Powered by GitBook
On this page
  • Application settings
  • Snapshot interval
  • Edge agent default poll frequency
  • Use custom logo
  • Allow the collection of anonymous statistics
  • Login screen banner
  • App Templates
  • Kubernetes settings
  • Helm Repository
  • Kubeconfig
  • KubeShell
  • Deployment options
  • Certificate Authority file for Kubernetes Helm repositories
  • SSL certificate
  • Force HTTPS only
  • Experimental features
  • Hidden containers
  • Back up Portainer
  • Backing up to a local disk
  • Backing up to S3
  • Restoring from a local file
  • Restoring from S3
  • Portainer support
  • Support bundle
  • Debug log

Was this helpful?

Edit on GitHub
  1. Administering Portainer
  2. Settings

General

PreviousSettingsNextAuthentication

Was this helpful?

Application settings

Snapshot interval

Defines how often a data snapshot of environments is taken. A data snapshot consists of the information displayed on the home page for the environment as well as other basic information. The default is every 5 minutes.

Edge agent default poll frequency

This setting defines the default interval used by Edge Agents when checking in with the Portainer instance.

Use custom logo

Replaces our logo with your own. Toggle on and enter the URL to the logo. The recommended size is 155px by 55px.

Allow the collection of anonymous statistics

We collect anonymized information about your Portainer installation to help with our product development. You can opt out during installation, or toggle this setting off at any time.

Login screen banner

This setting allows you to specify a custom text banner that will appear on the login screen for all users. This could be used to provide informational detail, a warning message, or whatever you need. To enable this, toggle the Login screen banner option on and enter your message in the Details box.

Your message will then be shown at the login screen.

App Templates

You can deploy containers and services using Portainer's set of built-in app templates, or replace them with your own set of templates. Once you have a JSON file containing the template definitions, you can provide the URL to it here.

Kubernetes settings

Helm Repository

If you wish to use your own Helm repository in place of the Bitnami repository we include by default, you can enter the URL here.

Kubeconfig

Here you can select the expiry time for exported kubeconfig files from this dropdown. The new expiry time will only apply to configurations created after this value was changed. Administrators are also able to disable Kubeconfig download for non-admin users here.

Tokens used in kubeconfig files become invalid when Portainer restarts — irrespective of the value set for Kubeconfig expiry. In this case, you will need to re-download the kubeconfig file.

KubeShell

This option lets administrators disable KubeShell access for non-admin users.

Deployment options

In this section you can configure various Kubernetes-specific deployment options.

Field/Option
Overview

Enforce code-based deployment

Enable this option to hide the Add with form button when deploying applications and prevent the adding or editing of Kubernetes resources via forms.

Allow web editor and custom template use

When code-based deployment is enforced, enable this to allow the use of the web editor and custom templates when deploying an application.

Allow specifying of a manifest via a URL

When code-based deployment is enforced, enable this allow the use of the URL option when deploying an application.

Allow per-environment override

Enable this to allow the above enforcement options to be overridden on a per-environment basis.

Require a note on applications

Enable this to require that deployments have the Notes field completed in order to deploy. This setting currently only applies when deploying via a form.

Allow stacks functionality with Kubernetes environments

Enable this to allow grouping of Kubernetes deployments into "stacks", helping to organize and manage related workloads. Disabling this option will hide the stacks functionality on your Kubernetes environments.

Certificate Authority file for Kubernetes Helm repositories

This section lets you supply a certificate authority (CA) file for use with HTTPS connections to Helm repositories from Portainer. This is useful if the TLS certificate your Helm repository uses is signed by a custom CA, and applies to both the Helm Repository configured above and to Helm repositories configured per environment.

This feature is only available in Portainer Business Edition.

SSL certificate

During installation, Portainer by default creates a self-signed SSL certificate to encrypt traffic between the Portainer Server and the end user, as well as between the Portainer Server and the Portainer Agent. This certificate can be replaced with your own certificate.

We recommend including the full chain in the certificate to ensure compatibility. If you do not have the full chain for your certificate, ask your certificate provider or use What's My Chain Cert? to generate it.

Force HTTPS only

If you have configured your Portainer Server instance to listen on 9443 (HTTPS) and 9000 (HTTP) you can toggle Force HTTPS only on to disable listening on port 9000.

Make sure that your HTTPS configuration is working correctly before enabling this option. Failure to do so may result in you being locked out of your Portainer installation.

Ensure that any Edge agents have been correctly configured for HTTPS communication before enabling this.

After making changes to this section, click Apply Changes.

Experimental features

This section allows you to enable experimental Portainer features for use in your deployment. These features are in early development and have gone through a limited set of testing, and are provided to users in order to gather feedback on the feature at an earlier stage of development.

Enabling experimental features on production deployments should be done cautiously and at your own risk.

Field/Option
Overview

Enable OpenAI integration

Toggle this on to enable the OpenAI integration. When this is enabled, individual users will need to add their OpenAI key in their account settings for the feature to be available to them.

Hidden containers

Stops a container from appearing in the Portainer UI through the container label. Enter the name and value of the label, then click Add filter. Containers with matching labels will be hidden.

Back up Portainer

This setting contains all of the information that Portainer stores on the /data volume, archived in a tar.gz file, and is optionally encrypted with a password. This archive is all you need to restore Portainer.

This backup is only intended to back up the Portainer configuration. It does not back up what you have deployed on your environments (for example, containers, stacks, services, volumes, etc).

Backing up to a local disk

Log in as an admin user. From the menu select Settings, then scroll down to the Back up Portainer section.

Download backup file is the default option. As an optional step, toggle Password protect on and enter a password to encrypt the backup file. When you click Download backup, a tar.gz file will be downloaded via the browser.

Backing up to S3

With Portainer Business Edition you have the option to store a backup of your configuration in an S3 bucket, either on demand or on a defined schedule.

To do this, log in as an admin user, select Settings from the menu, then scroll down to Backup Portainer.

Select Store in S3 and fill in the options, using the below as a guide.

Field/Option
Overview

Schedule automatic backups

Enable this to schedule an automatic backup of your configuration to an S3 bucket.

Cron rule

Define how often you want the backup to run using the cron format.

[minute] [hour] [day of month] [month] [day of week]

For example, the following would run a backup at 3:41am every Tuesday:

41 3 * * 2

Access Key ID

Enter the access key ID for your S3 bucket.

Secret Access Key

Enter the secret key for your S3 bucket.

Region

Enter the region where your bucket is located (for example, us-west-1).

Bucket name

Enter the name of your S3 bucket.

S3 compatible host

If you are using a non-AWS S3-compatible provider (such as MinIO), enter the URL (including the protocol and port if necessary) here. If you're using AWS S3, leave this blank.

Password protect

Enable this to protect your backups with a password.

Password

Enter the password to set on your backups.

Restoring from a local file

Restoring a configuration is only possible on a fresh instance of Portainer during the initial installation. When you need to restore Portainer, deploy a fresh instance of Portainer with an empty data volume and choose the Restore Portainer from backup option during setup.

On the initialization page, expand Restore Portainer from backup. Click Select file then browse to and select the tar.gz backup file. If the backup was originally encrypted, enter the password then click Restore Portainer.

The restore might take a few moments. When it has finished, you will be redirected to the login page. You can now log in with your previous credentials and your previous configuration will be restored.

Restoring from S3

This feature is only available in Portainer Business Edition.

Restoring a configuration is only possible on a fresh instance of Portainer during the initial installation. When you need to restore Portainer, deploy a fresh instance of Portainer with an empty data volume and choose the Restore Portainer from backup option during setup, making sure to select Retrieve from S3. Complete the fields using the table below as a guide.

Field/Option
Overview

Access key ID

Enter the access key ID for your S3 bucket.

Secret access key

Enter the secret key for your S3 bucket.

Region

Enter the region where your bucket is located (for example, us-west-1).

Bucket name

Enter the name of your S3 bucket.

S3 Compatible Host

If you are using a non-AWS S3-compatible provider (such as MinIO), enter the URL (including the protocol and port if necessary) here. If you're using AWS S3, leave this blank.

Filename

Enter the filename of the backup you want to restore.

Password

Enter the password set on your backup (if any).

When you're ready, click Restore Portainer. The restore might take a few moments. When it has finished, you will be redirected to the login page. You can now log in with your previous credentials and your previous configuration will be restored.

Portainer support

In this section you will find settings related to troubleshooting your Portainer installation.

Support bundle

This functionality allows you to collect information about your Portainer installation in a bundle that can then be provided to the Portainer support team to aid in troubleshooting issues. Personal information such as passwords and other sensitive credentials are removed from this bundle before being generated.

You can optionally choose to password protect the bundle by toggling on Password Protect and setting a password. If you do choose to set a password, ensure you provide the password to the Portainer support team when you supply the bundle.

Click Download support bundle to generate and download a .tar.gz file containing the bundle.

Debug log

Toggle Enable debug log on to enable debug logging in the Portainer container logs. Debug logging can help with troubleshooting issues by providing a more verbose output.