1CDIST-TYPE__LETSENCRYPT_CERT(7)      cdist     CDIST-TYPE__LETSENCRYPT_CERT(7)
2
3
4

NAME

6       cdist-type__letsencrypt_cert  -  Get  an  SSL  certificate  from  Let's
7       Encrypt
8

DESCRIPTION

10       Automatically obtain a Let's Encrypt SSL certificate using Certbot.
11

REQUIRED PARAMETERS

13       object id
14              A cert name. If domain parameter is not  specified  then  it  is
15              used as a domain to be included in the certificate.
16
17       admin-email
18              Where  to  send  Let's  Encrypt  emails  like "certificate needs
19              renewal".
20

OPTIONAL PARAMETERS

22       state  'present' or 'absent', defaults to 'present' where:
23
24              present
25                     if the certificate does not exist, it will be obtained
26
27              absent the certificate will be removed
28
29       webroot
30              The path to your webroot, as set up in your webserver config. If
31              this parameter is not present, Certbot will be run in standalone
32              mode.
33

OPTIONAL MULTIPLE PARAMETERS

35       renew-hook
36              Renew hook command directly passed to Certbot in cron job.
37
38       domain Domains to be included in the certificate. When  specified  then
39              object id is not used as a domain.
40

BOOLEAN PARAMETERS

42       automatic-renewal
43              Install a cron job, which attempts to renew certificates daily.
44
45       staging
46              Obtain a test certificate from a staging server.
47

MESSAGES

49       change Certificate was changed.
50
51       create Certificate was created.
52
53       remove Certificate was removed.
54

EXAMPLES

56          # use object id as domain
57          __letsencrypt_cert example.com \
58              --admin-email root@example.com \
59              --automatic-renewal \
60              --renew-hook "service nginx reload" \
61              --webroot /data/letsencrypt/root
62
63          # domain parameter is specified so object id is not used as domain
64          # and example.com needs to be included again with domain parameter
65          __letsencrypt_cert example.com \
66              --admin-email root@example.com \
67              --automatic-renewal \
68              --domain example.com \
69              --domain foo.example.com \
70              --domain bar.example.com \
71              --renew-hook "service nginx reload" \
72              --webroot /data/letsencrypt/root
73

AUTHORS

75       Nico Schottelius <nico-cdist--@--schottelius.org>
76       Kamila Součková <kamila--@--ksp.sk>
77       Darko Poljak <darko.poljak--@--gmail.com>
78       Ľubomír Kučera <lubomir.kucera.jr at gmail.com>
79
80

COPYING

82       Copyright (C) 2017-2018 Nico Schottelius, Kamila Součková, Darko Poljak
83       and Ľubomír Kučera. You can redistribute it and/or modify it under  the
84       terms  of the GNU General Public License as published by the Free Soft‐
85       ware Foundation, either version 3 of the License, or (at  your  option)
86       any later version.
87

89       ungleich GmbH 2020
90
91
92
93
946.9.4                            Dec 21, 2020  CDIST-TYPE__LETSENCRYPT_CERT(7)
Impressum