portainer-docs/SUMMARY.md

Table of contents

• Welcome
• Release Notes

Getting Started

• Introduction
• Portainer architecture
• Requirements and prerequisites
• Install Portainer CE
  • Set up a new Portainer Server installation
    • Docker Standalone
      • Install Portainer with Docker on Linux
      • Install Portainer with Docker on WSL / Docker Desktop
      • Install Portainer with Docker on Windows Container Service
    • Docker Swarm
      • Install Portainer with Docker Swarm on Linux
      • Install Portainer with Docker Swarm on WSL / Docker Desktop
      • Install Portainer with Docker Swarm on Windows Container Service
    • Kubernetes
      • Install Portainer with Kubernetes on your Self-Managed Infrastructure
      • Install Portainer with Kubernetes on WSL / Docker Desktop
    • Initial Setup
  • Add an environment to an existing installation
    • Docker Standalone
      • Install Portainer Agent with Docker on Linux
      • Install Portainer Agent with Docker on WSL / Docker Desktop
      • Install Portainer Agent with Docker on Windows Container Service
    • Docker Swarm
      • Install Portainer Agent with Docker Swarm on Linux
      • Install Portainer Agent with Docker Swarm on WSL / Docker Desktop
      • Install Portainer Agent with Docker Swarm on Windows Container Service
    • Kubernetes
      • Install Portainer Agent with Kubernetes on your Self-Managed Infrastructure
      • Install Portainer Agent with Kubernetes on WSL / Docker Desktop
    • Azure ACI
    • Edge Agent

Using Portainer

• Docker/Swarm
  • Dashboard
  • App Templates
    • 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
    • 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
    • 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
    • Setup
  • Swarm
    • Setup
    • Cluster visualizer
• Kubernetes
  • Dashboard
  • Namespaces
    • Add a new namespace
    • Manage access to a namespace
    • Remove a namespace
  • Applications
    • Add a new application
    • Inspect an application
    • Detach a volume from an application
    • Advanced application deployment
    • Remove an application
  • Configurations
    • Add a new configuration
    • Remove a configuration
  • Volumes
    • Inspect a volume
    • Remove a volume
  • Cluster
    • Setup
    • Inspect a node
• Azure ACI
  • Dashboard
  • Container instances
    • Add a new container
    • Remove a container
• Edge Compute
  • Edge Groups
  • Edge Stacks
  • Edge Jobs

Administering Portainer

• Users
  • Teams
    • Add a new team
    • Add a user to a team
  • Roles
  • Add a new user
  • Turn a user into an administrator
  • Reset a user's password
• Endpoints
  • Groups
  • Tags
  • Add a new endpoint
    • Add a local endpoint
    • Add a Docker Standalone endpoint
    • Add a Docker Swarm endpoint
    • Add a Kubernetes endpoint
    • Add an Edge endpoint
    • Add an ACI endpoint
    • Add an endpoint via the Portainer API
  • Manage access to endpoints
  • Manage access to endpoint groups
• Registries
  • Add a new registry
    • Add a Quay.io registry
    • Add an Azure registry
    • Add a Gitlab registry
    • Add a custom registry
  • Enable Docker Hub authentication
• Settings
  • Authentication
    • Authenticate via LDAP
    • Authenticate via OAuth
• Upgrading Portainer
  • Upgrading on Docker
  • Upgrading on Docker Swarm
  • Upgrading on Kubernetes
  • Switching from CE to Portainer Business
    • Docker Standalone
    • Docker Swarm
    • Kubernetes

Frequently Asked Questions

• Portainer Concepts
  • What is Portainer's architecture?
  • What information does Portainer collect?
  • What is Portainer CE's licensing model?
• Installing
  • How do I install Portainer CE?
  • Can I run Portainer on my configuration?
  • How do I change the port that Portainer uses?
  • My host is using SELinux. Can I use Portainer?
  • Does Portainer support WSL1?
  • How do I enter my Portainer Business license into Portainer CE?
• Upgrading
  • How do I upgrade Portainer CE to the latest version?
  • Can I upgrade Portainer CE to Portainer Business?
  • After an update, why doesn’t my version number match the latest version?
  • Why does Portainer keep prompting me to upgrade?
  • Can I upgrade an endpoint from Docker Standalone to Docker Swarm?
  • Can I downgrade from Portainer Business to Portainer CE?
• Troubleshooting
  • My Portainer Extensions license has expired. What can I do?
  • Why can't my users see anything in the endpoint they have access to?
  • Why don't custom standalone app templates show when using Docker Swarm?
  • Why can't I find images in my private registry on Kubernetes?
  • Can you view deleted container logs in Portainer?
  • Exposed ports in the container view redirect me to 0.0.0.0. What can I do?
  • How can I get the logs for Portainer itself?
  • How do I reset my Portainer password?
• 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 ticket?

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
• Using SSL with Portainer
• Using Portainer with reverse proxies
  • Deploying Portainer behind Traefik Proxy
  • Deploying Portainer behind nginx reverse proxy
• Helm chart configuration options
• Deprecated and removed features

API

• API documentation
• API usage examples

Get More Help

• YouTube
• Slack
• Discord

Contribute to Portainer

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