# Table of contents

* [Welcome](README.md)
* [Release Notes](release-notes.md)

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

* [Introduction](start/intro.md)
* [Portainer architecture](start/architecture.md)
* [Requirements and prerequisites](start/requirements-and-prerequisites.md)
* [Install Portainer CE](start/install/README.md)
  * [Set up a new Portainer Server installation](start/install/server/README.md)
    * [Docker Standalone](start/install/server/docker/README.md)
      * [Install Portainer with Docker on Linux](start/install/server/docker/linux.md)
      * [Install Portainer with Docker on WSL / Docker Desktop](start/install/server/docker/wsl.md)
      * [Install Portainer with Docker on Windows Container Service](start/install/server/docker/wcs.md)
    * [Docker Swarm](start/install/server/swarm/README.md)
      * [Install Portainer with Docker Swarm on Linux](start/install/server/swarm/linux.md)
      * [Install Portainer with Docker Swarm on WSL / Docker Desktop](start/install/server/swarm/wsl.md)
      * [Install Portainer with Docker Swarm on Windows Container Service](start/install/server/swarm/wcs.md)
    * [Kubernetes](start/install/server/kubernetes/README.md)
      * [Install Portainer with Kubernetes on your Self-Managed Infrastructure](start/install/server/kubernetes/baremetal.md)
      * [Install Portainer with Kubernetes on WSL / Docker Desktop](start/install/server/kubernetes/wsl.md)
    * [Initial Setup](start/install/server/setup.md)
  * [Add an environment to an existing installation](start/install/agent/README.md)
    * [Docker Standalone](start/install/agent/docker/README.md)
      * [Install Portainer Agent with Docker on Linux](start/install/agent/docker/linux.md)
      * [Install Portainer Agent with Docker on WSL / Docker Desktop](start/install/agent/docker/wsl.md)
      * [Install Portainer Agent with Docker on Windows Container Service](start/install/agent/docker/wcs.md)
    * [Docker Swarm](start/install/agent/swarm/README.md)
      * [Install Portainer Agent with Docker Swarm on Linux](start/install/agent/swarm/linux.md)
      * [Install Portainer Agent with Docker Swarm on WSL / Docker Desktop](start/install/agent/swarm/wsl.md)
      * [Install Portainer Agent with Docker Swarm on Windows Container Service](start/install/agent/swarm/wcs.md)
    * [Kubernetes](start/install/agent/kubernetes/README.md)
      * [Install Portainer Agent with Kubernetes on your Self-Managed Infrastructure](start/install/agent/kubernetes/baremetal.md)
      * [Install Portainer Agent with Kubernetes on WSL / Docker Desktop](start/install/agent/kubernetes/wsl.md)
    * [Azure ACI](start/install/agent/aci.md)
    * [Edge Agent](start/install/agent/edge.md)

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

* [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)
    * [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)
    * [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)
  * [Swarm](user/docker/swarm/README.md)
    * [Setup](user/docker/swarm/setup.md)
    * [Cluster visualizer](user/docker/swarm/cluster-visualizer.md)
* [Kubernetes](user/kubernetes/README.md)
  * [Dashboard](user/kubernetes/dashboard.md)
  * [Namespaces](user/kubernetes/namespaces/README.md)
    * [Add a new namespace](user/kubernetes/namespaces/add.md)
    * [Manage access to a namespace](user/kubernetes/namespaces/access.md)
    * [Remove a namespace](user/kubernetes/namespaces/remove.md)
  * [Applications](user/kubernetes/applications/README.md)
    * [Add a new application](user/kubernetes/applications/add.md)
    * [Inspect an application](user/kubernetes/applications/inspect.md)
    * [Detach a volume from an application](user/kubernetes/applications/detach-volume.md)
    * [Advanced application deployment](user/kubernetes/applications/advanced.md)
    * [Remove an application](user/kubernetes/applications/remove.md)
  * [Configurations](user/kubernetes/configurations/README.md)
    * [Add a new configuration](user/kubernetes/configurations/add.md)
    * [Remove a configuration](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)
* [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)
* [Edge Compute](user/edge/README.md)
  * [Edge Groups](user/edge/groups.md)
  * [Edge Stacks](user/edge/stacks.md)
  * [Edge Jobs](user/edge/jobs.md)

## Administering Portainer <a 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)
* [Endpoints](admin/endpoints/README.md)
  * [Groups](admin/endpoints/groups.md)
  * [Tags](admin/endpoints/tags.md)
  * [Add a new endpoint](admin/endpoints/add/README.md)
    * [Add a local endpoint](admin/endpoints/add/local.md)
    * [Add a Docker Standalone endpoint](admin/endpoints/add/docker.md)
    * [Add a Docker Swarm endpoint](admin/endpoints/add/swarm.md)
    * [Add a Kubernetes endpoint](admin/endpoints/add/kubernetes.md)
    * [Add an Edge endpoint](admin/endpoints/add/edge.md)
    * [Add an ACI endpoint](admin/endpoints/add/aci.md)
    * [Add an endpoint via the Portainer API](admin/endpoints/add/api.md)
  * [Manage access to endpoints](admin/endpoints/access.md)
  * [Manage access to endpoint groups](admin/endpoints/access-groups.md)
