Skip to content

Commit ecbaa73

Browse files
author
Oliver Cervera
authored
Update README.md
Small tweaks
1 parent 8c97d14 commit ecbaa73

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Contributions are welcome!
2020
- [Requirements](#requirements)
2121
- [Installation](#installation)
2222
* [First Run](#first-run)
23-
* [OMV and SnapRAID plugin](#omv6-and-snapraid-plugin)
23+
* [OMV and SnapRAID plugin](#omv-and-snapraid-plugin)
2424
* [Installing `hd-idle`](#installing-hd-idle-for-automatic-disk-spindown)
2525
- [Upgrade](#upgrade)
2626
- [Known Issues](#known-issues)
@@ -36,13 +36,13 @@ Contributions are welcome!
3636
- Instead of forcing a sync based on the number of deleted files, you may consider the `ADD_DEL_THRESHOLD` feature, by allowing a sync that would otherwise violate the delete threshold, if the ratio of added to deleted files is greater than the value set.
3737
- If parity info is out of sync **but** the number of deleted or changed files did not exceed the threshold, it **executes a sync** to update the parity info.
3838
- When the parity info is in sync, either because nothing has changed or after a successfully sync, it runs the `snapraid scrub` command to validate the integrity of the data, both the files and the parity info. If sync was cancelled or other issues were found, scrub will not be run.
39-
- Note that each run of the scrub command will validate only a configurable portion of parity info to avoid having a long running job and affecting the performance of the server.
39+
- Note that each run of the scrub command will validate only a (configurable) portion of parity info to avoid having a long running job and affecting the performance of the server.
4040
- Scrub frequency can also be customized in case you don't want to do it every time the script runs.
4141
- It is still recommended to run scrub frequently.
4242
- Extra information can be added, like SnapRAID's disk health report or SnapRAID array status.
4343
- When the script is done sends an email with the results, both in case of error or success, and triggers any 3rd party notifications configured.
4444

45-
### Additional Information
45+
### Additional Features
4646
- Docker container management
4747
- Manage containers before SnapRAID operations and restore them when finished. It avoids nasty errors aboud data being written during SnapRAID sync.
4848
- Support for local and remote Docker instances. Also manage multiple remote Docker instances at once.
@@ -65,7 +65,7 @@ If you don't know what to do, I recommend using the default values and see how i
6565

6666
### Customizable features
6767
- Sync options
68-
- Sync always (forced sync).
68+
- Sync always (Forced Sync).
6969
- Sync after a number of breached threshold warnings.
7070
- Sync only if thresholds warnings are not breached (enabled by default).
7171
- Sync even if the delete threshold has been breached, but the ratio of added to deleted files is greater than the value set.

0 commit comments

Comments
 (0)