mirror of
https://github.com/portainer/portainer-docs.git
synced 2026-03-27 12:58:32 +07:00
39 KiB
39 KiB
Table of contents
Getting Started
- Introduction
- Portainer architecture
- Lifecycle policy
- Requirements and prerequisites
- Install Portainer BE
- Install Portainer CE
- Add an environment to an existing installation
- Updating Portainer
Using Portainer
- Home
- Docker/Swarm/Podman
- Kubernetes
- Dashboard
- kubectl shell
- Kubeconfig
- Custom Templates
- Namespaces
- Applications
- Networking
- ConfigMaps & Secrets
- Volumes
- More Resources
- Cluster
- Azure ACI
- Nomad
- Edge Compute
- Observability
- Account settings
Administering Portainer
- User-related
- Environment-related
- Environments
- Add a new environment
- Auto onboarding
- Groups
- Policies
- Tags
- Update & Rollback
- Registries
- Licenses
- Logs
- Notifications
- Settings
Frequently Asked Questions
- 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?
- What scopes are required for GitHub, GitLab and Bitbucket tokens?
- 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
- Registry and image management
- Access and authentication
- Contributing
- 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
Advanced Topics
- CLI configuration options
- App templates
- 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
- How Relative Path Support works in Portainer
- Helm chart configuration options
- Docker roles and permissions
- Kubernetes roles and bindings
- Deprecated and removed features