Skip to content

Commit

Permalink
You CAN change the hash_method after the plugin is enabled. Make yo…
Browse files Browse the repository at this point in the history
…ur choice casually
  • Loading branch information
Fallen-Breath committed Dec 11, 2023
1 parent f645fed commit 0bdfd55
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 22 deletions.
7 changes: 0 additions & 7 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,13 +270,6 @@ The algorithm to hash the files. Available options: `"xxh128"`、`"sha256"`、`"
| [`sha256`](https://en.wikipedia.org/wiki/SHA-2) | A cryptographically secure and widely used 256bit hash algorithm. It's slower than xxh128, but the speed could be acceptable with modern hardware | ★★ | :check_mark: |
| [`blake3`](https://github.com/BLAKE3-team/BLAKE3) | A cryptographically secure and speedy 256bit hash algorithm. It's still slower than xxh128, but is faster than sha256 | ★★★ | :check_mark: |

!!! danger

You **CANNOT** change the `hash_method` after the plugin is enabled. Make your choice wisely

If you do want to change the `hash_method`, you need to delete the `prime_backup.db` file and the `blobs` folder in the [storage root](#storage_root),
which will delete all existing backups

!!! note

If you want to use `blake3` as the hash method, you need to install the `blake3` python library manually.
Expand Down
7 changes: 0 additions & 7 deletions docs/config.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,13 +270,6 @@ Prime Backup 除了会保存 `world` 这个符号链接外,还会保存 `foo`
| [`sha256`](https://en.wikipedia.org/wiki/SHA-2) | 一种广泛使用的、密码学安全的 256 位哈希算法。它比 xxh128 慢,但在现代的硬件上可能也不会太慢 | ★★ | :check_mark: |
| [`blake3`](https://github.com/BLAKE3-team/BLAKE3) | 一种高效的、密码学安全的哈希算法。比 sha256 更快,但是依然比 xxh128 慢 | ★★★ | :check_mark: |

!!! danger

你 **不能** 在启用插件后修改 `hash_method`。请明智地做出选择

如果你确实需要修改 `hash_method`,你需要删除 [数据根目录](#storage_root) 路径下的 `prime_backup.db` 文件和 `blobs` 文件夹。
这将删除所有的备份

!!! note

如果你想使用 `blake3` 作为哈希算法,你需要手动安装 `blake3` Python 库。
Expand Down
4 changes: 0 additions & 4 deletions docs/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,6 @@ Here are a few important things in the config file:
- `"plain"`: No compression. Use this if you want the maximum operation speed
- [`"zstd"`](https://github.com/facebook/zstd): Fast and good compression algorithm. Recommend to use you want to save some disk spaces

!!! danger

You **CANNOT** change the `hash_method` after the plugin is enabled. Make your choice wisely

!!! note

If you want to use `blake3` as the hash method, you need to install the `blake3` python library manually.
Expand Down
4 changes: 0 additions & 4 deletions docs/quick_start.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,6 @@ mcdr_root/
- `"plain"`: 无压缩。如果你希望获得最快的操作速度,就用这个
- [`"zstd"`](https://github.com/facebook/zstd): 快速且高效的压缩算法。如果你想节约一些磁盘空间的话,推荐使用

!!! danger

**不能** 在启用插件后修改 `hash_method`。请明智地做出选择

!!! note

如果你想使用 `blake3` 作为哈希算法,你需要手动安装 `blake3` Python 库。
Expand Down

0 comments on commit 0bdfd55

Please sign in to comment.