Skip to content

Commit

Permalink
Merge pull request #128 from maxwassiljew/patch-1
Browse files Browse the repository at this point in the history
fixed typos
  • Loading branch information
DO1JLR authored Sep 19, 2024
2 parents 5822976 + ccec890 commit 43a988c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ backups.

This role installs restic on a client, configures the backup repositories
and optionally sets systemd timer or cronjobs to run the backups.
Aditionally, it will setup executable scripts to run a Backup manually.
Additionally, it will set up executable scripts to run a backup manually.

> This Project borrowed heavily from the
> [donat-b/ansible-restic](https://github.com/donat-b/ansible-restic) and
> the [https://github.com/arillso/ansible.restic](https://github.com/arillso/ansible.restic)
> ansible role. We try to make this role more easy to anderstand and modern by using systemd timer,
> ansible role. We try to make this role more easy to understand and modern by using systemd timer,
> /etc/crontab to define backup paths, more absolute paths and less options. (not tested for S3 Storage or Windows...)
### Backup Scripts
Expand Down Expand Up @@ -184,7 +184,7 @@ Available variables:
| `disable_logging` | no | Optionally disable logging |
| `log_to_journald` | no | Optionally switch logging to journald with the name of the backup job as the tag |
| `mail_on_error` | no | Optionally send a mail if the backupjob will fail *(mailx is required)* |
| `mail_address` | if `mail_on_error` is true | The mail addressto recive mails if you enabled ``mail_on_error``. |
| `mail_address` | if `mail_on_error` is true | The mail address to receive mails if you enabled ``mail_on_error``. |
| `monitoring_call` | no | A command that will be called if the backup is *successful*. Useful for heartbeat monitoring systems that warn when no heartbeat is received. Use the full command, you need to run. Example: `curl https://monitoring.example.com/api/push/E9Wzm4lJ2O?status=up&msg=OK&ping=` |
| `niceness` | no | If set, runs any scheduled backup with given [niceness-value](https://en.wikipedia.org/wiki/Nice_(Unix)). On Linux -20 is highest priority, 0 default and 19 is lowest priority. 10 is a common low priority assigned to backup routines on production systems. |

Expand Down Expand Up @@ -218,7 +218,7 @@ restic_backups:

> You can also specify restic_backups as an array, which is a legacy feature and
> might be deprecated in the future. currently, the name key is used for
> namint the access and backup files
> naming the access and backup files

#### Exclude
the `exclude` key on a backup allows you to specify multiple files to exclude or
Expand All @@ -239,7 +239,7 @@ Please refer to the use of the specific keys to the
[documentation](https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files).

## Dependencies
This role does not have any other ansible role as dependencie.
This role does not have any other ansible role as dependency.

## Example Playbook

Expand Down

0 comments on commit 43a988c

Please sign in to comment.