Skip to content

Commit 0a70662

Browse files
authored
Update README
Document optional parameter
1 parent 9bf0117 commit 0a70662

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This script can run on any machine running Python 3 that has network access to y
77

88
# Usage
99

10-
There are no command-line arguments to deploy-freenas.py; the relevant configuration takes place in the `deploy_config` file. You can create this file either by copying `depoy_config.example` from this repository, or directly using your preferred text editor. Its format is as follows:
10+
The relevant configuration takes place in the `deploy_config` file. You can create this file either by copying `depoy_config.example` from this repository, or directly using your preferred text editor. Its format is as follows:
1111

1212
```
1313
[deploy]
@@ -24,3 +24,9 @@ port = 443
2424
Everything but the password is optional, and the defaults are documented in `depoy_config.example`.
2525

2626
Once you've prepared `deploy_config`, you can run `deploy_freenas.py`. The intended use is that it would be called by your ACME client after issuing a certificate. With acme.sh, for example, you'd add `--deploy-hook "/path/to/deploy_freenas.py"` to your command.
27+
28+
There is an optional paramter, `-c` or `--config`, that lets you specify the path to your configuration file. By default the script will try to use `deploy_config` in the script working directoy:
29+
30+
```
31+
/path/to/deploy_freenas.py --config /somewhere/else/deploy_config
32+
```

0 commit comments

Comments
 (0)