diff --git a/README.md b/README.md index 35dd8a4..37857e7 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,44 @@ Tested with debian 9 and ubuntu 16.04. -## example usage +## requirements -``` -certbot certonly --dry-run --manual --preferred-challenges=dns --manual-auth-hook [path to this repositry]/certbot-dns-auth.py -d example.com -``` - -A file `conf.cfg` with inwx settings must e exist like: +A file `conf.cfg` with inwx settings must e exist in the repository root folder like: ``` [live] url = https://api.domrobot.com/xmlrpc/ username = [USERNAME] password = [PASSWORD] +shared_secret = your_shared_secret +``` + +## example usage + +### command line + +``` +certbot certonly --manual --server https://acme-v02.api.letsencrypt.org/directory --preferred-challenges=dns --manual-auth-hook [path to this repositry]/certbot-dns-auth.py --manual-cleanup-hook [path to this repositry]/certbot-dns-clean.py -d example.com -d *.example.com +``` + +### with config file + +`wildcard-ini`: + +``` +email = [YOUR@EMAIL.com] +cert-name = [USERNAME] +rsa-key-size = 4096 + +server = https://acme-v02.api.letsencrypt.org/directory +authenticator = manual +manual-auth-hook = [path to this repositry]/certbot-dns-auth.py +manual-cleanup-hook = [path to this repositry]/certbot-dns-clean.py + +domains = example.com, *.example.com +``` + +Command: + +``` +certbot certonly -c wildcard-ini ```