Table of contents

• Welcome
• What's new in version 2.39
• Release Notes

Getting Started <a href="#start" id="start"></a>

• 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 <a href="#user" id="user"></a>

• 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, duplicate or rename 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
    • Policies
  • 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
      • Create an application from a Manifest
      • Create an application from a Helm chart
    • Inspect an application
    • Inspect a Helm application
    • Edit an application
    • Edit a Helm 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
    • Custom Resources
    • Cron Jobs & Jobs
    • Service Accounts
    • Cluster Roles
    • Roles
  • Cluster
    • Details
      • Inspect a node
    • Setup
    • Security constraints
    • Registries
    • Policies
• 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
• Observability
  • Alerting
• Account settings

Administering Portainer <a href="#admin" id="admin"></a>

• 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 Edge Agent Standard on Docker Standalone
      • Install Edge Agent Async on Docker Standalone
      • Install Portainer Agent on Docker Standalone
      • Connect to the Docker API
      • Connect to the Docker Socket
    • Add a Docker Swarm environment
      • Install Edge Agent Standard on Docker Swarm
      • Install Edge Agent Async on Docker Swarm
      • Install Portainer Agent on Docker Swarm
      • Connect to the Docker API
      • Connect to the Docker Socket
    • Add a Podman environment
      • Install Edge Agent Standard on Podman
      • Install Edge Agent Async on Podman
      • Install Portainer Agent on Podman
      • Connect to the Podman Socket
    • Add a Kubernetes environment
      • Install Edge Agent Standard on Kubernetes
      • Install Edge Agent Async on Kubernetes
      • Install Portainer Agent on your Kubernetes environment
      • 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
  • Policies
    • Kubernetes Policies
      • Create a Kubernetes RBAC policy
      • Create a Kubernetes security policy
      • Create a Kubernetes setup policy
      • Create a Kubernetes registry policy
    • Docker Policies
      • Create a Docker, Swarm or Podman RBAC policy
      • Create a Docker, Swarm or Podman security policy
      • Create a Docker, Swarm or Podman setup policy
      • Create a Docker, Swarm or Podman registry policy
  • Tags
  • 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
    • Add Git credentials
  • Edge Compute

Frequently Asked Questions <a href="#faqs" id="faqs"></a>

• Getting started
  • How do I get started with Portainer?
  • What is Portainer's architecture?
  • What information does Portainer collect?
  • Can I use Portainer CE in a production environment?
  • How does Portainer secure connectivity to and from Agents and Edge Agents?
  • Which is more secure, the Agent or the Edge Agent?
  • What does Portainer's backup include?
  • How does Portainer respond to CVEs?
  • Can Portainer’s interface language be changed?
  • Why shouldn’t I give all Portainer users admin access?
  • Why do we recommend using the Edge Agent instead of the traditional Agent?
• Installing
  • How do I install Portainer?
  • Can I run Portainer on my configuration?
  • How do I change the port that Portainer runs on?
  • My host is using SELinux. Can I use Portainer?
  • Does Portainer support WSL1?
  • Which ARM architectures does Portainer support?
  • Portainer isn't starting on my Windows server - help!
  • How can I ensure Portainer's configuration is retained?
  • Does Portainer support TLS for socket connections?
  • How do I remove Portainer?
  • How can I deploy the Portainer Agent on a Swarm cluster with Linux and Windows nodes?
  • Portainer fails to deploy on Vultr's VKE platform
  • Does Portainer support Podman?
  • I just installed Portainer but I can't access the UI, how do I fix this?
  • Does Portainer support containerd?
  • "Your Portainer instance has timed out for security purposes" error fix
  • Can I use internal authentication and external authentication at the same time?
• Upgrading and downgrading
  • How do I upgrade Portainer to the latest version?
  • Can I upgrade from Portainer Community Edition to Portainer Business Edition?
  • After upgrading, why doesn’t my version number match the latest version?
  • Why does Portainer keep prompting me to upgrade?
  • Why have my agents stopped working after upgrading Portainer?
  • Can I upgrade an environment from Docker Standalone to Docker Swarm?
  • Can I downgrade from Portainer Business to Portainer CE?
  • Why do my users no longer have access after upgrading to BE from CE?
  • How can I roll back to a previous version of Portainer?
