diff --git a/.gitbook/assets/2.12.2-stacks-edit-editor-webhook (1) (1).png b/.gitbook/assets/2.12.2-stacks-edit-editor-webhook (1) (1).png new file mode 100644 index 00000000..4921fd5c Binary files /dev/null and b/.gitbook/assets/2.12.2-stacks-edit-editor-webhook (1) (1).png differ diff --git a/.gitbook/assets/2.15-create_first_user (1) (1) (1).png b/.gitbook/assets/2.15-create_first_user (1) (1) (1).png new file mode 100644 index 00000000..35b1dd7b Binary files /dev/null and b/.gitbook/assets/2.15-create_first_user (1) (1) (1).png differ diff --git a/.gitbook/assets/2.15-custom-templates (1) (1) (1).gif b/.gitbook/assets/2.15-custom-templates (1) (1) (1).gif new file mode 100644 index 00000000..b8475eed Binary files /dev/null and b/.gitbook/assets/2.15-custom-templates (1) (1) (1).gif differ diff --git a/.gitbook/assets/2.15-docker_api_more_settings (1) (1) (1).png b/.gitbook/assets/2.15-docker_api_more_settings (1) (1) (1).png new file mode 100644 index 00000000..08472f72 Binary files /dev/null and b/.gitbook/assets/2.15-docker_api_more_settings (1) (1) (1).png differ diff --git a/.gitbook/assets/2.15-docker_services_list (1) (1) (1).png b/.gitbook/assets/2.15-docker_services_list (1) (1) (1).png new file mode 100644 index 00000000..cf6ae5b0 Binary files /dev/null and b/.gitbook/assets/2.15-docker_services_list (1) (1) (1).png differ diff --git a/admin/environments/add/aci.md b/admin/environments/add/aci.md index 1e71abf2..4b929fa0 100644 --- a/admin/environments/add/aci.md +++ b/admin/environments/add/aci.md @@ -11,7 +11,7 @@ The following ACI features are not currently supported: To add an ACI environment, click on **Environments** then click the **Add environment** button. -
+
Select **ACI** as your environment type and click **Start Wizard**. Enter the **environment details** using the table below as a guide. diff --git a/admin/environments/add/docker.md b/admin/environments/add/docker.md index fd8bc6d4..7289a72c 100644 --- a/admin/environments/add/docker.md +++ b/admin/environments/add/docker.md @@ -8,7 +8,7 @@ Before you begin, you will need to ensure that your Docker instance is configure From the menu select **Environments** then click **Add environment**. -
+
Next, select **Docker Standalone** as the environment type then click **Start Wizard**. Select the **API** option and your platform, then enter the environment details using the table below as a guide: @@ -30,7 +30,7 @@ Portainer expects TLS certificates and keys to be in PEM format. As an optional step you can expand the **More settings** section to add GPUs to your environment, and to categorize the environment by adding it to a [group](../groups.md) or [tagging](../tags.md) it for better searchability. -
+
When you're ready, click **Connect**. If you have other environments to configure click **Next** to proceed, otherwise click **Close** to return to the list of environments. @@ -38,7 +38,7 @@ When you're ready, click **Connect**. If you have other environments to configur From the menu select **Environments** then click **Add environment**. -
+
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. @@ -53,6 +53,6 @@ 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 add GPUs to your environment, and to categorize the environment by adding it to a [group](../groups.md) or [tagging](../tags.md) it for better searchability. -
+
When you're ready, click **Connect**. If you have other environments to configure click **Next** to proceed, otherwise click **Close** to return to the list of environments. diff --git a/admin/environments/add/edge.md b/admin/environments/add/edge.md index e10a19c2..bcc83320 100644 --- a/admin/environments/add/edge.md +++ b/admin/environments/add/edge.md @@ -20,7 +20,7 @@ The Edge Agent communicates with the Portainer Server instance over port `8000` To add an Edge Agent, click on **Environments** then **Add environment**. -
+
Select either Docker or Kubernetes depending on your environment type, then click **Start Wizard**. Then select the **Edge Agent** option. Enter the environment details **** using the table below as a guide. diff --git a/admin/environments/add/kubernetes.md b/admin/environments/add/kubernetes.md index 5334b98b..894602de 100644 --- a/admin/environments/add/kubernetes.md +++ b/admin/environments/add/kubernetes.md @@ -16,7 +16,7 @@ Helm charts for agent-only deployments will be available soon. From the menu select **Environments** then click **Add environment**. -
+
Select the **Kubernetes** option and click **Start Wizard**. Select the **Agent** option and choose the tab that matches your configuration (**Kubernetes via load balancer** or **Kubernetes via node port**). Copy the command, then run it on the control node of your Kubernetes cluster. diff --git a/admin/environments/add/nomad.md b/admin/environments/add/nomad.md index 0918e3da..69db7682 100644 --- a/admin/environments/add/nomad.md +++ b/admin/environments/add/nomad.md @@ -4,7 +4,7 @@ Nomad support in Portainer is provided through the use of the [Portainer Edge Ag To add a Nomad environment, click on **Environments** then click the **Add environment** button. -
+
Select **Nomad** as your environment type and click **Start Wizard**. Enter the **environment details** using the table below as a guide. @@ -13,7 +13,7 @@ Select **Nomad** as your environment type and click **Start Wizard**. Enter the | Name | Enter a name for your environment. | | Portainer server URL | Enter the URL and port of your Portainer Server instance as it will be seen from your Nomad environment. If using a FQDN, ensure that DNS is properly configured to provide this. | -
+
As an optional step you can expand the **More settings** section and adjust the Poll frequency for the environment - this defines how often this Edge Agent will check the Portainer Server for new jobs. The default is every 5 seconds. You can also categorize the environment by adding it to a [group](../groups.md) or [tagging](../tags.md) it for better searchability. diff --git a/admin/environments/add/swarm.md b/admin/environments/add/swarm.md index 5982ca00..7a6224ec 100644 --- a/admin/environments/add/swarm.md +++ b/admin/environments/add/swarm.md @@ -4,7 +4,7 @@ From the menu select **Environments** then click **Add environment**. -
+
Next, select **Docker Swarm** as the environment type then click **Start Wizard**. Select the **Agent** option and your platform. Copy the command, then run it on the manager node of your Docker Swarm cluster. @@ -53,6 +53,6 @@ Only do this **once** for your environment, regardless of how many nodes are in As an optional step you can expand the **More settings** section and categorize the environment by adding it to a [group](../groups.md) or [tagging](../tags.md) it for better searchability. -
+
When you're ready, click **Connect**. If you have other environments to configure click **Next** to proceed, otherwise click **Close** to return to the list of environments.\ diff --git a/admin/users/password.md b/admin/users/password.md index d21e30ce..ead063cc 100644 --- a/admin/users/password.md +++ b/admin/users/password.md @@ -6,4 +6,4 @@ From the menu select **Users** then select the user whose password you want to r Enter a new strong password, re-enter the password to confirm it then click **Update password**. -
+
diff --git a/start/agent/aci.md b/start/agent/aci.md index 736fe065..12a7f9dd 100644 --- a/start/agent/aci.md +++ b/start/agent/aci.md @@ -11,7 +11,7 @@ The following ACI features are not currently supported: To add an ACI environment, click on **Environments** then click the **Add environment** button. -
+
Select **ACI** as your environment type and click **Start Wizard**. Enter the **environment details** using the table below as a guide. diff --git a/start/agent/edge.md b/start/agent/edge.md index 2b199287..0b602036 100644 --- a/start/agent/edge.md +++ b/start/agent/edge.md @@ -22,15 +22,15 @@ In addition, our instructions assume your environment meets [our requirements](. To add an Edge Agent, click on **Environments** then **Add environment**. -
+
Select either **Docker Standalone**, **Docker Swarm** or **Kubernetes** depending on your environment type, then click **Start Wizard**. Then select the **Edge Agent** option. Enter the environment details **** using the table below as a guide. -| Field | Overview | -| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Name | Enter a name for your environment. | -| Portainer API server URL | Enter the 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. | -| Portainer tunnel server address |

Enter the 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.
In most cases, this will be the same address as the Portainer API server URL, but without the protocol and on port 8000.

| +| Field | Overview | +| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Name | Enter a name for your environment. | +| Portainer API server URL | Enter the 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. | +| Portainer tunnel server address |

Enter the 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.
In most cases, this will be the same address as the Portainer API server URL, but without the protocol and on port 8000.
This field is only available in Portainer Business Edition.

|
diff --git a/start/agent/kaas/README.md b/start/agent/kaas/README.md index 41cd9eaa..c79b976b 100644 --- a/start/agent/kaas/README.md +++ b/start/agent/kaas/README.md @@ -8,7 +8,7 @@ This feature is only available in [Portainer Business Edition](https://www.porta To get started, select **Environments** from the left hand menu then click **Add Environment**. -
+
From the wizard select the **KaaS** option and click **Start Wizard**. Then, select your provider. We currently support the following providers: diff --git a/start/agent/kaas/civo.md b/start/agent/kaas/civo.md index f8499b1a..a18f74bb 100644 --- a/start/agent/kaas/civo.md +++ b/start/agent/kaas/civo.md @@ -6,7 +6,7 @@ Select the **Civo** option from the list of providers. If you haven't already pr You can find more details on [setting up access to your Civo account](../../../admin/settings/cloud/civo.md) in the [cloud credentials documentation](../../../admin/settings/cloud/). {% endhint %} -
+
Once you have added your credentials (or if you already had them set up) select your cluster options from the fields below. diff --git a/start/agent/kubernetes/baremetal.md b/start/agent/kubernetes/baremetal.md index 4a5a8d30..a7fba0bc 100644 --- a/start/agent/kubernetes/baremetal.md +++ b/start/agent/kubernetes/baremetal.md @@ -32,7 +32,7 @@ Helm charts for agent-only deployments will be available soon. From the menu select **Environments** then click **Add environment**. -
+
Select the **Kubernetes** option and click **Start Wizard**. Select the **Agent** option and choose the tab that matches your configuration (**Kubernetes via load balancer** or **Kubernetes via node port**). Copy the command, then run it on the control node of your Kubernetes cluster. diff --git a/start/agent/nomad.md b/start/agent/nomad.md index e557547b..d78570f7 100644 --- a/start/agent/nomad.md +++ b/start/agent/nomad.md @@ -4,7 +4,7 @@ Nomad support in Portainer is provided through the use of the [Portainer Edge Ag To add a Nomad environment, click on **Environments** then click the **Add environment** button. -
+
Select **Nomad** as your environment type and click **Start Wizard**. Enter the **environment details** using the table below as a guide. @@ -13,7 +13,7 @@ Select **Nomad** as your environment type and click **Start Wizard**. Enter the | Name | Enter a name for your environment. | | Portainer server URL | Enter the URL and port of your Portainer Server instance as it will be seen from your Nomad environment. If using a FQDN, ensure that DNS is properly configured to provide this. | -
+
As an optional step you can expand the **More settings** section and adjust the Poll frequency for the environment - this defines how often this Edge Agent will check the Portainer Server for new jobs. The default is every 5 seconds. You can also categorize the environment by adding it to a [group](../../admin/environments/groups.md) or [tagging](../../admin/environments/tags.md) it for better searchability. diff --git a/start/agent/swarm/linux.md b/start/agent/swarm/linux.md index 17942a5d..1a471566 100644 --- a/start/agent/swarm/linux.md +++ b/start/agent/swarm/linux.md @@ -32,7 +32,7 @@ Only do this **once** for your environment, regardless of how many nodes are in From the menu select **Environments** then click **Add environment**. -
+
Next, select **Docker Swarm** as the environment type then click **Start Wizard**. Select the **Agent** option and the **Linux & Windows WSL** tab. Copy the command, then run it on the manager node of your Docker Swarm cluster. diff --git a/start/agent/swarm/wcs.md b/start/agent/swarm/wcs.md index 2935741b..e8968926 100644 --- a/start/agent/swarm/wcs.md +++ b/start/agent/swarm/wcs.md @@ -29,7 +29,7 @@ Only do this **once** for your environment, regardless of how many nodes are in From the menu select **Environments** then click **Add environment**. -
+
Next, select **Docker Swarm** as the environment type then click **Start Wizard**. Select the **Agent** option and the **Windows WCS** tab. Copy the command, then run it on the manager node of your Docker Swarm cluster. diff --git a/start/agent/swarm/wsl.md b/start/agent/swarm/wsl.md index c8adbcfb..af5bfb43 100644 --- a/start/agent/swarm/wsl.md +++ b/start/agent/swarm/wsl.md @@ -33,7 +33,7 @@ Only do this **once** for your environment, regardless of how many nodes are in From the menu select **Environments** then click **Add environment**. -
+
Next, select **Docker Swarm** as the environment type then click **Start Wizard**. Select the **Agent** option and the **Linux & Windows WSL** tab. Copy the command, then run it on the manager node of your Docker Swarm cluster. diff --git a/user/docker/host/setup.md b/user/docker/host/setup.md index 170bdab0..5bd30ff2 100644 --- a/user/docker/host/setup.md +++ b/user/docker/host/setup.md @@ -42,7 +42,7 @@ This setting allows you to specify a window within which [automatic updates](../ If this setting is enabled and an update is made to an application outside of this window, it will not be applied. {% endhint %} -
+
## Docker Security Settings diff --git a/user/docker/images/pull.md b/user/docker/images/pull.md index 75cab8f8..402396f7 100644 --- a/user/docker/images/pull.md +++ b/user/docker/images/pull.md @@ -12,7 +12,7 @@ This method lets you pull images from Docker Hub or from another registry that y From the menu select **Images**. Select the registry to use then enter the name of the image. On a multi-node environment, select the node to deploy to. -
+
When you're ready, click **Pull the image**. diff --git a/user/docker/services/README.md b/user/docker/services/README.md index e0effa6a..3329867a 100644 --- a/user/docker/services/README.md +++ b/user/docker/services/README.md @@ -6,7 +6,7 @@ The **Services** menu is only available to Docker Swarm endpoints. A service consists of an image definition and container configuration as well as instructions on how those containers will be deployed across a Swarm cluster. -
+
When the [new image notification](../swarm/setup.md#other) feature is enabled, the circle next to the image name indicates whether the local image is up to date, with a green circle indicating it is up to date and a red circle indicating that there is a newer version of the image available at the remote registry. A grey circle indicates Portainer was unable to determine whether there is an update available for the image. diff --git a/user/docker/services/configure.md b/user/docker/services/configure.md index ef3392bb..1b1427f5 100644 --- a/user/docker/services/configure.md +++ b/user/docker/services/configure.md @@ -14,7 +14,7 @@ In this section you can: * View the [service logs](logs.md). * Update, [roll back](rollback.md) or delete the service. -
+
## Container specification configuration options diff --git a/user/docker/stacks/add.md b/user/docker/stacks/add.md index 5ab9549d..b9eac5c1 100644 --- a/user/docker/stacks/add.md +++ b/user/docker/stacks/add.md @@ -83,7 +83,7 @@ env_file: Note the compose file is not changed when environment variables are used - this allows variables to be updated within Portainer without editing the compose file itself which would take it out of sync with your local copy. You will still see the `${MY_ENVIRONMENT_VARIABLE}` style entry in the compose file. {% endhint %} -
+
When you're ready click **Deploy the stack**. diff --git a/user/docker/swarm/setup.md b/user/docker/swarm/setup.md index 9af6988c..e8d49418 100644 --- a/user/docker/swarm/setup.md +++ b/user/docker/swarm/setup.md @@ -29,7 +29,7 @@ This setting allows you to specify a window within which [automatic updates](../ If this setting is enabled and an update is made to an application outside of this window, it will not be applied. {% endhint %} -
+
## Docker Security Settings diff --git a/user/docker/templates/custom.md b/user/docker/templates/custom.md index 833780d5..4a11673a 100644 --- a/user/docker/templates/custom.md +++ b/user/docker/templates/custom.md @@ -10,7 +10,7 @@ You can also [create a template from an existing deployed stack](../stacks/templ To view a list of custom templates, from the menu select **App Templates** then select **Custom Templates**. -
+
## Creating a new custom template diff --git a/user/kubernetes/applications/detach-volume.md b/user/kubernetes/applications/detach-volume.md index d8fa02f0..9ebd6bec 100644 --- a/user/kubernetes/applications/detach-volume.md +++ b/user/kubernetes/applications/detach-volume.md @@ -2,7 +2,7 @@ From the menu select **Applications**, select the application then click **Edit this application**. -
+
Scroll down to the **Persisting data** section and click the trash can icon to the right of the volume. Scroll down and click **Update application**. When the confirmation message appears, click **Update**. diff --git a/user/kubernetes/applications/edit.md b/user/kubernetes/applications/edit.md index 7303fb68..ac32e7a7 100644 --- a/user/kubernetes/applications/edit.md +++ b/user/kubernetes/applications/edit.md @@ -2,7 +2,7 @@ From the menu select **Applications**, select the application you want to edit, then click **Edit this application**. -
+
Your editing options will depend on how the application was deployed initially. diff --git a/user/kubernetes/namespaces/add.md b/user/kubernetes/namespaces/add.md index faea8816..f9de01bd 100644 --- a/user/kubernetes/namespaces/add.md +++ b/user/kubernetes/namespaces/add.md @@ -6,10 +6,10 @@ From the menu select **Namespaces** then click **Add namespace with form**. Namespaces can also be added [using a manifest](../applications/manifest.md) by clicking **Create from manifest**. {% endhint %} -
+
In the next screen, give the namespace a descriptive name. As an optional step you can assign a quota by toggling **Resource assignment** on, then setting resource limits like how much memory and CPU will be assigned. -
+
When you're finished, click **Create namespace**.