# Table of contents

* [Welcome](README.md)
* [What's new in version 2.18](whats-new.md)
* [Release Notes](release-notes.md)

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

* [Introduction](start/intro.md)
* [Portainer architecture](start/architecture.md)
* [Requirements and prerequisites](start/requirements-and-prerequisites.md)
* [Install Portainer BE](start/install/README.md)
  * [Set up a new Portainer BE Server installation](start/install/server/README.md)
    * [Docker Standalone](start/install/server/docker/README.md)
      * [Install Portainer BE with Docker on Linux](start/install/server/docker/linux.md)
      * [Install Portainer BE with Docker on WSL / Docker Desktop](start/install/server/docker/wsl.md)
      * [Install Portainer BE with Docker on Windows Container Service](start/install/server/docker/wcs.md)
    * [Docker Swarm](start/install/server/swarm/README.md)
      * [Install Portainer BE with Docker Swarm on Linux](start/install/server/swarm/linux.md)
      * [Install Portainer BE with Docker Swarm on WSL / Docker Desktop](start/install/server/swarm/wsl.md)
      * [Install Portainer BE with Docker Swarm on Windows Container Service](start/install/server/swarm/wcs.md)
    * [Kubernetes](start/install/server/kubernetes/README.md)
      * [Install Portainer BE on your Kubernetes environment](start/install/server/kubernetes/baremetal.md)
      * [Install Portainer BE with Kubernetes on WSL / Docker Desktop](start/install/server/kubernetes/wsl.md)
    * [Initial setup](start/install/server/setup.md)
* [Install Portainer CE](start/install-ce/README.md)
  * [Set up a new Portainer CE Server installation](start/install-ce/server/README.md)
    * [Docker Standalone](start/install-ce/server/docker/README.md)
      * [Install Portainer CE with Docker on Linux](start/install-ce/server/docker/linux.md)
      * [Install Portainer CE with Docker on WSL / Docker Desktop](start/install-ce/server/docker/wsl.md)
      * [Install Portainer CE with Docker on Windows Container Service](start/install-ce/server/docker/wcs.md)
    * [Docker Swarm](start/install-ce/server/swarm/README.md)
      * [Install Portainer CE with Docker Swarm on Linux](start/install-ce/server/swarm/linux.md)
      * [Install Portainer CE with Docker Swarm on WSL / Docker Desktop](start/install-ce/server/swarm/wsl.md)
      * [Install Portainer CE with Docker Swarm on Windows Container Service](start/install-ce/server/swarm/wcs.md)
    * [Kubernetes](start/install-ce/server/kubernetes/README.md)
      * [Install Portainer CE on your Kubernetes environment](start/install-ce/server/kubernetes/baremetal.md)
      * [Install Portainer CE with Kubernetes on WSL / Docker Desktop](start/install-ce/server/kubernetes/wsl.md)
    * [Initial setup](start/install-ce/server/setup.md)
* [Add an environment to an existing installation](start/agent.md)
* [Upgrading Portainer](start/upgrade/README.md)
  * [Upgrading on Docker Standalone](start/upgrade/docker.md)
  * [Upgrading on Docker Swarm](start/upgrade/swarm.md)
  * [Upgrading on Kubernetes](start/upgrade/kubernetes.md)
  * [Upgrading on Nomad](start/upgrade/nomad.md)
  * [Upgrading the Edge Agent](start/upgrade/edge.md)
  * [Switching to Portainer Business Edition](start/upgrade/tobe/README.md)
    * [Upgrade to Business Edition from Portainer](start/upgrade/tobe/inapp.md)
    * [Docker Standalone](start/upgrade/tobe/docker.md)
    * [Docker Swarm](start/upgrade/tobe/swarm.md)
    * [Kubernetes](start/upgrade/tobe/kubernetes.md)
    * [Upgrading Agent-only deployments](start/upgrade/tobe/agent.md)

## Using Portainer <a href="#user" id="user"></a>

* [Home](user/home/README.md)
  * [Snapshot browsing](user/home/snapshot.md)
  * [OpenAMT](user/home/openamt.md)
* [Docker/Swarm](user/docker/README.md)
  * [Dashboard](user/docker/dashboard.md)
  * [App Templates](user/docker/templates/README.md)
    * [Custom templates](user/docker/templates/custom.md)
    * [Deploy a stack](user/docker/templates/deploy-stack.md)
    * [Deploy a container](user/docker/templates/deploy-container.md)
  * [Stacks](user/docker/stacks/README.md)
    * [Add a new stack](user/docker/stacks/add.md)
    * [Inspect or edit a stack](user/docker/stacks/edit.md)
    * [Create a template from a deployed stack](user/docker/stacks/template.md)
    * [Webhooks](user/docker/stacks/webhooks.md)
    * [Migrate or duplicate a stack](user/docker/stacks/migrate.md)
    * [Remove a stack](user/docker/stacks/remove.md)
  * [Services](user/docker/services/README.md)
    * [Add a new service](user/docker/services/add.md)
    * [Configure service options](user/docker/services/configure.md)
    * [Scale a service](user/docker/services/scale.md)
    * [View the status of a service task](user/docker/services/tasks.md)
    * [View service logs](user/docker/services/logs.md)
    * [Roll back a service](user/docker/services/rollback.md)
    * [Webhooks](user/docker/services/webhooks.md)
  * [Containers](user/docker/containers/README.md)
    * [Add a new container](user/docker/containers/add.md)
    * [View a container's details](user/docker/containers/view.md)
    * [Inspect a container](user/docker/containers/inspect.md)
    * [Edit or duplicate a container](user/docker/containers/edit.md)
    * [Advanced container settings](user/docker/containers/advanced.md)
    * [Webhooks](user/docker/containers/webhooks.md)
    * [Attach a volume to a container](user/docker/containers/attach-volume.md)
    * [View container logs](user/docker/containers/logs.md)
    * [View container statistics](user/docker/containers/stats.md)
    * [Access a container's console](user/docker/containers/console.md)
    * [Change container ownership](user/docker/containers/ownership.md)
    * [Remove a container](user/docker/containers/remove.md)
  * [Images](user/docker/images/README.md)
    * [Pull an image](user/docker/images/pull.md)
    * [Build a new image](user/docker/images/build.md)
    * [Import an image](user/docker/images/import.md)
    * [Export an image](user/docker/images/export.md)
  * [Networks](user/docker/networks/README.md)
    * [Add a new network](user/docker/networks/add.md)
    * [Remove a network](user/docker/networks/remove.md)
  * [Volumes](user/docker/volumes/README.md)
    * [Add a new volume](user/docker/volumes/add.md)
    * [Browse a volume](user/docker/volumes/browse.md)
    * [Remove a volume](user/docker/volumes/remove.md)
  * [Configs](user/docker/configs/README.md)
    * [Add a new config](user/docker/configs/add.md)
    * [Remove a config](user/docker/configs/remove.md)
  * [Secrets](user/docker/secrets/README.md)
    * [Add a new secret](user/docker/secrets/add.md)
    * [Remove a secret](user/docker/secrets/remove.md)
  * [Events](user/docker/events.md)
  * [Host](user/docker/host/README.md)
    * [Setup](user/docker/host/setup.md)
    * [Registries](user/docker/host/registries.md)
  * [Swarm](user/docker/swarm/README.md)
    * [Setup](user/docker/swarm/setup.md)
    * [Cluster visualizer](user/docker/swarm/cluster-visualizer.md)
    * [Registries](user/docker/swarm/registries.md)
* [Kubernetes](user/kubernetes/README.md)
  * [Dashboard](user/kubernetes/dashboard.md)
  * [kubectl shell](user/kubernetes/kubectl.md)
  * [Kubeconfig](user/kubernetes/kubeconfig.md)
  * [Custom Templates](user/kubernetes/templates/README.md)
    * [Add a new custom template](user/kubernetes/templates/add.md)
    * [Edit a custom template](user/kubernetes/templates/edit.md)
    * [Remove a custom template](user/kubernetes/templates/remove.md)
  * [Namespaces](user/kubernetes/namespaces/README.md)
    * [Add a new namespace](user/kubernetes/namespaces/add.md)
    * [Manage a namespace](user/kubernetes/namespaces/manage.md)
    * [Manage access to a namespace](user/kubernetes/namespaces/access.md)
    * [Remove a namespace](user/kubernetes/namespaces/remove.md)
  * [Helm](user/kubernetes/helm/README.md)
    * [Deploy a new application from a Helm chart](user/kubernetes/helm/deploy.md)
  * [Applications](user/kubernetes/applications/README.md)
    * [Add a new application using a form](user/kubernetes/applications/add.md)
    * [Add a new application using a manifest](user/kubernetes/applications/manifest.md)
    * [Inspect an application](user/kubernetes/applications/inspect.md)
    * [Edit an application](user/kubernetes/applications/edit.md)
    * [Webhooks](user/kubernetes/applications/webhooks.md)
    * [Detach a volume from an application](user/kubernetes/applications/detach-volume.md)
    * [Remove an application](user/kubernetes/applications/remove.md)
  * [Services](user/kubernetes/services.md)
  * [Ingresses](user/kubernetes/ingresses/README.md)
    * [Add an Ingress manually](user/kubernetes/ingresses/add.md)
    * [Add an Ingress using a manifest](user/kubernetes/ingresses/manifest.md)
    * [Remove an Ingress](user/kubernetes/ingresses/remove-an-ingress.md)
  * [ConfigMaps & Secrets](user/kubernetes/configurations/README.md)
    * [Add a ConfigMap](user/kubernetes/configurations/add.md)
    * [Add a Secret](user/kubernetes/configurations/add-1.md)
    * [Remove a ConfigMap or Secret](user/kubernetes/configurations/remove.md)
  * [Volumes](user/kubernetes/volumes/README.md)
    * [Inspect a volume](user/kubernetes/volumes/inspect.md)
    * [Remove a volume](user/kubernetes/volumes/remove.md)
  * [Cluster](user/kubernetes/cluster/README.md)
    * [Setup](user/kubernetes/cluster/setup.md)
    * [Inspect a node](user/kubernetes/cluster/node.md)
    * [Security constraints](user/kubernetes/cluster/security.md)
    * [Registries](user/kubernetes/cluster/registries.md)
* [Azure ACI](user/aci/README.md)
  * [Dashboard](user/aci/dashboard.md)
  * [Container instances](user/aci/containers/README.md)
    * [Add a new container](user/aci/containers/add.md)
    * [Remove a container](user/aci/containers/remove.md)
* [Nomad](user/nomad/README.md)
  * [Dashboard](user/nomad/dashboard.md)
  * [Nomad Jobs](user/nomad/jobs.md)
* [Edge Compute](user/edge/README.md)
  * [Edge Groups](user/edge/groups.md)
  * [Edge Stacks](user/edge/stacks.md)
  * [Edge Jobs](user/edge/jobs.md)
  * [Waiting Room](user/edge/waiting-room.md)
* [Account settings](user/account-settings.md)

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

* [Users](admin/users/README.md)
  * [Teams](admin/users/teams/README.md)
    * [Add a new team](admin/users/teams/add.md)
    * [Add a user to a team](admin/users/teams/add-user.md)
  * [Roles](admin/users/roles.md)
  * [Add a new user](admin/users/add.md)
  * [Turn a user into an administrator](admin/users/promote.md)
  * [Reset a user's password](admin/users/password.md)
* [Environments](admin/environments/README.md)
  * [Groups](admin/environments/groups.md)
  * [Tags](admin/environments/tags.md)
  * [Add a new environment](admin/environments/add/README.md)
    * [Add a local environment](admin/environments/add/local.md)
    * [Add a Docker Standalone environment](admin/environments/add/docker/README.md)
      * [Install Portainer Agent on Docker Standalone](admin/environments/add/docker/agent.md)
      * [Connect to the Docker API](admin/environments/add/docker/api.md)
      * [Connect to the Docker Socket](admin/environments/add/docker/socket.md)
      * [Install Edge Agent Standard on Docker Standalone](admin/environments/add/docker/edge.md)
      * [Install Edge Agent Async on Docker Standalone](admin/environments/add/docker/edge-async.md)
    * [Add a Docker Swarm environment](admin/environments/add/swarm/README.md)
      * [Install Portainer Agent on Docker Swarm](admin/environments/add/swarm/agent.md)
      * [Connect to the Docker API](admin/environments/add/swarm/api.md)
      * [Connect to the Docker Socket](admin/environments/add/swarm/socket.md)
      * [Install Edge Agent Standard on Docker Swarm](admin/environments/add/swarm/edge.md)
      * [Install Edge Agent Async on Docker Swarm](admin/environments/add/swarm/edge-async.md)
    * [Add a Kubernetes environment](admin/environments/add/kubernetes/README.md)
      * [Install Portainer Agent on your Kubernetes environment](admin/environments/add/kubernetes/agent.md)
      * [Install Edge Agent Standard on Kubernetes](admin/environments/add/kubernetes/edge.md)
      * [Install Edge Agent Async on Kubernetes](admin/environments/add/kubernetes/edge-async.md)
      * [Import an existing Kubernetes environment](admin/environments/add/kubernetes/import.md)
    * [Add an ACI environment](admin/environments/add/aci.md)
    * [Add a Nomad environment](admin/environments/add/nomad.md)
    * [Provision KaaS Cluster](admin/environments/add/kaas/README.md)
      * [Civo](admin/environments/add/kaas/civo.md)
      * [Linode](admin/environments/add/kaas/linode.md)
      * [DigitalOcean](admin/environments/add/kaas/digitalocean.md)
      * [Google Cloud](admin/environments/add/kaas/gke.md)
      * [AWS](admin/environments/add/kaas/eks.md)
      * [Azure](admin/environments/add/kaas/aks.md)
    * [Create a Kubernetes cluster](admin/environments/add/kube-create/README.md)
      * [MicroK8s](admin/environments/add/kube-create/microk8s.md)
    * [Add an environment via the Portainer API](admin/environments/add/api.md)
  * [Manage access to environments](admin/environments/access.md)
  * [Manage access to environment groups](admin/environments/access-groups.md)
  * [Auto onboarding](admin/environments/aeec.md)
  * [Update & Rollback](admin/environments/update.md)
* [Registries](admin/registries/README.md)
  * [Add a new registry](admin/registries/add/README.md)
    * [Add a DockerHub account](admin/registries/add/dockerhub.md)
    * [Add an AWS ECR registry](admin/registries/add/ecr.md)
    * [Add a Quay.io registry](admin/registries/add/quay.md)
    * [Add a ProGet registry](admin/registries/add/proget.md)
    * [Add an Azure registry](admin/registries/add/azure.md)
    * [Add a Gitlab registry](admin/registries/add/gitlab.md)
    * [Add a GitHub registry](admin/registries/add/ghcr.md)
    * [Add a custom registry](admin/registries/add/custom.md)
  * [Browse a registry](admin/registries/browse.md)
  * [Manage a registry](admin/registries/manage.md)
* [Licenses](admin/licenses.md)
* [Authentication logs](admin/logs/README.md)
  * [Activity logs](admin/logs/activity.md)
* [Notifications](admin/notifications.md)
* [Settings](admin/settings/README.md)
  * [Authentication](admin/settings/authentication/README.md)
    * [Authenticate via LDAP](admin/settings/authentication/ldap.md)
    * [Authenticate via Active Directory](admin/settings/authentication/active-directory.md)
    * [Authenticate via OAuth](admin/settings/authentication/oauth.md)
  * [Shared credentials](admin/settings/credentials/README.md)
    * [Add Civo credentials](admin/settings/credentials/civo.md)
    * [Add Linode credentials](admin/settings/credentials/linode.md)
    * [Add DigitalOcean credentials](admin/settings/credentials/digitalocean.md)
    * [Add Google Cloud credentials](admin/settings/credentials/gke.md)
    * [Add AWS credentials](admin/settings/credentials/eks.md)
    * [Add Azure credentials](admin/settings/credentials/aks.md)
    * [Add SSH credentials](admin/settings/credentials/ssh.md)
  * [Edge Compute](admin/settings/edge.md)

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

* [Portainer Concepts](faq/concepts.md)
* [Installing](faq/installing.md)
* [Upgrading](faq/upgrading.md)
* [Troubleshooting](faq/troubleshooting.md)
* [Contributing](faq/contributing.md)

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

* [CLI configuration options](advanced/cli.md)
* [App templates](advanced/app-templates/README.md)
  * [Build and host your own app templates](advanced/app-templates/build.md)
  * [App template JSON format](advanced/app-templates/format.md)
* [The Portainer Edge Agent](advanced/edge-agent.md)
* [Access control](advanced/access-control.md)
* [Reset the admin user's password](advanced/reset-admin.md)
* [Security and compliance](advanced/security.md)
* [Encrypting the Portainer database](advanced/db-encryption.md)
* [Using your own SSL certificate with Portainer](advanced/ssl.md)
* [Using mTLS with Portainer](advanced/mtls.md)
* [Using Portainer with reverse proxies](advanced/reverse-proxy/README.md)
  * [Deploying Portainer behind Traefik Proxy](advanced/reverse-proxy/traefik.md)
  * [Deploying Portainer behind nginx reverse proxy](advanced/reverse-proxy/nginx.md)
* [Helm chart configuration options](advanced/helm-chart-configuration-options.md)
* [Docker roles and permissions](advanced/docker-roles-and-permissions.md)
* [Kubernetes roles and bindings](advanced/kubernetes-roles-and-bindings.md)
* [Deprecated and removed features](advanced/deprecated.md)

## API

* [Accessing the Portainer API](api/access.md)
* [API documentation](api/docs.md)
* [API usage examples](api/examples.md)

## Get More Help

* [Knowledge Base](https://portal.portainer.io/knowledge)
* [YouTube](https://www.youtube.com/channel/UC7diMJcrULjDseq5yhSUZgg/videos)
* [Slack](https://join.slack.com/t/portainer/shared\_invite/zt-txh3ljab-52QHTyjCqbe5RibC2lcjKA)
* [Discord](https://discord.com/invite/j8fVken)
* [Open a support request](https://www.portainer.io/portainer-business-support)

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

* [Contribute](contribute/contribute.md)
* [Build instructions](contribute/build/README.md)
  * [Set up a macOS build environment](contribute/build/mac.md)
  * [Set up a Linux build environment](contribute/build/linux.md)