mirror of
https://github.com/portainer/portainer-docs.git
synced 2026-03-27 04:48:31 +07:00
GITBOOK-4: Fix section slugs
This commit is contained in:
James Carppe
committed by
gitbook-bot
gitbook-bot
parent
d87cec39fa
commit
789b740bc0
@@ -6,7 +6,7 @@ Welcome to Portainer's official documentation site.
|
||||
|
||||
**Portainer Community Edition (CE)** is our foundation. With over half a million regular users, CE is a powerful, open source toolset that allows you to easily build and manage containers in Docker, Docker Swarm, Kubernetes and Azure ACI.
|
||||
|
||||
**Portainer Business Edition (BE)** is our commercial offering. With features geared towards businesses and larger organizations such as [Role-Based Access Control](administering-portainer/user/roles.md), [registry management](administering-portainer/registries/browse.md), and [dedicated support](./#getting-support), Portainer BE is a powerful toolset that allows you to easily build and manage containers in Docker, Docker Swarm, Kubernetes and Azure ACI.
|
||||
**Portainer Business Edition (BE)** is our commercial offering. With features geared towards businesses and larger organizations such as [Role-Based Access Control](admin/user/roles.md), [registry management](admin/registries/browse.md), and [dedicated support](./#getting-support), Portainer BE is a powerful toolset that allows you to easily build and manage containers in Docker, Docker Swarm, Kubernetes and Azure ACI.
|
||||
|
||||
{% hint style="info" %}
|
||||
Portainer Business Edition requires a license key to install and use. If you don't currently have a license key, you can [request three nodes free](https://www.portainer.io/get-a-license) of Portainer Business Edition or [purchase a license](https://www.portainer.io/pricing).
|
||||
@@ -36,7 +36,7 @@ Community Edition, five/three nodes free and Home & Student users can get suppor
|
||||
* **Ask questions** either in our [GitHub Discussions](https://github.com/orgs/portainer/discussions/categories/help) forum or the [community Slack channel](https://join.slack.com/t/portainer/shared\_invite/zt-21zpww5ab-mG\_lA7UXbWL3HW3sPqjqEA). Other platforms exist (Reddit, Discord, Stack Overflow) but we are less active in those spaces.
|
||||
* **Log bugs** in [GitHub Issues](https://github.com/portainer/portainer/issues) so they can be properly managed.
|
||||
* **Flag vulnerabilities** by emailing [security@portainer.io](mailto:security@portainer.io) so we can deal with them immediately.
|
||||
* **Flag documentation issues** via our [GitHub documentation channel](https://github.com/portainer/portainer-docs/issues) (or start [contributing](contribute-to-portainer/contribute.md) and make our documentation better!).
|
||||
* **Flag documentation issues** via our [GitHub documentation channel](https://github.com/portainer/portainer-docs/issues) (or start [contributing](contribute/contribute.md) and make our documentation better!).
|
||||
|
||||
### Business Edition Customers
|
||||
|
||||
|
||||
576
SUMMARY.md
576
SUMMARY.md
@@ -4,298 +4,298 @@
|
||||
* [What's new in version 2.21](whats-new.md)
|
||||
* [Release Notes](release-notes.md)
|
||||
|
||||
## Getting Started
|
||||
## Getting Started <a href="#start" id="start"></a>
|
||||
|
||||
* [Introduction](getting-started/intro.md)
|
||||
* [Portainer architecture](getting-started/architecture.md)
|
||||
* [Requirements and prerequisites](getting-started/requirements-and-prerequisites.md)
|
||||
* [Install Portainer BE](getting-started/install/README.md)
|
||||
* [Set up a new Portainer BE Server installation](getting-started/install/server/README.md)
|
||||
* [Docker Standalone](getting-started/install/server/docker/README.md)
|
||||
* [Install Portainer BE with Docker on Linux](getting-started/install/server/docker/linux.md)
|
||||
* [Install Portainer BE with Docker on WSL / Docker Desktop](getting-started/install/server/docker/wsl.md)
|
||||
* [Install Portainer BE with Docker on Windows Container Service](getting-started/install/server/docker/wcs.md)
|
||||
* [Docker Swarm](getting-started/install/server/swarm/README.md)
|
||||
* [Install Portainer BE with Docker Swarm on Linux](getting-started/install/server/swarm/linux.md)
|
||||
* [Install Portainer BE with Docker Swarm on WSL / Docker Desktop](getting-started/install/server/swarm/wsl.md)
|
||||
* [Install Portainer BE with Docker Swarm on Windows Container Service](getting-started/install/server/swarm/wcs.md)
|
||||
* [Kubernetes](getting-started/install/server/kubernetes/README.md)
|
||||
* [Install Portainer BE on your Kubernetes environment](getting-started/install/server/kubernetes/baremetal.md)
|
||||
* [Install Portainer BE with Kubernetes on WSL / Docker Desktop](getting-started/install/server/kubernetes/wsl.md)
|
||||
* [Initial setup](getting-started/install/server/setup.md)
|
||||
* [Install Portainer CE](getting-started/install-ce/README.md)
|
||||
* [Set up a new Portainer CE Server installation](getting-started/install-ce/server/README.md)
|
||||
* [Docker Standalone](getting-started/install-ce/server/docker/README.md)
|
||||
* [Install Portainer CE with Docker on Linux](getting-started/install-ce/server/docker/linux.md)
|
||||
* [Install Portainer CE with Docker on WSL / Docker Desktop](getting-started/install-ce/server/docker/wsl.md)
|
||||
* [Install Portainer CE with Docker on Windows Container Service](getting-started/install-ce/server/docker/wcs.md)
|
||||
* [Docker Swarm](getting-started/install-ce/server/swarm/README.md)
|
||||
* [Install Portainer CE with Docker Swarm on Linux](getting-started/install-ce/server/swarm/linux.md)
|
||||
* [Install Portainer CE with Docker Swarm on WSL / Docker Desktop](getting-started/install-ce/server/swarm/wsl.md)
|
||||
* [Install Portainer CE with Docker Swarm on Windows Container Service](getting-started/install-ce/server/swarm/wcs.md)
|
||||
* [Kubernetes](getting-started/install-ce/server/kubernetes/README.md)
|
||||
* [Install Portainer CE on your Kubernetes environment](getting-started/install-ce/server/kubernetes/baremetal.md)
|
||||
* [Install Portainer CE with Kubernetes on WSL / Docker Desktop](getting-started/install-ce/server/kubernetes/wsl.md)
|
||||
* [Initial setup](getting-started/install-ce/server/setup.md)
|
||||
* [Add an environment to an existing installation](getting-started/agent.md)
|
||||
* [Updating Portainer](getting-started/upgrade/README.md)
|
||||
* [Updating on Docker Standalone](getting-started/upgrade/docker.md)
|
||||
* [Updating on Docker Swarm](getting-started/upgrade/swarm.md)
|
||||
* [Updating on Kubernetes](getting-started/upgrade/kubernetes.md)
|
||||
* [Updating on Nomad](getting-started/upgrade/nomad.md)
|
||||
* [Updating the Edge Agent](getting-started/upgrade/edge.md)
|
||||
* [Switching to Portainer Business Edition](getting-started/upgrade/tobe/README.md)
|
||||
* [Upgrade to Business Edition from within Portainer Community Edition](getting-started/upgrade/tobe/inapp.md)
|
||||
* [Docker Standalone](getting-started/upgrade/tobe/docker.md)
|
||||
* [Docker Swarm](getting-started/upgrade/tobe/swarm.md)
|
||||
* [Kubernetes](getting-started/upgrade/tobe/kubernetes.md)
|
||||
* [Upgrading Agent-only deployments](getting-started/upgrade/tobe/agent.md)
|
||||
* [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)
|
||||
* [Updating Portainer](start/upgrade/README.md)
|
||||
* [Updating on Docker Standalone](start/upgrade/docker.md)
|
||||
* [Updating on Docker Swarm](start/upgrade/swarm.md)
|
||||
* [Updating on Kubernetes](start/upgrade/kubernetes.md)
|
||||
* [Updating on Nomad](start/upgrade/nomad.md)
|
||||
* [Updating the Edge Agent](start/upgrade/edge.md)
|
||||
* [Switching to Portainer Business Edition](start/upgrade/tobe/README.md)
|
||||
* [Upgrade to Business Edition from within Portainer Community Edition](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
|
||||
## Using Portainer <a href="#user" id="user"></a>
|
||||
|
||||
* [Home](using-portainer/home/README.md)
|
||||
* [Snapshot browsing](using-portainer/home/snapshot.md)
|
||||
* [OpenAMT](using-portainer/home/openamt.md)
|
||||
* [Docker/Swarm](using-portainer/docker/README.md)
|
||||
* [Dashboard](using-portainer/docker/dashboard.md)
|
||||
* [Templates](using-portainer/docker/templates/README.md)
|
||||
* [Application](using-portainer/docker/templates/application.md)
|
||||
* [Custom templates](using-portainer/docker/templates/custom.md)
|
||||
* [Deploy a stack](using-portainer/docker/templates/deploy-stack.md)
|
||||
* [Deploy a container](using-portainer/docker/templates/deploy-container.md)
|
||||
* [Stacks](using-portainer/docker/stacks/README.md)
|
||||
* [Add a new stack](using-portainer/docker/stacks/add.md)
|
||||
* [Inspect or edit a stack](using-portainer/docker/stacks/edit.md)
|
||||
* [Create a template from a deployed stack](using-portainer/docker/stacks/template.md)
|
||||
* [Webhooks](using-portainer/docker/stacks/webhooks.md)
|
||||
* [Migrate or duplicate a stack](using-portainer/docker/stacks/migrate.md)
|
||||
* [Remove a stack](using-portainer/docker/stacks/remove.md)
|
||||
* [Services](using-portainer/docker/services/README.md)
|
||||
* [Add a new service](using-portainer/docker/services/add.md)
|
||||
* [Configure service options](using-portainer/docker/services/configure.md)
|
||||
* [Scale a service](using-portainer/docker/services/scale.md)
|
||||
* [View the status of a service task](using-portainer/docker/services/tasks.md)
|
||||
* [View service logs](using-portainer/docker/services/logs.md)
|
||||
* [Roll back a service](using-portainer/docker/services/rollback.md)
|
||||
* [Webhooks](using-portainer/docker/services/webhooks.md)
|
||||
* [Containers](using-portainer/docker/containers/README.md)
|
||||
* [Add a new container](using-portainer/docker/containers/add.md)
|
||||
* [View a container's details](using-portainer/docker/containers/view.md)
|
||||
* [Inspect a container](using-portainer/docker/containers/inspect.md)
|
||||
* [Edit or duplicate a container](using-portainer/docker/containers/edit.md)
|
||||
* [Advanced container settings](using-portainer/docker/containers/advanced.md)
|
||||
* [Webhooks](using-portainer/docker/containers/webhooks.md)
|
||||
* [Attach a volume to a container](using-portainer/docker/containers/attach-volume.md)
|
||||
* [View container logs](using-portainer/docker/containers/logs.md)
|
||||
* [View container statistics](using-portainer/docker/containers/stats.md)
|
||||
* [Access a container's console](using-portainer/docker/containers/console.md)
|
||||
* [Change container ownership](using-portainer/docker/containers/ownership.md)
|
||||
* [Remove a container](using-portainer/docker/containers/remove.md)
|
||||
* [Images](using-portainer/docker/images/README.md)
|
||||
* [Pull an image](using-portainer/docker/images/pull.md)
|
||||
* [Build a new image](using-portainer/docker/images/build.md)
|
||||
* [Import an image](using-portainer/docker/images/import.md)
|
||||
* [Export an image](using-portainer/docker/images/export.md)
|
||||
* [Networks](using-portainer/docker/networks/README.md)
|
||||
* [Add a new network](using-portainer/docker/networks/add.md)
|
||||
* [Remove a network](using-portainer/docker/networks/remove.md)
|
||||
* [Volumes](using-portainer/docker/volumes/README.md)
|
||||
* [Add a new volume](using-portainer/docker/volumes/add.md)
|
||||
* [Browse a volume](using-portainer/docker/volumes/browse.md)
|
||||
* [Remove a volume](using-portainer/docker/volumes/remove.md)
|
||||
* [Configs](using-portainer/docker/configs/README.md)
|
||||
* [Add a new config](using-portainer/docker/configs/add.md)
|
||||
* [Remove a config](using-portainer/docker/configs/remove.md)
|
||||
* [Secrets](using-portainer/docker/secrets/README.md)
|
||||
* [Add a new secret](using-portainer/docker/secrets/add.md)
|
||||
* [Remove a secret](using-portainer/docker/secrets/remove.md)
|
||||
* [Events](using-portainer/docker/events.md)
|
||||
* [Host](using-portainer/docker/host/README.md)
|
||||
* [Details](using-portainer/docker/host/details.md)
|
||||
* [Setup](using-portainer/docker/host/setup.md)
|
||||
* [Registries](using-portainer/docker/host/registries.md)
|
||||
* [Swarm](using-portainer/docker/swarm/README.md)
|
||||
* [Details](using-portainer/docker/swarm/details.md)
|
||||
* [Cluster visualizer](using-portainer/docker/swarm/cluster-visualizer.md)
|
||||
* [Setup](using-portainer/docker/swarm/setup.md)
|
||||
* [Registries](using-portainer/docker/swarm/registries.md)
|
||||
* [Kubernetes](using-portainer/kubernetes/README.md)
|
||||
* [Dashboard](using-portainer/kubernetes/dashboard.md)
|
||||
* [kubectl shell](using-portainer/kubernetes/kubectl.md)
|
||||
* [Kubeconfig](using-portainer/kubernetes/kubeconfig.md)
|
||||
* [Custom Templates](using-portainer/kubernetes/templates/README.md)
|
||||
* [Add a new custom template](using-portainer/kubernetes/templates/add.md)
|
||||
* [Edit a custom template](using-portainer/kubernetes/templates/edit.md)
|
||||
* [Remove a custom template](using-portainer/kubernetes/templates/remove.md)
|
||||
* [Namespaces](using-portainer/kubernetes/namespaces/README.md)
|
||||
* [Add a new namespace](using-portainer/kubernetes/namespaces/add.md)
|
||||
* [Manage a namespace](using-portainer/kubernetes/namespaces/manage.md)
|
||||
* [Manage access to a namespace](using-portainer/kubernetes/namespaces/access.md)
|
||||
* [Remove a namespace](using-portainer/kubernetes/namespaces/remove.md)
|
||||
* [Helm](using-portainer/kubernetes/helm.md)
|
||||
* [Applications](using-portainer/kubernetes/applications/README.md)
|
||||
* [Add a new application using a form](using-portainer/kubernetes/applications/add.md)
|
||||
* [Add a new application using a manifest](using-portainer/kubernetes/applications/manifest.md)
|
||||
* [Inspect an application](using-portainer/kubernetes/applications/inspect.md)
|
||||
* [Inspect a Helm application](using-portainer/kubernetes/applications/inspect-helm.md)
|
||||
* [Edit an application](using-portainer/kubernetes/applications/edit.md)
|
||||
* [Webhooks](using-portainer/kubernetes/applications/webhooks.md)
|
||||
* [Detach a volume from an application](using-portainer/kubernetes/applications/detach-volume.md)
|
||||
* [Remove an application](using-portainer/kubernetes/applications/remove.md)
|
||||
* [Networking](using-portainer/kubernetes/networking/README.md)
|
||||
* [Services](using-portainer/kubernetes/networking/services.md)
|
||||
* [Ingresses](using-portainer/kubernetes/networking/ingresses/README.md)
|
||||
* [Add an Ingress manually](using-portainer/kubernetes/networking/ingresses/add.md)
|
||||
* [Add an Ingress using a manifest](using-portainer/kubernetes/networking/ingresses/manifest.md)
|
||||
* [Remove an Ingress](using-portainer/kubernetes/networking/ingresses/remove-an-ingress.md)
|
||||
* [ConfigMaps & Secrets](using-portainer/kubernetes/configurations/README.md)
|
||||
* [Add a ConfigMap](using-portainer/kubernetes/configurations/add.md)
|
||||
* [Add a Secret](using-portainer/kubernetes/configurations/add-1.md)
|
||||
* [Volumes](using-portainer/kubernetes/volumes/README.md)
|
||||
* [Inspect a volume](using-portainer/kubernetes/volumes/inspect.md)
|
||||
* [Remove a volume](using-portainer/kubernetes/volumes/remove.md)
|
||||
* [More Resources](using-portainer/kubernetes/more-resources/README.md)
|
||||
* [Service Accounts](using-portainer/kubernetes/more-resources/service-accounts.md)
|
||||
* [Cluster Roles](using-portainer/kubernetes/more-resources/cluster-roles.md)
|
||||
* [Roles](using-portainer/kubernetes/more-resources/namespace-roles.md)
|
||||
* [Cluster](using-portainer/kubernetes/cluster/README.md)
|
||||
* [Details](using-portainer/kubernetes/cluster/details.md)
|
||||
* [Inspect a node](using-portainer/kubernetes/cluster/node.md)
|
||||
* [Setup](using-portainer/kubernetes/cluster/setup.md)
|
||||
* [Security constraints](using-portainer/kubernetes/cluster/security.md)
|
||||
* [Registries](using-portainer/kubernetes/cluster/registries.md)
|
||||
* [Azure ACI](using-portainer/aci/README.md)
|
||||
* [Dashboard](using-portainer/aci/dashboard.md)
|
||||
* [Container instances](using-portainer/aci/containers/README.md)
|
||||
* [Add a new container](using-portainer/aci/containers/add.md)
|
||||
* [Remove a container](using-portainer/aci/containers/remove.md)
|
||||
* [Nomad](using-portainer/nomad.md)
|
||||
* [Edge Compute](using-portainer/edge/README.md)
|
||||
* [Edge Groups](using-portainer/edge/groups.md)
|
||||
* [Edge Stacks](using-portainer/edge/stacks/README.md)
|
||||
* [Add a new Edge Stack](using-portainer/edge/stacks/add.md)
|
||||
* [Edge Jobs](using-portainer/edge/jobs.md)
|
||||
* [Edge Configurations](using-portainer/edge/configurations.md)
|
||||
* [Waiting Room](using-portainer/edge/waiting-room.md)
|
||||
* [Edge Templates](using-portainer/edge/templates/README.md)
|
||||
* [Application](using-portainer/edge/templates/application.md)
|
||||
* [Custom](using-portainer/edge/templates/custom.md)
|
||||
* [Account settings](using-portainer/account-settings.md)
|
||||
* [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)
|
||||
* [Templates](user/docker/templates/README.md)
|
||||
* [Application](user/docker/templates/application.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)
|
||||
* [Details](user/docker/host/details.md)
|
||||
* [Setup](user/docker/host/setup.md)
|
||||
* [Registries](user/docker/host/registries.md)
|
||||
* [Swarm](user/docker/swarm/README.md)
|
||||
* [Details](user/docker/swarm/details.md)
|
||||
* [Cluster visualizer](user/docker/swarm/cluster-visualizer.md)
|
||||
* [Setup](user/docker/swarm/setup.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.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)
|
||||
* [Inspect a Helm application](user/kubernetes/applications/inspect-helm.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)
|
||||
* [Networking](user/kubernetes/networking/README.md)
|
||||
* [Services](user/kubernetes/networking/services.md)
|
||||
* [Ingresses](user/kubernetes/networking/ingresses/README.md)
|
||||
* [Add an Ingress manually](user/kubernetes/networking/ingresses/add.md)
|
||||
* [Add an Ingress using a manifest](user/kubernetes/networking/ingresses/manifest.md)
|
||||
* [Remove an Ingress](user/kubernetes/networking/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)
|
||||
* [Volumes](user/kubernetes/volumes/README.md)
|
||||
* [Inspect a volume](user/kubernetes/volumes/inspect.md)
|
||||
* [Remove a volume](user/kubernetes/volumes/remove.md)
|
||||
* [More Resources](user/kubernetes/more-resources/README.md)
|
||||
* [Service Accounts](user/kubernetes/more-resources/service-accounts.md)
|
||||
* [Cluster Roles](user/kubernetes/more-resources/cluster-roles.md)
|
||||
* [Roles](user/kubernetes/more-resources/namespace-roles.md)
|
||||
* [Cluster](user/kubernetes/cluster/README.md)
|
||||
* [Details](user/kubernetes/cluster/details.md)
|
||||
* [Inspect a node](user/kubernetes/cluster/node.md)
|
||||
* [Setup](user/kubernetes/cluster/setup.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.md)
|
||||
* [Edge Compute](user/edge/README.md)
|
||||
* [Edge Groups](user/edge/groups.md)
|
||||
* [Edge Stacks](user/edge/stacks/README.md)
|
||||
* [Add a new Edge Stack](user/edge/stacks/add.md)
|
||||
* [Edge Jobs](user/edge/jobs.md)
|
||||
* [Edge Configurations](user/edge/configurations.md)
|
||||
* [Waiting Room](user/edge/waiting-room.md)
|
||||
* [Edge Templates](user/edge/templates/README.md)
|
||||
* [Application](user/edge/templates/application.md)
|
||||
* [Custom](user/edge/templates/custom.md)
|
||||
* [Account settings](user/account-settings.md)
|
||||
|
||||
## Administering Portainer
|
||||
## Administering Portainer <a href="#admin" id="admin"></a>
|
||||
|
||||
* [User-related](administering-portainer/user/README.md)
|
||||
* [Users](administering-portainer/user/users.md)
|
||||
* [Add a new user](administering-portainer/user/add.md)
|
||||
* [Turn a user into an administrator](administering-portainer/user/promote.md)
|
||||
* [Reset a user's password](administering-portainer/user/password.md)
|
||||
* [Teams](administering-portainer/user/teams/README.md)
|
||||
* [Add a new team](administering-portainer/user/teams/add.md)
|
||||
* [Add a user to a team](administering-portainer/user/teams/add-user.md)
|
||||
* [Roles](administering-portainer/user/roles.md)
|
||||
* [Environment-related](administering-portainer/environments/README.md)
|
||||
* [Environments](administering-portainer/environments/environments.md)
|
||||
* [Add a new environment](administering-portainer/environments/add/README.md)
|
||||
* [Add a local environment](administering-portainer/environments/add/local.md)
|
||||
* [Add a Docker Standalone environment](administering-portainer/environments/add/docker/README.md)
|
||||
* [Install Portainer Agent on Docker Standalone](administering-portainer/environments/add/docker/agent.md)
|
||||
* [Connect to the Docker API](administering-portainer/environments/add/docker/api.md)
|
||||
* [Connect to the Docker Socket](administering-portainer/environments/add/docker/socket.md)
|
||||
* [Install Edge Agent Standard on Docker Standalone](administering-portainer/environments/add/docker/edge.md)
|
||||
* [Install Edge Agent Async on Docker Standalone](administering-portainer/environments/add/docker/edge-async.md)
|
||||
* [Add a Docker Swarm environment](administering-portainer/environments/add/swarm/README.md)
|
||||
* [Install Portainer Agent on Docker Swarm](administering-portainer/environments/add/swarm/agent.md)
|
||||
* [Connect to the Docker API](administering-portainer/environments/add/swarm/api.md)
|
||||
* [Connect to the Docker Socket](administering-portainer/environments/add/swarm/socket.md)
|
||||
* [Install Edge Agent Standard on Docker Swarm](administering-portainer/environments/add/swarm/edge.md)
|
||||
* [Install Edge Agent Async on Docker Swarm](administering-portainer/environments/add/swarm/edge-async.md)
|
||||
* [Add a Kubernetes environment](administering-portainer/environments/add/kubernetes/README.md)
|
||||
* [Install Portainer Agent on your Kubernetes environment](administering-portainer/environments/add/kubernetes/agent.md)
|
||||
* [Install Edge Agent Standard on Kubernetes](administering-portainer/environments/add/kubernetes/edge.md)
|
||||
* [Install Edge Agent Async on Kubernetes](administering-portainer/environments/add/kubernetes/edge-async.md)
|
||||
* [Import an existing Kubernetes environment](administering-portainer/environments/add/kubernetes/import.md)
|
||||
* [Add an ACI environment](administering-portainer/environments/add/aci.md)
|
||||
* [Add a Nomad environment](administering-portainer/environments/add/nomad.md)
|
||||
* [Provision KaaS Cluster](administering-portainer/environments/add/kaas/README.md)
|
||||
* [Civo](administering-portainer/environments/add/kaas/civo.md)
|
||||
* [Linode](administering-portainer/environments/add/kaas/linode.md)
|
||||
* [DigitalOcean](administering-portainer/environments/add/kaas/digitalocean.md)
|
||||
* [Google Cloud](administering-portainer/environments/add/kaas/gke.md)
|
||||
* [AWS](administering-portainer/environments/add/kaas/eks.md)
|
||||
* [Azure](administering-portainer/environments/add/kaas/aks.md)
|
||||
* [Create a Kubernetes cluster](administering-portainer/environments/add/kube-create/README.md)
|
||||
* [MicroK8s](administering-portainer/environments/add/kube-create/microk8s/README.md)
|
||||
* [Offline installation](administering-portainer/environments/add/kube-create/microk8s/offline.md)
|
||||
* [Add an environment via the Portainer API](administering-portainer/environments/add/api.md)
|
||||
* [Auto onboarding](administering-portainer/environments/aeec.md)
|
||||
* [Groups](administering-portainer/environments/groups.md)
|
||||
* [Tags](administering-portainer/environments/tags.md)
|
||||
* [Manage access to environments](administering-portainer/environments/access.md)
|
||||
* [Manage access to environment groups](administering-portainer/environments/access-groups.md)
|
||||
* [Update & Rollback](administering-portainer/environments/update.md)
|
||||
* [Registries](administering-portainer/registries/README.md)
|
||||
* [Add a new registry](administering-portainer/registries/add/README.md)
|
||||
* [Add a DockerHub account](administering-portainer/registries/add/dockerhub.md)
|
||||
* [Add an AWS ECR registry](administering-portainer/registries/add/ecr.md)
|
||||
* [Add a Quay.io registry](administering-portainer/registries/add/quay.md)
|
||||
* [Add a ProGet registry](administering-portainer/registries/add/proget.md)
|
||||
* [Add an Azure registry](administering-portainer/registries/add/azure.md)
|
||||
* [Add a Gitlab registry](administering-portainer/registries/add/gitlab.md)
|
||||
* [Add a GitHub registry](administering-portainer/registries/add/ghcr.md)
|
||||
* [Add a custom registry](administering-portainer/registries/add/custom.md)
|
||||
* [Browse a registry](administering-portainer/registries/browse.md)
|
||||
* [Manage a registry](administering-portainer/registries/manage.md)
|
||||
* [Licenses](administering-portainer/licenses.md)
|
||||
* [Logs](administering-portainer/logs/README.md)
|
||||
* [Authentication](administering-portainer/logs/authentication.md)
|
||||
* [Activity](administering-portainer/logs/activity.md)
|
||||
* [Notifications](administering-portainer/notifications.md)
|
||||
* [Settings](administering-portainer/settings/README.md)
|
||||
* [General](administering-portainer/settings/general.md)
|
||||
* [Authentication](administering-portainer/settings/authentication/README.md)
|
||||
* [Authenticate via LDAP](administering-portainer/settings/authentication/ldap.md)
|
||||
* [Authenticate via Active Directory](administering-portainer/settings/authentication/active-directory.md)
|
||||
* [Authenticate via OAuth](administering-portainer/settings/authentication/oauth.md)
|
||||
* [Shared credentials](administering-portainer/settings/credentials/README.md)
|
||||
* [Add Civo credentials](administering-portainer/settings/credentials/civo.md)
|
||||
* [Add Linode credentials](administering-portainer/settings/credentials/linode.md)
|
||||
* [Add DigitalOcean credentials](administering-portainer/settings/credentials/digitalocean.md)
|
||||
* [Add Google Cloud credentials](administering-portainer/settings/credentials/gke.md)
|
||||
* [Add AWS credentials](administering-portainer/settings/credentials/eks.md)
|
||||
* [Add Azure credentials](administering-portainer/settings/credentials/aks.md)
|
||||
* [Add SSH credentials](administering-portainer/settings/credentials/ssh.md)
|
||||
* [Edge Compute](administering-portainer/settings/edge.md)
|
||||
* [User-related](admin/user/README.md)
|
||||
* [Users](admin/user/users.md)
|
||||
* [Add a new user](admin/user/add.md)
|
||||
* [Turn a user into an administrator](admin/user/promote.md)
|
||||
* [Reset a user's password](admin/user/password.md)
|
||||
* [Teams](admin/user/teams/README.md)
|
||||
* [Add a new team](admin/user/teams/add.md)
|
||||
* [Add a user to a team](admin/user/teams/add-user.md)
|
||||
* [Roles](admin/user/roles.md)
|
||||
* [Environment-related](admin/environments/README.md)
|
||||
* [Environments](admin/environments/environments.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/README.md)
|
||||
* [Offline installation](admin/environments/add/kube-create/microk8s/offline.md)
|
||||
* [Add an environment via the Portainer API](admin/environments/add/api.md)
|
||||
* [Auto onboarding](admin/environments/aeec.md)
|
||||
* [Groups](admin/environments/groups.md)
|
||||
* [Tags](admin/environments/tags.md)
|
||||
* [Manage access to environments](admin/environments/access.md)
|
||||
* [Manage access to environment groups](admin/environments/access-groups.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)
|
||||
* [Logs](admin/logs/README.md)
|
||||
* [Authentication](admin/logs/authentication.md)
|
||||
* [Activity](admin/logs/activity.md)
|
||||
* [Notifications](admin/notifications.md)
|
||||
* [Settings](admin/settings/README.md)
|
||||
* [General](admin/settings/general.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
|
||||
## Frequently Asked Questions <a href="#faq" id="faq"></a>
|
||||
|
||||
* [Portainer Concepts](frequently-asked-questions/concepts.md)
|
||||
* [Installing](frequently-asked-questions/installing.md)
|
||||
* [Upgrading](frequently-asked-questions/upgrading.md)
|
||||
* [Troubleshooting](frequently-asked-questions/troubleshooting.md)
|
||||
* [Contributing](frequently-asked-questions/contributing.md)
|
||||
* [Portainer Concepts](faq/concepts.md)
|
||||
* [Installing](faq/installing.md)
|
||||
* [Upgrading](faq/upgrading.md)
|
||||
* [Troubleshooting](faq/troubleshooting.md)
|
||||
* [Contributing](faq/contributing.md)
|
||||
|
||||
## Advanced Topics
|
||||
## Advanced Topics <a href="#advanced" id="advanced"></a>
|
||||
|
||||
* [CLI configuration options](advanced-topics/cli.md)
|
||||
* [App templates](advanced-topics/app-templates/README.md)
|
||||
* [Build and host your own app templates](advanced-topics/app-templates/build.md)
|
||||
* [App template JSON format](advanced-topics/app-templates/format.md)
|
||||
* [The Portainer Edge Agent](advanced-topics/edge-agent.md)
|
||||
* [Access control](advanced-topics/access-control.md)
|
||||
* [Reset the admin user's password](advanced-topics/reset-admin.md)
|
||||
* [Security and compliance](advanced-topics/security.md)
|
||||
* [Encrypting the Portainer database](advanced-topics/db-encryption.md)
|
||||
* [Using your own SSL certificate with Portainer](advanced-topics/ssl.md)
|
||||
* [Using mTLS with Portainer](advanced-topics/mtls.md)
|
||||
* [Stream auth and activity logs to an external provider](advanced-topics/siem.md)
|
||||
* [Using Portainer with reverse proxies](advanced-topics/reverse-proxy/README.md)
|
||||
* [Deploying Portainer behind Traefik Proxy](advanced-topics/reverse-proxy/traefik.md)
|
||||
* [Deploying Portainer behind nginx reverse proxy](advanced-topics/reverse-proxy/nginx.md)
|
||||
* [How Relative Path Support works in Portainer](advanced-topics/relative-paths.md)
|
||||
* [Helm chart configuration options](advanced-topics/helm-chart-configuration-options.md)
|
||||
* [Docker roles and permissions](advanced-topics/docker-roles-and-permissions.md)
|
||||
* [Kubernetes roles and bindings](advanced-topics/kubernetes-roles-and-bindings.md)
|
||||
* [Deprecated and removed features](advanced-topics/deprecated.md)
|
||||
* [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)
|
||||
* [Stream auth and activity logs to an external provider](advanced/siem.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)
|
||||
* [How Relative Path Support works in Portainer](advanced/relative-paths.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
|
||||
|
||||
@@ -313,9 +313,9 @@
|
||||
* [Discord](https://discord.com/invite/j8fVken)
|
||||
* [Open a support request](https://www.portainer.io/portainer-business-support)
|
||||
|
||||
## Contribute to Portainer
|
||||
## Contribute to Portainer <a href="#contribute" id="contribute"></a>
|
||||
|
||||
* [Contribute](contribute-to-portainer/contribute.md)
|
||||
* [Build instructions](contribute-to-portainer/build/README.md)
|
||||
* [Set up a macOS build environment](contribute-to-portainer/build/mac.md)
|
||||
* [Set up a Linux build environment](contribute-to-portainer/build/linux.md)
|
||||
* [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)
|
||||
|
||||
@@ -9,7 +9,7 @@ Regardless of the method you choose, there are some generic requirements you wil
|
||||
|
||||
The installation instructions also make the following assumptions about your environment:
|
||||
|
||||
* Your environment meets [our requirements](../../../../getting-started/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
* Your environment meets [our requirements](../../../../start/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
* Docker is running as root (for Linux) or an Administrator (for Windows). Portainer with rootless Docker has some limitations, and requires additional configuration.
|
||||
|
||||
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Agent</strong></td><td></td><td></td><td><a href="agent.md">agent.md</a></td><td><a href="../../../../.gitbook/assets/card-agent-large.png">card-agent-large.png</a></td></tr><tr><td><strong>API</strong></td><td></td><td></td><td><a href="api.md">api.md</a></td><td><a href="../../../../.gitbook/assets/card-api-large.png">card-api-large.png</a></td></tr><tr><td><strong>Socket</strong></td><td></td><td></td><td><a href="socket.md">socket.md</a></td><td><a href="../../../../.gitbook/assets/card-socket-large.png">card-socket-large.png</a></td></tr><tr><td><strong>Edge Agent Standard</strong></td><td></td><td></td><td><a href="edge.md">edge.md</a></td><td><a href="../../../../.gitbook/assets/card-edgestd-large.png">card-edgestd-large.png</a></td></tr><tr><td><strong>Edge Agent Async</strong></td><td></td><td></td><td><a href="edge-async.md">edge-async.md</a></td><td><a href="../../../../.gitbook/assets/card-edgeasync-large.png">card-edgeasync-large.png</a></td></tr></tbody></table>
|
||||
@@ -1,6 +1,6 @@
|
||||
# Install Portainer Agent on Docker Standalone
|
||||
|
||||
Portainer uses the _Portainer Agent_ container to communicate with the _Portainer Server_ instance and provide access to the node's resources. This document will outline how to install the Portainer Agent on your node and how to connect to it from your Portainer Server instance. If you do not have a working Portainer Server instance yet, please refer to the [Portainer Server installation guide](../../../../getting-started/install/server/docker/linux.md) first.
|
||||
Portainer uses the _Portainer Agent_ container to communicate with the _Portainer Server_ instance and provide access to the node's resources. This document will outline how to install the Portainer Agent on your node and how to connect to it from your Portainer Server instance. If you do not have a working Portainer Server instance yet, please refer to the [Portainer Server installation guide](../../../../start/install/server/docker/linux.md) first.
|
||||
|
||||
In addition to the generic requirements for Docker Standalone environments, you will need:
|
||||
|
||||
@@ -24,7 +24,7 @@ From the menu expand **Environment-related**, click **Environments**, then click
|
||||
Next, select **Docker Standalone** as the environment type then click **Start Wizard**. Select the **Agent** option, then your environment type. Copy the command for your environment type and run it on your Docker Standalone instance. For example, if you are deploying on a Linux machine or a Windows machine with WSL installed, use the **Linux & Windows WSL** command. If you are deploying on a Windows machine with WCS, use the **Windows WCS** command.
|
||||
|
||||
{% hint style="info" %}
|
||||
If you want to use the [host management features](../../../../using-portainer/docker/host/setup.md#enable-host-management-features) of the Portainer Agent, you should add the necessary volume mount to the command that Portainer provides:
|
||||
If you want to use the [host management features](../../../../user/docker/host/setup.md#enable-host-management-features) of the Portainer Agent, you should add the necessary volume mount to the command that Portainer provides:
|
||||
|
||||
```
|
||||
-v /:/host
|
||||
@@ -55,7 +55,7 @@ Once the Agent has been deployed, enter the environment details using the table
|
||||
As an optional step you can expand the **More settings** section to categorize the environment by adding it to a [group](../../groups.md) or [tagging](../../tags.md) it for better searchability.
|
||||
|
||||
{% hint style="info" %}
|
||||
GPU configuration has been moved to [Host Setup](../../../../using-portainer/docker/host/setup.md#other) and can be configured once the environment has been set up.
|
||||
GPU configuration has been moved to [Host Setup](../../../../user/docker/host/setup.md#other) and can be configured once the environment has been set up.
|
||||
{% endhint %}
|
||||
|
||||
<figure><img src="../../../../.gitbook/assets/2.18-environments-add-docker-moresettings.png" alt=""><figcaption></figcaption></figure>
|
||||
@@ -19,7 +19,7 @@ Portainer expects TLS certificates and keys to be in PEM format.
|
||||
As an optional step you can expand the **More settings** section to categorize the environment by adding it to a [group](../../groups.md) or [tagging](../../tags.md) it for better searchability.
|
||||
|
||||
{% hint style="info" %}
|
||||
GPU configuration has been moved to [Host Setup](../../../../using-portainer/docker/host/setup.md#other) and can be configured once the environment has been set up.
|
||||
GPU configuration has been moved to [Host Setup](../../../../user/docker/host/setup.md#other) and can be configured once the environment has been set up.
|
||||
{% endhint %}
|
||||
|
||||
<figure><img src="../../../../.gitbook/assets/2.18-environments-add-docker-moresettings.png" alt=""><figcaption></figcaption></figure>
|
||||
@@ -3,7 +3,7 @@
|
||||
When a remote environment is not directly accessible from the Portainer Server instance, we recommend deploying the Portainer _Edge Agent_ to the remote environment. This allows you to manage the remote environment from your Portainer Server instance without having to open any ports on the environment. Rather than the traditional approach of the server connecting to Agents, the Edge Agent instead polls the Portainer Server periodically to see if there are any pending jobs to perform, and acts appropriately.
|
||||
|
||||
{% hint style="info" %}
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced-topics/edge-agent.md).
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced/edge-agent.md).
|
||||
{% endhint %}
|
||||
|
||||
## Async mode vs Standard mode
|
||||
@@ -26,7 +26,7 @@ In async mode, the Edge Agent requires only the UI port (usually `9443` or `3077
|
||||
If your Portainer Server instance is deployed with TLS, the agent will use HTTPS for the connection it makes back to Portainer. However if your Portainer instance uses a self-signed certificate, the Edge Agent must be deployed with the `-e EDGE_INSECURE_POLL=1` flag. If you do not deploy the Edge Agent with this flag, then the agent will not be able to communicate with the Portainer Server instance.
|
||||
{% endhint %}
|
||||
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../getting-started/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../start/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
|
||||
## Deploying
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
When a remote environment is not directly accessible from the Portainer Server instance, we recommend deploying the Portainer _Edge Agent_ to the remote environment. This allows you to manage the remote environment from your Portainer Server instance without having to open any ports on the environment. Rather than the traditional approach of the server connecting to Agents, the Edge Agent instead polls the Portainer Server periodically to see if there are any pending jobs to perform, and acts appropriately.
|
||||
|
||||
{% hint style="info" %}
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced-topics/edge-agent.md).
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced/edge-agent.md).
|
||||
{% endhint %}
|
||||
|
||||
## Preparation
|
||||
@@ -14,7 +14,7 @@ The Edge Agent requires two ports be open on the Portainer Server instance: the
|
||||
If your Portainer Server instance is deployed with TLS, the agent will use HTTPS for the connection it makes back to Portainer. However if your Portainer instance uses a self-signed certificate, the Edge Agent must be deployed with the `-e EDGE_INSECURE_POLL=1` flag. If you do not deploy the Edge Agent with this flag, then the agent will not be able to communicate with the Portainer Server instance.
|
||||
{% endhint %}
|
||||
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../getting-started/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../start/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
|
||||
## Deploying
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Introduction
|
||||
|
||||
Portainer consists of two elements, the _Portainer Server_ and the _Portainer Agent_. Both elements run as lightweight containers on Kubernetes. This document will outline how to connect Portainer to your existing infrastructure to deploy MicroK8s and install the Portainer Agent. If you do not have a working Portainer Server instance yet, please refer to the [Portainer Server installation guide](../../../../../getting-started/install/server/kubernetes/baremetal.md) first.
|
||||
Portainer consists of two elements, the _Portainer Server_ and the _Portainer Agent_. Both elements run as lightweight containers on Kubernetes. This document will outline how to connect Portainer to your existing infrastructure to deploy MicroK8s and install the Portainer Agent. If you do not have a working Portainer Server instance yet, please refer to the [Portainer Server installation guide](../../../../../start/install/server/kubernetes/baremetal.md) first.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -74,7 +74,7 @@ In addition, you will need the Portainer Agent image - replace `{PORTAINER_SERVE
|
||||
docker.io/portainer/agent:{PORTAINER_SERVER_VERSION}
|
||||
```
|
||||
|
||||
You may also want to pre-download the `kubectl-shell` image if you wish to use the [kubectl shell](../../../../../using-portainer/kubernetes/kubectl.md) functionality within Portainer:
|
||||
You may also want to pre-download the `kubectl-shell` image if you wish to use the [kubectl shell](../../../../../user/kubernetes/kubectl.md) functionality within Portainer:
|
||||
|
||||
```
|
||||
docker.io/portainer/kubectl-shell:latest
|
||||
@@ -8,7 +8,7 @@ Regardless of the method you choose, there are some generic requirements you wil
|
||||
|
||||
The installation instructions also make the following assumptions about your environment:
|
||||
|
||||
* Your environment meets [our requirements](../../../../getting-started/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
* Your environment meets [our requirements](../../../../start/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
* You will be using the `portainer` namespace for Portainer.
|
||||
|
||||
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Agent</strong></td><td></td><td></td><td><a href="../../../../.gitbook/assets/card-agent-large.png">card-agent-large.png</a></td><td><a href="agent.md">agent.md</a></td></tr><tr><td><strong>Edge Agent Standard</strong></td><td></td><td></td><td><a href="../../../../.gitbook/assets/card-edgestd-large.png">card-edgestd-large.png</a></td><td><a href="edge.md">edge.md</a></td></tr><tr><td><strong>Edge Agent Async</strong></td><td></td><td></td><td><a href="../../../../.gitbook/assets/card-edgeasync-large.png">card-edgeasync-large.png</a></td><td><a href="edge-async.md">edge-async.md</a></td></tr><tr><td><strong>Import</strong></td><td>Import an existing Kubernetes config</td><td></td><td><a href="../../../../.gitbook/assets/card-import-large.png">card-import-large.png</a></td><td><a href="import.md">import.md</a></td></tr></tbody></table>
|
||||
@@ -1,6 +1,6 @@
|
||||
# Install Portainer Agent on your Kubernetes environment
|
||||
|
||||
Portainer consists of two elements, the _Portainer Server_ and the _Portainer Agent_. Both elements run as lightweight containers on Kubernetes. This document will outline how to install the Portainer Agent on your cluster and how to connect to it from your Portainer Server instance. If you do not have a working Portainer Server instance yet, please refer to the [Portainer Server installation guide](../../../../getting-started/install/server/kubernetes/baremetal.md) first.
|
||||
Portainer consists of two elements, the _Portainer Server_ and the _Portainer Agent_. Both elements run as lightweight containers on Kubernetes. This document will outline how to install the Portainer Agent on your cluster and how to connect to it from your Portainer Server instance. If you do not have a working Portainer Server instance yet, please refer to the [Portainer Server installation guide](../../../../start/install/server/kubernetes/baremetal.md) first.
|
||||
|
||||
In addition to the generic requirements for Kubernetes environments, you will need:
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
When a remote environment is not directly accessible from the Portainer Server instance, we recommend deploying the Portainer _Edge Agent_ to the remote environment. This allows you to manage the remote environment from your Portainer Server instance without having to open any ports on the environment. Rather than the traditional approach of the server connecting to Agents, the Edge Agent instead polls the Portainer Server periodically to see if there are any pending jobs to perform, and acts appropriately.
|
||||
|
||||
{% hint style="info" %}
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced-topics/edge-agent.md).
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced/edge-agent.md).
|
||||
{% endhint %}
|
||||
|
||||
## Async mode vs Standard mode
|
||||
@@ -26,7 +26,7 @@ In async mode, the Edge Agent requires only the UI port (usually `9443` or `3077
|
||||
If your Portainer Server instance is deployed with TLS, the agent will use HTTPS for the connection it makes back to Portainer. However if your Portainer instance uses a self-signed certificate, the Edge Agent must be deployed with the `-e EDGE_INSECURE_POLL=1` flag. If you do not deploy the Edge Agent with this flag, then the agent will not be able to communicate with the Portainer Server instance.
|
||||
{% endhint %}
|
||||
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../getting-started/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../start/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
|
||||
## Deploying
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
When a remote environment is not directly accessible from the Portainer Server instance, we recommend deploying the Portainer _Edge Agent_ to the remote environment. This allows you to manage the remote environment from your Portainer Server instance without having to open any ports on the environment. Rather than the traditional approach of the server connecting to Agents, the Edge Agent instead polls the Portainer Server periodically to see if there are any pending jobs to perform, and acts appropriately.
|
||||
|
||||
{% hint style="info" %}
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced-topics/edge-agent.md).
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced/edge-agent.md).
|
||||
{% endhint %}
|
||||
|
||||
## Preparation
|
||||
@@ -14,7 +14,7 @@ The Edge Agent requires two ports be open on the Portainer Server instance: the
|
||||
If your Portainer Server instance is deployed with TLS, the agent will use HTTPS for the connection it makes back to Portainer. However if your Portainer instance uses a self-signed certificate, the Edge Agent must be deployed with the `-e EDGE_INSECURE_POLL=1` flag. If you do not deploy the Edge Agent with this flag, then the agent will not be able to communicate with the Portainer Server instance.
|
||||
{% endhint %}
|
||||
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../getting-started/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../start/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
|
||||
## Deploying
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
You can only add a local environment when the Portainer Server container is being created. You cannot add a local environment after Portainer is deployed.
|
||||
|
||||
For more information about the installation process, visit the [Getting Started](../../../getting-started/intro.md) section (in particular, the [installation steps](../../../getting-started/install/)).
|
||||
For more information about the installation process, visit the [Getting Started](../../../start/intro.md) section (in particular, the [installation steps](../../../start/install/)).
|
||||
@@ -10,7 +10,7 @@ Regardless of the method you choose, there are some generic requirements you wil
|
||||
|
||||
The installation instructions also make the following assumptions about your environment:
|
||||
|
||||
* Your environment meets [our requirements](../../../../getting-started/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
* Your environment meets [our requirements](../../../../start/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
* Docker is running as root (for Linux) or an Administrator (for Windows). Portainer with rootless Docker has some limitations, and requires additional configuration.
|
||||
* If your nodes are using DNS records to communicate, that all records are resolvable across the cluster.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Install Portainer Agent on Docker Swarm
|
||||
|
||||
Portainer uses the _Portainer Agent_ container to communicate with the _Portainer Server_ instance and provide access to the node's resources. This document will outline how to install the Portainer Agent on your environment and how to connect to it from your Portainer Server instance. If you do not have a working Portainer Server instance yet, please refer to the [Portainer Server installation guide](../../../../getting-started/install/server/swarm/linux.md) first.
|
||||
Portainer uses the _Portainer Agent_ container to communicate with the _Portainer Server_ instance and provide access to the node's resources. This document will outline how to install the Portainer Agent on your environment and how to connect to it from your Portainer Server instance. If you do not have a working Portainer Server instance yet, please refer to the [Portainer Server installation guide](../../../../start/install/server/swarm/linux.md) first.
|
||||
|
||||
In addition to the generic requirements for Docker Swarm environments, you will need:
|
||||
|
||||
@@ -34,7 +34,7 @@ You must run the command on the Docker Swarm cluster before entering the environ
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="info" %}
|
||||
If you want to use the [host management features](../../../../using-portainer/docker/swarm/setup.md#host-and-filesystem) of the Portainer Agent, you should add the necessary volume mount to the command that Portainer provides:
|
||||
If you want to use the [host management features](../../../../user/docker/swarm/setup.md#host-and-filesystem) of the Portainer Agent, you should add the necessary volume mount to the command that Portainer provides:
|
||||
|
||||
```
|
||||
--mount type=bind,src=//,dst=/host
|
||||
@@ -3,7 +3,7 @@
|
||||
When a remote environment is not directly accessible from the Portainer Server instance, we recommend deploying the Portainer _Edge Agent_ to the remote environment. This allows you to manage the remote environment from your Portainer Server instance without having to open any ports on the environment. Rather than the traditional approach of the server connecting to Agents, the Edge Agent instead polls the Portainer Server periodically to see if there are any pending jobs to perform, and acts appropriately.
|
||||
|
||||
{% hint style="info" %}
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced-topics/edge-agent.md).
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced/edge-agent.md).
|
||||
{% endhint %}
|
||||
|
||||
## Async mode vs Standard mode
|
||||
@@ -26,7 +26,7 @@ In async mode, the Edge Agent requires only the UI port (usually `9443` or `3077
|
||||
If your Portainer Server instance is deployed with TLS, the agent will use HTTPS for the connection it makes back to Portainer. However if your Portainer instance uses a self-signed certificate, the Edge Agent must be deployed with the `-e EDGE_INSECURE_POLL=1` flag. If you do not deploy the Edge Agent with this flag, then the agent will not be able to communicate with the Portainer Server instance.
|
||||
{% endhint %}
|
||||
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../getting-started/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../start/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
|
||||
## Deploying
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
When a remote environment is not directly accessible from the Portainer Server instance, we recommend deploying the Portainer _Edge Agent_ to the remote environment. This allows you to manage the remote environment from your Portainer Server instance without having to open any ports on the environment. Rather than the traditional approach of the server connecting to Agents, the Edge Agent instead polls the Portainer Server periodically to see if there are any pending jobs to perform, and acts appropriately.
|
||||
|
||||
{% hint style="info" %}
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced-topics/edge-agent.md).
|
||||
For a technical summary of how the Edge Agent works, refer to our [advanced documentation](../../../../advanced/edge-agent.md).
|
||||
{% endhint %}
|
||||
|
||||
## Preparation
|
||||
@@ -14,7 +14,7 @@ The Edge Agent requires two ports be open on the Portainer Server instance: the
|
||||
If your Portainer Server instance is deployed with TLS, the agent will use HTTPS for the connection it makes back to Portainer. However if your Portainer instance uses a self-signed certificate, the Edge Agent must be deployed with the `-e EDGE_INSECURE_POLL=1` flag. If you do not deploy the Edge Agent with this flag, then the agent will not be able to communicate with the Portainer Server instance.
|
||||
{% endhint %}
|
||||
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../getting-started/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
In addition, our instructions assume your environment meets [our requirements](../../../../start/requirements-and-prerequisites.md). While Portainer may work with other configurations, it may require configuration changes or have limited functionality.
|
||||
|
||||
## Deploying
|
||||
|
||||
@@ -23,7 +23,7 @@ Once you have made your type selection, configure the options and select the pla
|
||||
| Portainer API server URL | This field displays your Portainer API server URL. This can be adjusted in the Edge Compute settings. |
|
||||
| Portainer tunnel server address | This field displays your Portainer tunnel server address. This can be adjusted in the Edge Compute settings, and is not used for Edge Agent Async deployments. |
|
||||
| Group | Select a [group](groups.md) for your Edge Agent deployments. |
|
||||
| Edge Groups | Select one or more [Edge Groups](../../using-portainer/edge/groups.md) for your Edge Agent deployments. |
|
||||
| Edge Groups | Select one or more [Edge Groups](../../user/edge/groups.md) for your Edge Agent deployments. |
|
||||
| Tags | Select one or more [tags](tags.md) for your Edge Agent deployments. |
|
||||
| Edge ID Generator | Provide a one-line script that will be used to generate a unique ID for your Edge devices. For Linux, an example would be using the `uuidgen` command. |
|
||||
| Environment variables | Define a comma separated list of environment variables that will be sourced from the Edge devices for use in Portainer. |
|
||||
@@ -23,7 +23,7 @@ To schedule an update, Portainer must have a snapshot of all the environments yo
|
||||
| Field/Option | Overview |
|
||||
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Name | Enter a name for the scheduled update. |
|
||||
| Groups | Select the Edge Group(s) containing the Edge devices you want to update. You can configure these groups under [Edge Groups](../../using-portainer/edge/groups.md). |
|
||||
| Groups | Select the Edge Group(s) containing the Edge devices you want to update. You can configure these groups under [Edge Groups](../../user/edge/groups.md). |
|
||||
| Version | Ensure the **Update** tab is selected, then select the version you want to upgrade to from the dropdown. |
|
||||
| Schedule date & time | <p>Select a date and time to schedule the update.<br>When upgrading from a version prior to 2.17, this field will be unavailable and the upgrade will take place immediately on creation of the schedule.</p> |
|
||||
| Registry | If needed, you can select the registry to pull the updated Portainer Agent images from. The image you are updating to must exist in the registry with the `agent:version` name format, as must the `portainer-updater` image. This functionality is useful if you are running in an airgapped environment. |
|
||||
@@ -45,7 +45,7 @@ To schedule a rollback, Portainer must have a snapshot of all the environments y
|
||||
| Field/Option | Overview |
|
||||
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| Name | Enter a name for the scheduled rollback. |
|
||||
| Group | Select the Edge Group(s) containing the Edge devices you want to roll back. You can configure these groups under [Edge Groups](../../using-portainer/edge/groups.md). |
|
||||
| Group | Select the Edge Group(s) containing the Edge devices you want to roll back. You can configure these groups under [Edge Groups](../../user/edge/groups.md). |
|
||||
| Version | <p>Ensure the <strong>Rollback</strong> tab is selected, then select the version you want to roll back to from the dropdown.<br>This dropdown is only available when multiple rollback versions are available.</p> |
|
||||
| Schedule date & time | Select a date and time to schedule the rollback. |
|
||||
| Registry | If needed, you can select the registry to pull the Portainer Agent images from. The image you are rolling back to must exist in the registry with the `agent:version` name format, as must the `portainer-updater` image. This functionality is useful if you are running in an airgapped environment. |
|
||||
@@ -1,6 +1,6 @@
|
||||
# Settings
|
||||
|
||||
This section provides access to Portainer settings that apply to Portainer in general. For environment-specific settings, check the [Host](../../using-portainer/docker/host/), [Swarm](../../using-portainer/docker/swarm/) or [Cluster](../../using-portainer/kubernetes/cluster/) sections in each environment depending on the environment type.
|
||||
This section provides access to Portainer settings that apply to Portainer in general. For environment-specific settings, check the [Host](../../user/docker/host/), [Swarm](../../user/docker/swarm/) or [Cluster](../../user/kubernetes/cluster/) sections in each environment depending on the environment type.
|
||||
|
||||
{% content-ref url="general.md" %}
|
||||
[general.md](general.md)
|
||||
@@ -3,7 +3,7 @@
|
||||
To enable and configure Edge Compute functionality in Portainer, select **Settings** from the menu then select **Edge Compute**. 
|
||||
|
||||
{% hint style="info" %}
|
||||
To learn how to use our Edge Compute functionality, please refer to the [Edge Compute](../../using-portainer/edge/) section of this documentation.
|
||||
To learn how to use our Edge Compute functionality, please refer to the [Edge Compute](../../user/edge/) section of this documentation.
|
||||
{% endhint %}
|
||||
|
||||
<figure><img src="../../.gitbook/assets/2.15-settings-edgecompute.gif" alt=""><figcaption></figcaption></figure>
|
||||
@@ -17,7 +17,7 @@ In this section you can use the following options to enable and configure Edge C
|
||||
| Enable Edge Compute features | Toggle this on to enable Edge Compute functionality including Edge Device features. |
|
||||
| Portainer API server URL | <p>Enter the default URL and port of your Portainer Server instance as it will be seen from your Edge environment. If using a FQDN, ensure that DNS is properly configured to provide this.<br>This value can be overridden when manually deploying an Edge Agent.<br>This feature is only available in Portainer Business Edition.</p> |
|
||||
| Portainer tunnel server address | <p>Enter the default address and port of your Portainer Server instance's tunnel server as it will be seen from your Edge environment. If using a FQDN, ensure that DNS is properly configured to provide this.<br>In most cases, this will be the same address as the Portainer API server URL, but without the protocol and on port <code>8000</code>.<br>This value can be overridden when manually deploying an Edge Agent.<br>This feature is only available in Portainer Business Edition. For Community Edition users, refer to <a href="https://github.com/portainer/portainer/issues/6251">this GitHub issue</a>.</p> |
|
||||
| Use separate mTLS cert | <p>Enable this toggle to use a separate mTLS certificate for Edge Agent communication. With this option disabled, Edge Agents will use the same TLS certificate as the Portainer UI.<br>For more information on mTLS read our <a href="../../advanced-topics/mtls.md">advanced documentation</a>.</p> |
|
||||
| Use separate mTLS cert | <p>Enable this toggle to use a separate mTLS certificate for Edge Agent communication. With this option disabled, Edge Agents will use the same TLS certificate as the Portainer UI.<br>For more information on mTLS read our <a href="../../advanced/mtls.md">advanced documentation</a>.</p> |
|
||||
| TLS CA certificate | When **Use separate mTLS cert** is enabled, select and upload the CA certificate for use with mTLS. |
|
||||
| TLS certificate | When **Use separate mTLS cert** is enabled, select and upload the server certificate for use with mTLS. |
|
||||
| TLS key | When **Use separate mTLS cert** is enabled, select and upload the key corresponding to the server certificate. |
|
||||
@@ -65,15 +65,15 @@ To remove a user from the Edge Administrator role, check the box next to their u
|
||||
|
||||
In this section you can configure how automatic Edge environment configuration functions.
|
||||
|
||||
| Field/Option | Overview |
|
||||
| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Enable Edge Environment Waiting Room | Toggle this on to enable the [waiting room](../../using-portainer/edge/waiting-room.md) feature for Edge devices. This will allow any Edge Device that connects to the Portainer instance to automatically associate with Portainer. We recommend leaving this on (the waiting room enabled). |
|
||||
| Field/Option | Overview |
|
||||
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Enable Edge Environment Waiting Room | Toggle this on to enable the [waiting room](../../user/edge/waiting-room.md) feature for Edge devices. This will allow any Edge Device that connects to the Portainer instance to automatically associate with Portainer. We recommend leaving this on (the waiting room enabled). |
|
||||
|
||||
<figure><img src="../../.gitbook/assets/2.20-settings-edge-aeec.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
## Intel OpenAMT
|
||||
|
||||
This section controls the configuration of the [Intel OpenAMT](../../using-portainer/home/openamt.md) functionality in Portainer.
|
||||
This section controls the configuration of the [Intel OpenAMT](../../user/home/openamt.md) functionality in Portainer.
|
||||
|
||||
| Field/Option | Overview |
|
||||
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
@@ -32,7 +32,7 @@ Your message will then be shown at the login screen.
|
||||
|
||||
### App Templates
|
||||
|
||||
You can deploy containers and services using Portainer's set of built-in app templates, or [replace them with your own](../../advanced-topics/app-templates/build.md) set of templates. Once you have a JSON file containing the template definitions, you can provide the URL to it here.
|
||||
You can deploy containers and services using Portainer's set of built-in app templates, or [replace them with your own](../../advanced/app-templates/build.md) set of templates. Once you have a JSON file containing the template definitions, you can provide the URL to it here.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/2.15-settings-settings-2.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
@@ -46,7 +46,7 @@ If you wish to use your own Helm repository in place of the Bitnami repository w
|
||||
|
||||
### Kubeconfig expiry
|
||||
|
||||
Select the expiry time for [exported kubeconfig files](../../using-portainer/kubernetes/kubeconfig.md) from this dropdown. The new expiry time will only apply to configurations created after this value was changed.
|
||||
Select the expiry time for [exported kubeconfig files](../../user/kubernetes/kubeconfig.md) from this dropdown. The new expiry time will only apply to configurations created after this value was changed.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/2.17-admin-settings-kubernetes-kubeconfig.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
@@ -43,4 +43,4 @@ Scroll down to the **Effective access viewer** section and select a user from th
|
||||
|
||||
Because Docker does not natively provide role-based access control, we implement our own role management in order to provide this functionality. On a Kubernetes environment, we leverage the RBAC functionality built into Kubernetes alongside our own role management to provide security and flexibility to roles and access.
|
||||
|
||||
For more information on the permissions that each role has for Docker and Swarm environments, see our [Docker roles and permissions documentation](../../advanced-topics/docker-roles-and-permissions.md). For more information about how we map Portainer roles to Kubernetes roles, see our [roles and bindings documentation](../../advanced-topics/kubernetes-roles-and-bindings.md).
|
||||
For more information on the permissions that each role has for Docker and Swarm environments, see our [Docker roles and permissions documentation](../../advanced/docker-roles-and-permissions.md). For more information about how we map Portainer roles to Kubernetes roles, see our [roles and bindings documentation](../../advanced/kubernetes-roles-and-bindings.md).
|
||||
@@ -207,7 +207,7 @@ You can also update the logo in the Portainer UI (**Settings** menu).
|
||||
We suggest hosting template files on [GitHub](https://www.github.com/) so Portainer can access them without authentication.
|
||||
{% endhint %}
|
||||
|
||||
Portainer allows you to rapidly [deploy containers using app templates](../using-portainer/docker/templates/deploy-container.md). By default, Portainer templates will be used but you can also define your own.
|
||||
Portainer allows you to rapidly [deploy containers using app templates](../user/docker/templates/deploy-container.md). By default, Portainer templates will be used but you can also define your own.
|
||||
|
||||
Templates are loaded once when Portainer is first started. If you already deployed a Portainer instance then decide to use your own templates, you’ll need to clear the default templates either in the user interface or through the HTTP API. Use the `--templates` flag to specify a URL where the template file can be accessed via HTTP.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Docker roles and permissions
|
||||
|
||||
This document describes the permission levels each [RBAC role](../administering-portainer/user/roles.md) has within the Portainer application for both Docker Standalone and Docker Swarm environments. Refer to the linked notes for further requirements on each operation.
|
||||
This document describes the permission levels each [RBAC role](../admin/user/roles.md) has within the Portainer application for both Docker Standalone and Docker Swarm environments. Refer to the linked notes for further requirements on each operation.
|
||||
|
||||
{% hint style="info" %}
|
||||
Role-Based Access Control is only available in Portainer Business Edition.
|
||||
@@ -18,7 +18,7 @@ Role-Based Access Control is only available in Portainer Business Edition.
|
||||
|
||||
### Stacks
|
||||
|
||||
Access to these operations can be affected by the **Disable the use of Stacks for non-administrators** security setting ([Docker](../using-portainer/docker/host/setup.md#docker-security-settings), [Swarm](../using-portainer/docker/swarm/setup.md#docker-security-settings)).
|
||||
Access to these operations can be affected by the **Disable the use of Stacks for non-administrators** security setting ([Docker](../user/docker/host/setup.md#docker-security-settings), [Swarm](../user/docker/swarm/setup.md#docker-security-settings)).
|
||||
|
||||
<table><thead><tr><th width="352">Operation</th><th width="62" data-type="checkbox">EA</th><th width="58" data-type="checkbox">OP</th><th width="57" data-type="checkbox">HD</th><th width="55" data-type="checkbox">ST</th><th width="58" data-type="checkbox">RO</th><th>Notes</th></tr></thead><tbody><tr><td>View stacks</td><td>true</td><td>true</td><td>true</td><td>true</td><td>true</td><td><a href="docker-roles-and-permissions.md#notes">1</a></td></tr><tr><td>Create a stack</td><td>true</td><td>false</td><td>false</td><td>true</td><td>false</td><td><a href="docker-roles-and-permissions.md#notes">3</a></td></tr><tr><td>Edit a stack</td><td>true</td><td>false</td><td>false</td><td>true</td><td>false</td><td><a href="docker-roles-and-permissions.md#notes">1</a></td></tr><tr><td>View stack details</td><td>true</td><td>true</td><td>true</td><td>true</td><td>true</td><td><a href="docker-roles-and-permissions.md#notes">1</a></td></tr><tr><td>Change stack ownership</td><td>true</td><td>true</td><td>false</td><td>true</td><td>false</td><td><a href="docker-roles-and-permissions.md#notes">1</a></td></tr><tr><td>Stop a stack</td><td>true</td><td>false</td><td>false</td><td>true</td><td>false</td><td><a href="docker-roles-and-permissions.md#notes">1</a></td></tr><tr><td>Start a stack</td><td>true</td><td>false</td><td>false</td><td>true</td><td>false</td><td><a href="docker-roles-and-permissions.md#notes">1</a></td></tr><tr><td>Duplicate a stack</td><td>true</td><td>false</td><td>false</td><td>true</td><td>false</td><td><a href="docker-roles-and-permissions.md#notes">1</a></td></tr><tr><td>Migrate a stack</td><td>true</td><td>false</td><td>false</td><td>true</td><td>false</td><td><a href="docker-roles-and-permissions.md#notes">1</a></td></tr><tr><td>Create template from a stack</td><td>true</td><td>false</td><td>false</td><td>true</td><td>false</td><td><a href="docker-roles-and-permissions.md#notes">1</a></td></tr><tr><td>Update service in stack</td><td>true</td><td>false</td><td>false</td><td>true</td><td>false</td><td><a href="docker-roles-and-permissions.md#notes">1</a>, <a href="docker-roles-and-permissions.md#notes">2</a></td></tr><tr><td>Remove service from stack</td><td>true</td><td>false</td><td>false</td><td>true</td><td>false</td><td><a href="docker-roles-and-permissions.md#notes">1</a>, <a href="docker-roles-and-permissions.md#notes">2</a></td></tr><tr><td>Delete a stack</td><td>true</td><td>false</td><td>false</td><td>true</td><td>false</td><td><a href="docker-roles-and-permissions.md#notes">1</a></td></tr></tbody></table>
|
||||
|
||||
@@ -84,11 +84,11 @@ These operations are only relevant for Docker Swarm environments.
|
||||
|
||||
1. Standard / Read only users (and Operators in the case of ownership operations) have permission only if they are given access to the resource. This can be inherited, for example inheriting a service from a stack.
|
||||
2. This operation is only relevant for Swarm environments.
|
||||
3. This operation can be affected by the following security settings ([Docker](../using-portainer/docker/host/setup.md#docker-security-settings), [Swarm](../using-portainer/docker/swarm/setup.md#docker-security-settings)):
|
||||
3. This operation can be affected by the following security settings ([Docker](../user/docker/host/setup.md#docker-security-settings), [Swarm](../user/docker/swarm/setup.md#docker-security-settings)):
|
||||
1. **Disable privileged mode for non-administrators**
|
||||
2. **Disable the use of host PID 1 for non-administrators**
|
||||
3. **Disable device mappings for non-administrators**
|
||||
4. **Disable container capabilities for non-administrators**
|
||||
5. **Disable bind mounts for non-administrators**
|
||||
4. This operation can be affected by the **Enable volume management for non-administrators** setting ([Docker](../using-portainer/docker/host/setup.md#enable-volume-management-for-non-administrators), [Swarm](../using-portainer/docker/swarm/setup.md#host-and-filesystem)), and requires the use of the Portainer Agent.
|
||||
4. This operation can be affected by the **Enable volume management for non-administrators** setting ([Docker](../user/docker/host/setup.md#enable-volume-management-for-non-administrators), [Swarm](../user/docker/swarm/setup.md#host-and-filesystem)), and requires the use of the Portainer Agent.
|
||||
5. This operation can only be performed under the allowed registry.
|
||||
@@ -23,7 +23,7 @@ During the creation process, an Edge ID is dynamically generated. This is a rand
|
||||
The Edge ID and the join token are unique per environment. The join token (`EDGE_KEY`) is made up of the following base64 encoded data separated by the pipe (`|`) character:
|
||||
|
||||
* The Portainer instance API URL. This is how the Edge Agent knows how to ‘call home’ to your Portainer instance.
|
||||
* The Portainer instance reverse tunnel server address. This is identical to the API URL (unless [changed during deployment](../administering-portainer/environments/add/docker/edge.md#deploying) or in [Edge Compute settings](../administering-portainer/settings/edge.md#edge-compute-settings)) but with the tunnel server port (`8000` is the default).
|
||||
* The Portainer instance reverse tunnel server address. This is identical to the API URL (unless [changed during deployment](../admin/environments/add/docker/edge.md#deploying) or in [Edge Compute settings](../admin/settings/edge.md#edge-compute-settings)) but with the tunnel server port (`8000` is the default).
|
||||
* The Portainer instance reverse-tunnel server fingerprint (prevents MITM when creating a tunnel).
|
||||
* The environment identifier key (endpoint / environment ID).
|
||||
|
||||
@@ -21,7 +21,7 @@ In order to configure Portainer with mTLS support, you will need the following:
|
||||
|
||||
## Configuring the Portainer Server
|
||||
|
||||
To use mTLS with your Edge Agents, the Portainer Server instance must be configured with mTLS support. This can either be done during the initial installation of the Portainer Server instance, or after installation through the [Edge Compute settings](../administering-portainer/settings/edge.md#mtls-certificate).
|
||||
To use mTLS with your Edge Agents, the Portainer Server instance must be configured with mTLS support. This can either be done during the initial installation of the Portainer Server instance, or after installation through the [Edge Compute settings](../admin/settings/edge.md#mtls-certificate).
|
||||
|
||||
### Configure mTLS during installation
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
The relative path volumes support in Portainer Business Edition is intended to provide you with a way to reference files and directories that are supplied within the Git repository alongside your compose file without needing to know the absolute path at which they will appear when they are deployed to your environment. 
|
||||
|
||||
{% hint style="info" %}
|
||||
Relative path support is only present in Portainer Business Edition, and needs to be [enabled when deploying your stack from Git](../using-portainer/docker/stacks/add.md#relative-path-volumes) for this article to apply.
|
||||
Relative path support is only present in Portainer Business Edition, and needs to be [enabled when deploying your stack from Git](../user/docker/stacks/add.md#relative-path-volumes) for this article to apply.
|
||||
{% endhint %}
|
||||
|
||||
In the background the way this works is as follows:
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user