Skip to content

Commit 1f248ed

Browse files
committed
docs(refactor): document autorestic_config_template
1 parent 75f85de commit 1f248ed

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Ansible Role: dbrennand.autorestic
22

3-
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/dbrennand/ansible-role-autorestic)
43
![Ansible-Lint](https://github.com/dbrennand/ansible-role-autorestic/actions/workflows/ansible-lint.yml/badge.svg)
54
![Molecule](https://github.com/dbrennand/ansible-role-autorestic/actions/workflows/molecule.yml/badge.svg)
65
![Ansible-Release](https://github.com/dbrennand/ansible-role-autorestic/actions/workflows/ansible-release.yml/badge.svg)
@@ -64,6 +63,12 @@ autorestic_config:
6463

6564
See the [autorestic documentation](https://autorestic.vercel.app/config) for details on the YAML configuration.
6665

66+
```yaml
67+
autorestic_config_template: autorestic.yml.j2
68+
```
69+
70+
The [`autorestic.yml.j2`](templates/autorestic.yml.j2) template to use for the autorestic YAML configuration. By default the content of `autorestic_config` is templated. This can be overridden to use a custom template. See [#14](https://github.com/dbrennand/ansible-role-autorestic/issues/14#issuecomment-2198394106) for an example.
71+
6772
```yaml
6873
autorestic_config_file: ~/.autorestic.yml
6974
```

0 commit comments

Comments
 (0)