* [Registries](admin/registries/README.md)
  * [Add a new registry](admin/registries/add/README.md)
    * [Add a Quay.io registry](admin/registries/add/quay.md)
    * [Add an Azure registry](admin/registries/add/azure.md)
    * [Add a Gitlab registry](admin/registries/add/gitlab.md)
    * [Add a custom registry](admin/registries/add/custom.md)
  * [Enable Docker Hub authentication](admin/registries/dockerhub.md)
* [Settings](admin/settings/README.md)
  * [Authentication](admin/settings/authentication/README.md)
    * [Authenticate via LDAP](admin/settings/authentication/ldap.md)
    * [Authenticate via OAuth](admin/settings/authentication/oauth.md)
* [Upgrading Portainer](admin/upgrade/README.md)
  * [Upgrading on Docker](admin/upgrade/docker.md)
  * [Upgrading on Docker Swarm](admin/upgrade/swarm.md)
  * [Upgrading on Kubernetes](admin/upgrade/kubernetes.md)
  * [Switching from CE to Portainer Business](admin/upgrade/tobe/README.md)
    * [Docker Standalone](admin/upgrade/tobe/docker.md)
    * [Docker Swarm](admin/upgrade/tobe/swarm.md)
    * [Kubernetes](admin/upgrade/tobe/kubernetes.md)

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

* [Portainer Concepts](faq/concepts/README.md)
  * [What is Portainer's architecture?](faq/concepts/what-is-portainers-architecture.md)
  * [What information does Portainer collect?](faq/concepts/what-information-does-portainer-collect.md)
  * [What is Portainer CE's licensing model?](faq/concepts/what-is-portainer-ces-licensing-model.md)
* [Installing](faq/installing/README.md)
  * [How do I install Portainer CE?](faq/installing/how-do-i-install-portainer-ce.md)
  * [Can I run Portainer on my configuration?](faq/installing/can-i-run-portainer-on-my-configuration.md)
  * [How do I change the port that Portainer uses?](faq/installing/how-do-i-change-the-port-that-portainer-uses.md)
  * [My host is using SELinux. Can I use Portainer?](faq/installing/my-host-is-using-selinux-can-i-use-portainer.md)
  * [Does Portainer support WSL1?](faq/installing/does-portainer-support-wsl1.md)
  * [How do I enter my Portainer Business license into Portainer CE?](faq/installing/how-do-i-enter-my-portainer-business-license-into-portainer-ce.md)
* [Upgrading](faq/upgrading/README.md)
  * [How do I upgrade Portainer CE to the latest version?](faq/upgrading/how-do-i-upgrade-portainer-ce-to-the-latest-version.md)
  * [Can I upgrade Portainer CE to Portainer Business?](faq/upgrading/can-i-upgrade-portainer-ce-to-portainer-business.md)
  * [After an update, why doesn’t my version number match the latest version?](faq/upgrading/after-an-update-why-doesnt-my-version-number-match-the-latest-version.md)
  * [Why does Portainer keep prompting me to upgrade?](faq/upgrading/why-does-portainer-keep-prompting-me-to-upgrade.md)
  * [Can I upgrade an endpoint from Docker Standalone to Docker Swarm?](faq/upgrading/can-i-upgrade-an-endpoint-from-docker-standalone-to-docker-swarm.md)
  * [Can I downgrade from Portainer Business to Portainer CE?](faq/upgrading/can-i-roll-back-from-portainer-business-to-portainer-ce.md)
* [Troubleshooting](faq/troubleshooting/README.md)
  * [My Portainer Extensions license has expired. What can I do?](faq/troubleshooting/my-portainer-extensions-license-has-expired-what-do-i-do.md)
  * [Why can't my users see anything in the endpoint they have access to?](faq/troubleshooting/why-cant-my-users-see-anything-in-the-endpoint-they-have-access-to.md)
  * [Why don't custom standalone app templates show when using Docker Swarm?](faq/troubleshooting/why-dont-custom-standalone-app-templates-show-when-using-docker-swarm.md)
  * [Why can't I find images in my private registry on Kubernetes?](faq/troubleshooting/why-cant-i-find-images-in-my-private-registry-on-kubernetes.md)
  * [Can you view deleted container logs in Portainer?](faq/troubleshooting/can-you-view-deleted-container-logs-in-portainer.md)
  * [Exposed ports in the container view redirect me to 0.0.0.0. What can I do?](faq/troubleshooting/exposed-ports-in-the-container-view-redirect-me-to-0.0.0.0-what-can-i-do.md)
  * [How can I get the logs for Portainer itself?](faq/troubleshooting/how-can-i-get-the-logs-for-portainer-itself.md)
  * [How do I reset my Portainer password?](faq/troubleshooting/how-do-i-reset-my-portainer-password.md)
* [Contributing](faq/contributing/README.md)
  * [How do I report a bug?](faq/contributing/how-do-i-report-a-bug.md)
  * [How do I raise a feature request?](faq/contributing/how-do-i-raise-a-feature-request.md)
  * [How do you decide which bugs and features to work on first?](faq/contributing/how-do-you-decide-which-bugs-and-features-to-work-on-first.md)
  * [How do I log a support ticket?](faq/contributing/how-do-i-log-a-support-ticket.md)

## Advanced Topics <a 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)
* [Using SSL with Portainer](advanced/ssl.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)
* [Deprecated and removed features](advanced/deprecated.md)

## API

* [API documentation](api/docs.md)
* [API usage examples](api/examples.md)

## Get More Help

* [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)

## Contribute to Portainer <a 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)