Skip to content

Commit

Permalink
docs(refactor): document autorestic_config_template
Browse files Browse the repository at this point in the history
  • Loading branch information
dbrennand committed Jul 29, 2024
1 parent 75f85de commit 1f248ed
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Ansible Role: dbrennand.autorestic

[![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)
![Ansible-Lint](https://github.com/dbrennand/ansible-role-autorestic/actions/workflows/ansible-lint.yml/badge.svg)
![Molecule](https://github.com/dbrennand/ansible-role-autorestic/actions/workflows/molecule.yml/badge.svg)
![Ansible-Release](https://github.com/dbrennand/ansible-role-autorestic/actions/workflows/ansible-release.yml/badge.svg)
Expand Down Expand Up @@ -64,6 +63,12 @@ autorestic_config:

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

```yaml
autorestic_config_template: autorestic.yml.j2
```

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.

```yaml
autorestic_config_file: ~/.autorestic.yml
```
Expand Down

0 comments on commit 1f248ed

Please sign in to comment.