diff --git a/.gitbook/assets/restore-from-backup.png b/.gitbook/assets/restore-from-backup.png new file mode 100644 index 00000000..90754061 Binary files /dev/null and b/.gitbook/assets/restore-from-backup.png differ diff --git a/.gitbook/assets/take-a-backup.png b/.gitbook/assets/take-a-backup.png new file mode 100644 index 00000000..44cd38a5 Binary files /dev/null and b/.gitbook/assets/take-a-backup.png differ diff --git a/admin/environments/add/docker/edge-async.md b/admin/environments/add/docker/edge-async.md index 12f8fd68..f6c94703 100644 --- a/admin/environments/add/docker/edge-async.md +++ b/admin/environments/add/docker/edge-async.md @@ -41,7 +41,7 @@ Select **Docker Standalone** then click **Start Wizard**. Then select the **Edge | 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. | -
+
As an optional step you can expand the **More settings** section and adjust the **Ping**, **Snapshot** and **Command** intervals for the environment - this defines how often this Edge Agent will check in with the Portainer Server for status updates, snapshot updates and to see if there are new pending commands to run, respectively. The default for each is once a minute, but the defaults can be adjusted in the [Edge Compute settings](../../../settings/edge.md#async-check-in-intervals). diff --git a/admin/environments/add/podman/edge-async.md b/admin/environments/add/podman/edge-async.md index 30abae37..f5170ced 100644 --- a/admin/environments/add/podman/edge-async.md +++ b/admin/environments/add/podman/edge-async.md @@ -41,7 +41,7 @@ Select **Podman** then click **Start Wizard**. Then select the **Edge Agent Asyn | 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. | -
+
As an optional step you can expand the **More settings** section and adjust the **Ping**, **Snapshot** and **Command** intervals for the environment - this defines how often this Edge Agent will check in with the Portainer Server for status updates, snapshot updates and to see if there are new pending commands to run, respectively. The default for each is once a minute, but the defaults can be adjusted in the [Edge Compute settings](../../../settings/edge.md#async-check-in-intervals). diff --git a/admin/settings/general.md b/admin/settings/general.md index fd78ae9a..53bb82f0 100644 --- a/admin/settings/general.md +++ b/admin/settings/general.md @@ -164,12 +164,12 @@ Select **Store in S3** and fill in the options, using the below as a guide. | Access Key ID | Enter the access key ID for your S3 bucket. | | Secret Access Key | Enter the secret key for your S3 bucket. | | Region | Enter the region where your bucket is located (for example, `us-west-1`). | -| Bucket name | Enter the name of your S3 bucket. | +| Bucket name |

Enter the name of your S3 bucket.
Note that if you include a folder path in the Bucket name field, the prefix must end with a trailing slash.

| | S3 compatible host | If you are using a non-AWS S3-compatible provider (such as MinIO), enter the URL (including the protocol and port if necessary) here. If you're using AWS S3, leave this blank. | | Password protect | Enable this to protect your backups with a password. | | Password | Enter the password to set on your backups. | -
+
### Restoring from a local file @@ -194,12 +194,12 @@ Restoring a configuration is only possible on a fresh instance of Portainer duri | Access key ID | Enter the access key ID for your S3 bucket. | | Secret access key | Enter the secret key for your S3 bucket. | | Region | Enter the region where your bucket is located (for example, `us-west-1`). | -| Bucket name | Enter the name of your S3 bucket. | +| Bucket name |

Enter the name of your S3 bucket.
Note that if you include a folder path in the Bucket name field, the prefix must end with a trailing slash.

| | S3 Compatible Host | If you are using a non-AWS S3-compatible provider (such as MinIO), enter the URL (including the protocol and port if necessary) here. If you're using AWS S3, leave this blank. | | Filename | Enter the filename of the backup you want to restore. | | Password | Enter the password set on your backup (if any). | -
+
When you're ready, click **Restore Portainer**. The restore might take a few moments. When it has finished, you will be redirected to the login page. You can now log in with your previous credentials and your previous configuration will be restored. diff --git a/user/account-settings.md b/user/account-settings.md index 0d4ca595..08f0e850 100644 --- a/user/account-settings.md +++ b/user/account-settings.md @@ -59,7 +59,7 @@ To add a new credential, click the **Add git credential** button and fill out th | Username | Enter the username, if relevant. | | Personal Access Token | Enter the personal access token. | -
+
Once you've entered the relevant details, click **Save git credential** to save the entry. diff --git a/user/docker/images/pull.md b/user/docker/images/pull.md index 2b7ad66a..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/configure.md b/user/docker/services/configure.md index e500dc29..b54ef44f 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/edit.md b/user/docker/stacks/edit.md index ec282f6a..29b14658 100644 --- a/user/docker/stacks/edit.md +++ b/user/docker/stacks/edit.md @@ -78,7 +78,7 @@ You can also toggle the stack [webhook](webhooks.md) and retrieve the webhook UR You can choose to **Prune services** if you have made changes that remove some services from the stack. -
+
When you have finished making changes, click **Update the stack**.