aboutsummaryrefslogtreecommitdiffstats
path: root/roles/archive_server
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-09 19:04:35 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-09 19:04:35 -0500
commit9b42b19cd4b702a76df33acf7563b2dfae693d5a (patch)
tree109a93cabda5ba90d26a35173b316d5295e6d608 /roles/archive_server
parentfd619467df107bd487ce6e8da441c4846cedab56 (diff)
downloadselfhosted-9b42b19cd4b702a76df33acf7563b2dfae693d5a.tar.gz
selfhosted-9b42b19cd4b702a76df33acf7563b2dfae693d5a.zip
update documentation
Diffstat (limited to 'roles/archive_server')
-rw-r--r--roles/archive_server/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/roles/archive_server/README.md b/roles/archive_server/README.md
index 0baae12..8582def 100644
--- a/roles/archive_server/README.md
+++ b/roles/archive_server/README.md
@@ -25,12 +25,16 @@ executable file in the [plugin directory](files/usr/local/libexec/archiver/)
that takes a target hostname as the first argument (you can also pass additional
arguments if needed).
+Plugin scripts are `chdir`ed to the destination directory prior to execution,
+so it's safe for them to simply write files to the current working directory.
+
Each line in the archiver [config file](templates/etc/archiver.conf.j2) specifies
a host to archive, along with a plugin invocation.
Currently, plugins are used to archive [OPNsense](files/usr/local/libexec/archiver/archive_opnsense)
and [EdgeSwitch](files/usr/local/libexec/archiver/archive_edgeswitch) configurations.
+
Variables
---------