diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts index a51e480f..9473148c 100644 --- a/docs/.vitepress/en.ts +++ b/docs/.vitepress/en.ts @@ -234,9 +234,13 @@ const side = { text: "Customize appearance", link:"/manual/olares/settings/language-appearance", }, - { - text: "Backup and restore", - }, + { + text: "Backup and Restore", + items: [ + {text: "Backup", link: "/manual/olares/settings/backup"}, + {text: "Restore", link: "/manual/olares/settings/restore"}, + ], + }, { text: "Configure network", collapsed: true, diff --git a/docs/.vitepress/zh.ts b/docs/.vitepress/zh.ts index 08350564..50f19c9a 100644 --- a/docs/.vitepress/zh.ts +++ b/docs/.vitepress/zh.ts @@ -236,7 +236,11 @@ const side = { "link": "/zh/manual/olares/settings/language-appearance" }, { - "text": "备份和恢复" + text: "备份与恢复", + items: [ + {text: "备份", link: "/zh/manual/olares/settings/backup"}, + {text: "恢复", link: "/zh/manual/olares/settings/restore"}, + ], }, { "text": "配置网络", diff --git a/docs/manual/olares/settings/backup.md b/docs/manual/olares/settings/backup.md new file mode 100644 index 00000000..23062cbb --- /dev/null +++ b/docs/manual/olares/settings/backup.md @@ -0,0 +1,63 @@ +--- +description: Learn how to create and manage backups for your important files and apps on Olares. +--- +# Backup your data in Olares + +Olares' backup feature lets you create full and incremental backups for specified file directories and the Wise application. You can choose to back up your data on both local and network storages, with options to set up automatic backup schedules. + +## Add a backup task + +To add a backup task: + +1. Go to **Settings › Backup**, and click **Add backup task**. +2. Choose **Backup files** or **Backup applications**. +3. On the **Add backup task** page, configure the following options: + + | Option | Description | + |:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | **Backup location** | - **Local path**: Recommended to select an external
device such as a USB drive, SMB share, or external
hard drive.
- **Cloud storage**: Supports Olares Space, AWS S3, and
Tencent COS. Accounts can be added via **Settings ›
Integrations** or directly in the dialog by clicking
**Add account**. | + | **Region** (for network storage) | Choose the region for the selected storage service. | + | **Backup path** (for file backups) | Specify the directory to back up. | + | **Select application** (for app backups) | Choose the application to back up from the dropdown.
Currently, only **Wise** is supported. | + | **Backup name** | Enter a recognizable task name. Recommended to
include the purpose and timestamp. | + + :::warning + Ensure the selected storage has enough available space to store the backup data. + ::: + +3. Set backup schedule & security: + - **Snapshot frequency** – Choose from daily / weekly / monthly + - **Snapshot time** – Set the time when the backup task should run + - **Backup password** – Protect your snapshots with a password + +4. Click **Submit** to start the backup task. The first execution will perform a **full backup**. Subsequent runs will perform **incremental backups**. + + :::warning + Before starting the backup, please make sure: + + - The selected storage has enough available space to store the backup data; + - You have an active subscription for the selected cloud storage service; + - You have read and write permissions for the target storage location, for example, an SMB directory. + + +## Manage backup tasks + +Once created, your backup task will appear in the task list. Click the **>** button on the right to open the detail page. Available actions include: + +| Action | Description | +|:-----------------|:--------------------------------------------------------------------------------------------------------------------------| +| **Manage** | - **Edit**: Modify the snapshot frequency and backup time
- **Pause**: Pause the backup task
- **Delete**: Remove the task and all associated snapshots +| **Snapshot now** | Manually trigger a backup immediately | + + +## View snapshot records + +At the bottom of the backup management page, you’ll see a list of snapshots for the backup task, with snapshot information such as: + +- **Creation time**: The execution time of the snapshot. +- **Size**: Size of the snapshot. +- **Status**: The execution status of the snapshot. +- **Backup type**: The snapshot is a full backup or an incremental backup. + + + diff --git a/docs/manual/olares/settings/restore.md b/docs/manual/olares/settings/restore.md new file mode 100644 index 00000000..e2d94e4b --- /dev/null +++ b/docs/manual/olares/settings/restore.md @@ -0,0 +1,62 @@ +--- +description: Restore files to a specific directory or recover application data using backup snapshots. Learn how to restore data from local paths, Olares Space, or AWS S3. +--- + +# Restore backup data + +You can use existing backup snapshots to restore files to a specified directory or recover application data. This guide covers how to restore data from local storage, Olares Space, and AWS S3. + +## Add a restore task + +To add a restore task: + +1. Go to **Settings** › **Restore**, then click **Add restore**. +2. Choose a restore method based on your backup location: + + + + + + + +::: tip +If you are restoring from Tencent COS, follow the steps for AWS S3. Refer to [Tencent Cloud documentation](https://cloud.tencent.com/document/product/436/68284) for instructions on how to get the pre-signed URL for your backup files. +::: + +## View restore tasks + +Once created, your restore task will appear in the task list on the Restore page. Click the **›** button on the right to view the task details. Available actions are: + + +- **Cancel restore task** – Click **Cancel** to interrupt and stop the restore process. +- **View files or app** – Once completed, click **Open App** or **Open Folder** to access the restored data. diff --git a/docs/zh/manual/olares/settings/backup.md b/docs/zh/manual/olares/settings/backup.md new file mode 100644 index 00000000..181c04b6 --- /dev/null +++ b/docs/zh/manual/olares/settings/backup.md @@ -0,0 +1,60 @@ +--- +description: 了解如何在 Olares 中创建、管理备份任务。本文档介绍文件与应用(如 Wise)的全量与增量备份,支持本地、外部和云存储方案。 +--- + +# 备份 Olares 数据 + +Olares 提供灵活的备份方案,可对**指定文件夹**与 **Wise 应用** 执行全量和增量备份,并支持设置自动备份计划,以确保您的数据安全。 + +## 添加备份任务 + +添加备份任务步骤如下: + +1. 进入**设置** › **备份**,点击**添加备份**。 +2. 选择**备份文件** 或**备份应用**。 +3. 在**添加备份任务**页面,配置备份基础信息如下: + + | 配置项 | 说明 | + |:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------| + | **备份位置** | - **本地路径**:建议选择外接设备,例如 U 盘、SMB 网络目录或外部硬盘。
- **网络存储**:支持 Olares Space、AWS S3、腾讯云 COS。可通过**设置 ›
集成**添加账户,或在弹窗中点击**添加账户**直接添加。 | + | **Region**(仅限 Olares Space 存储) | 如果备份位置是 Olares Space,系统会自动选择对应的存储区域。 | + | **备份路径**(备份文件时显示) | 指定要备份的文件夹路径。 | + | **选择应用**(备份应用时显示) | 从下拉菜单中选择需要备份的应用,目前仅支持 Wise。 | + | **备份名称** | 输入便于识别的任务名称,建议包含用途及时间戳。 | + + + :::warning 注意 + 请在开始备份前确保以下事项: + + - 所选存储空间的可用容量足以存储该任务的备份数据。 + - 已成功订阅对应存储服务且账户处于正常状态。 + - 对目标存储路径拥有读写权限(例如挂载的 SMB 网络目录等)。 + ::: + +4. 设置备份计划与安全项目: + - **快照频率**:选择备份执行的频率,支持按**日/周/月**备份。 + - **快照时间**:指定具体运行时间。 + - **备份密码**:为备份文件加密,保护隐私。 +5. 点击 **提交**。系统首次将执行全量备份,后续按计划进行增量备份。 + + :::warning 注意 + 备份过程中请勿关闭主机或重启备份服务。 + ::: + +## 管理备份任务 + +创建成功后,备份任务将显示在备份首页。点击任务右侧 **>** 操作按钮可进入详情页进行管理: + +| 操作 | 说明 | +|:-------|:--------------------------------------------------------------------| +| **管理** | - **编辑**:修改快照频率与执行时间
- **暂停**:暂停执行备份任务
- **删除**:删除任务及其所有快照 | +| **立即快照** | 立刻手动执行一次备份 + +## 查看快照 + +在任务详情页底部,查看每次快照的**时间**与**状态**。点击右侧 **>** 操作按钮,可查看以下快照详情信息。 + +- **创建时间**:该快照的执行时间。 +- **大小**:快照占用空间大小。 +- **状态**:快照执行状态。 +- **备份类型**:显示该快照是全量备份还是增量备份。 \ No newline at end of file diff --git a/docs/zh/manual/olares/settings/restore.md b/docs/zh/manual/olares/settings/restore.md new file mode 100644 index 00000000..359f223a --- /dev/null +++ b/docs/zh/manual/olares/settings/restore.md @@ -0,0 +1,60 @@ +--- +description: 通过已有的备份快照将文件恢复至指定目录,或恢复应用数据。文档介绍如何从本地、Olares Space 或 Tencent COS 等位置执行数据还原操作。 +--- + +# 恢复数据 + +你可以通过已有的备份快照,将文件恢复至指定目录,或恢复应用数据。本文档将介绍如何从本地、Olares Space 或 Tencent COS 等位置执行数据恢复操作。 + +## 添加恢复任务 + +添加恢复任务步骤如下: + +1. 进入**设置** › **还原**,点击**添加恢复**。 +2. 根据备份存储位置选择恢复方式。 + + + + + + + +::: tip 提示 +如需从 AWS S3 恢复,请参照 Tencent COS 的操作步骤。可参考 [AWS 文档](https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html)获取预签名链接的操作方法。 +::: + +## 查看还原任务 + +还原任务创建成功后将显示在还原页面的任务列表中。点击右侧 **>** 按钮进入可查看详细状态。 + +可执行的操作包括: + +- **取消还原任务**:在还原过程中点击**取消**,以中断并取消还原任务。 +- **查看文件或应用**:还原完成后,可直接点击**打开应用** 或**打开文件夹**。