centersl/portainer-docs
1
0
Fork 0
mirror of https://github.com/portainer/portainer-docs.git synced 2026-03-27 12:58:32 +07:00
Code Issues Packages Projects Releases Wiki Activity

GITBOOK-40: Add BE note to new image notification toggle, update screenshots for S3 backup / restore

Browse Source
This commit is contained in:
James Carppe
2023-02-09 00:51:27 +00:00
committed by gitbook-bot
parent b9a18d0a6b
commit 90f24ccebf
5 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
.gitbook/assets/2.17-admin-settings-backup-s3-restore.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 69 KiB

BIN
.gitbook/assets/2.17-admin-settings-backup-s3.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 58 KiB

20
admin/settings/README.md
View File

@@ -125,7 +125,7 @@ Select **Store in S3** and fill in the options, using the below as a guide.
| 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. |
| S3 compatible host | If you are using a non-AWS S3-compatible provider (such as MinIO), enter the hostname here. If you're using AWS S3, leave this blank. |
| 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. |
@@ -149,15 +149,15 @@ This feature is only available in Portainer Business Edition.
Restoring a configuration is only possible on a fresh instance of Portainer during the initial installation. When you need to restore Portainer, deploy a fresh instance of Portainer with an empty data volume and choose the **Restore Portainer from backup** option during setup, making sure to select **Retrieve from S3**. Complete the fields using the table below as a guide.
| Field/Option | Overview |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| 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. |
| S3 Compatible Host | If you are using a non-AWS S3-compatible provider (such as MinIO), enter the hostname 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). |
| Field/Option | Overview |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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. |
| 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). |
<figure><img src="../../.gitbook/assets/2.17-admin-settings-backup-s3-restore.png" alt=""><figcaption></figcaption></figure>

6
user/docker/host/setup.md
View File

@@ -66,6 +66,6 @@ This section contains other assorted environment-specific settings.
<figure><img src="../../../.gitbook/assets/2.16-docker-host-setup-other.png" alt=""><figcaption></figcaption></figure>
| Option | Overview |
| -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| Show a notification to indicate out-of-date images for Docker environments | Toggle on to enable the [new image notification](../containers/) feature for this environment. Toggle off to disable the feature. |
| Option | Overview |
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Show a notification to indicate out-of-date images for Docker environments | <p>Toggle on to enable the <a href="../containers/">new image notification</a> feature for this environment. Toggle off to disable the feature.<br><br>This feature is only available in Portainer Business Edition.</p> |

6
user/docker/swarm/setup.md
View File

@@ -55,6 +55,6 @@ This section contains other assorted environment-specific settings.
<figure><img src="../../../.gitbook/assets/2.16-docker-host-setup-other.png" alt=""><figcaption></figcaption></figure>
| Option | Overview |
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| Show a notification to indicate out-of-date images for Docker environments | Toggle on to enable the [new image notification](../services/) feature for this environment. Toggle off to disable the feature. |
| Option | Overview |
| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Show a notification to indicate out-of-date images for Docker environments | <p>Toggle on to enable the <a href="../services/">new image notification</a> feature for this environment. Toggle off to disable the feature.<br><br>This feature is only available in Portainer Business Edition.</p> |