• Licensing
  • What is a node for licensing purposes?
  • Can I add more nodes to my existing subscription?
  • How do I renew my subscription?
  • What is the pricing for Business Edition?
  • How do I enter my Portainer Business license into Portainer CE?
  • How can I move my license from one instance to another?
  • Is there a way to specify the license at the command line?
  • Can I use the same license key / Portainer instance across Dev, QA and Prod environments?
  • Can I use the same license key / Portainer instance across my private network and my public network?
  • License already applied error
  • My Portainer Extensions license has expired. What can I do?
  • A valid authorisation token is missing error
  • Can we add our Business Edition license to Portainer running in Docker Desktop Extension?
  • Switching from Trial License to 3 Free Nodes License
  • I want to use my License in a different environment. How do I do this?
  • Why isn’t my 3- license key working?
  • How do I renew my 3 nodes free license?
  • How do I renew my 5 nodes free license?
• Troubleshooting
  • Access and authentication
    • How can I switch back to internal authentication?
    • I enabled "Force HTTPS only" and now I'm locked out of Portainer. How do I get back in?
    • How do I reset my Portainer password?
    • Client sent an HTTP request to an HTTPS server
    • Unable to Authenticate After Portainer Update
    • Unable to Login via LDAP in Portainer
    • LDAP Groups are not auto-populating Portainer teams
  • Agents and environment management
    • How can I move existing Edge Agent deployments to a new Portainer Server instance?
    • Why can't my agents communicate with Portainer on Swarm?
    • Why has my Environment IP not updated after I changed it?
    • Why is my Portainer Edge Agent using a large amount of memory?
    • Troubleshooting Edge Agent Connection Issues
    • How do I change the way I connect to an environment without losing my existing stacks?
  • Stacks, deployments and updates
    • Why do relative bind mounts appear empty after updating a stack that was deployed from Git?
    • How do automatic updates for stacks/applications work?
    • How does the image update notification icon work?
    • Can I build an image while deploying a stack/application from Git?
    • Why don't custom standalone app templates show when using Docker Swarm?
    • How do I configure Portainer's GitOps features to authenticate to a Bitbucket repository?
    • Why are stack deployment times slow?
    • Environment Variable Management in Docker: .env vs. stack.env
    • How do I recover orphaned stacks from a previously deleted environment?
  • UI and features
    • Why can't I use the console with my container?
    • Exposed ports in the container view redirect me to 0.0.0.0. What can I do?
    • Why is a feature only available in Portainer Business Edition?
    • Runtime and Resource sliders are not showing the set value on ARM
    • Why doesn’t the Portainer UI load inside an iframe?
    • Why can I not see an option to update the Portainer version within the UI?
  • Logs, errors and debugging
    • Unable to Access Pod Logs in My k0s Cluster
    • Can you view deleted container logs in Portainer?
    • How can I get the logs for Portainer itself?
    • Why can't my users see anything in the environment they have access to?
    • Why do I see a lot of TLS handshake errors in my Portainer and/or Agent logs?
    • "Failed to get license info" or "Unable to retrieve license info" message with valid license
    • What does a 500 error code mean?
    • Why is my console closing after a certain time?
    • “Failed logging user activity” error in Portainer
  • Certificates and security
    • How to enable/disable image Up-to-date indicator
    • How can I use my custom certificate authority (CA) with Portainer?
  • Registry and image management
    • Why is my node count higher than it should be?
    • I am unable to push an image to an AWS Elastic Container Registry
• Contributing
  • How do I report a bug?
  • How do I raise a feature request?
  • How do you decide which bugs and features to work on first?
  • How do I log a Support Request?
  • How do I report a security vulnerability?
• Known issues
  • Edge stacks do not support authenticating to deploy applications from private registries
  • Known issues with VMware
  • Groups info issue with OAuth using Microsoft AD
  • Resource limits in a compose file are not applying
  • Hardware Acceleration GPU button is missing
  • Unable to update environment variables when running on Synology NAS
  • Unable to remove the Group Configuration from Active Directory authentication configuration
  • "Image not found on registry" error when upgrading from CE to BE or self-updating on Synology NAS
  • MicroK8s Known Issues
  • "Unauthorized" error when pushing images to ACR with Service Principal account
  • "Invalid certificate file" error when browsing empty Azure Container Registry
  • Environments not loading with Docker Engine 29.0.0
  • Docker Compose files including build steps fail
• Getting support
  • How to get support for Community Edition and 5 Nodes Free Users
  • How to get support for Business Edition Customers with a subscription
  • Which versions of Portainer do you provide support for?

Advanced Topics <a href="#advanced" id="advanced"></a>

• 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 <a href="#help" id="help"></a>

• Portainer Academy
• YouTube
• GitHub
• Slack
• Discord
• Open a support request

Contribute to Portainer <a href="#contribute" id="contribute"></a>

• Contribute
• Build instructions
  • Set up a macOS build environment
  • Set up a Linux build environment

---

• Privacy Policy