mention templates

This commit is contained in:
AJ ONeal 2016-08-05 04:13:58 -04:00
parent 9c27ef2876
commit 0ab67f733d
1 changed files with 9 additions and 0 deletions

View File

@ -208,6 +208,15 @@ We do expose a few helper functions:
TODO fetch domain tld list
### Template Strings
The following variables will be tempalted in any strings passed to the options object:
* `~/` replaced with `os.homedir()` i.e. `/Users/aj`
* `:hostname` replaced with the domain i.e. `example.com`
* `:config` replaced with `configDir` i.e. `~/letsencrypt/etc`
* `:server` replaced with the hostname + pathname of the acme server api
Developer API
-------------