Raphaël G. Git Repositories - acme/blob - acme-cron.1

   1 .\" Manpage for acme cron.
   2 .\" Contact acme@rapsys.eu to correct errors or typos.
   3 .TH man 1 "19 Apr 2020" "2\&.0\&.0" "acme-cron man page"
   4 .SH "NAME"
   5 acme-cron \- the acme cron job
   6
   7 .SH "SYNOPSIS"
   8 \fIacme\fR cron [\-(v|\-verbose)] [\-(c|\-config)[=/etc/acme/config]] [example.com] [\&.\&.\&.]
   9
  10 .SH "DESCRIPTION"
  11 Acme cert is a fast and simple certificate regenerator cron job\&.
  12
  13 .sp
  14 See \fBacme-conf\fR(1) to configure your certificate and loot at \fBacme-cert\fR(1) to generate your certificate\&.
  15
  16 .SH "DOCUMENTATION"
  17 A formated and hyperlinked copy of the lastest ACME v2 API documentation can be viewed at \fBhttps://ietf-wg-acme\&.github\&.io/acme/draft-ietf-acme-acme\&.html\fR\&.
  18
  19 .sp
  20 This Acme implementation can be used for Let's Encrypt free, automated and open certificate authority, their documentation can be viewed at \fBhttps://letsencrypt\&.org/docs/\fR\&.
  21
  22 .SH "OPTIONS"
  23 .PP
  24 \-\-verbose
  25 .RS 4
  26 Produces a verbose report about the current process for the purpose of problem analysis\&.
  27 .RE
  28 .PP
  29 \-\-config
  30 .RS 4
  31 Use the specified configuration file\&. If the pathname is omitted, the file specified in Acme::CONFIG constant (normally /etc/acme/config) is assumed\&.
  32 .RE
  33 .PP
  34
  35 .SH "ARGUMENTS"
  36 .PP
  37 \fBexample.com\fR
  38 .RS 4
  39 Will regenerate the certificate when older than 60 days for the domain as common name and the associated domains as subject alt names\&.
  40 .RE
  41 .PP
  42 without argument
  43 .RS 4
  44 Will generate the certificate when older than 60 days for all domain and associated domains declared in the configuration file.
  45 .RE
  46
  47 .SH "CRONJOBS"
  48
  49 .SS "CRON\&.DAILY SCRIPT"
  50 You may add a daily cron by creating /etc/cron\&.daily/acme file with the content:
  51 .nf
  52         #! /bin/sh
  53         acme cron
  54 .fi
  55
  56 .sp
  57 Don't forget to set the executable flag:
  58 .nf
  59         # chmod a+x /etc/cron\&.daily/acme
  60 .fi
  61
  62 .SS "CRONTAB FRAGMENT"
  63 You may add a crontab fragment by creating /etc/cron\&.d/acme file with the content:
  64 .nf
  65         #! /bin/sh
  66         0 0 * * *       \fBusername\fR  acme cron
  67 .fi
  68
  69 .sp
  70 Don't forget to replace \fBusername\fR with desired user identifier\&.
  71
  72 .SS "USER CRONTAB"
  73 You may add a daily cron by running the following command :
  74 .nf
  75         $ crontab -e
  76 .fi
  77
  78 .sp
  79 With the following content:
  80 .nf
  81         #! /bin/sh
  82         0 0 * * *       acme cron
  83 .fi
  84
  85 .SH "CONTRIBUTE"
  86 You may buy me a Beer, a Tea or help with Server fees with a paypal donation to the address \m[blue]\fBpaypal@rapsys\&.eu\fR\m[] or via the donation page.
  87
  88 Don't forget to show your love for this project, feel free to report bugs to the author, issues which are security relevant should be disclosed privately first\&.
  89
  90 Patches are welcomed and grant credit when requested\&.
  91
  92 .SH "FURTHER DOCUMENTATION"
  93 A formated and hyperlinked copy of the lastest ACME v2 API documentation can be viewed at \fBhttps://ietf-wg-acme\&.github\&.io/acme/draft-ietf-acme-acme\&.html\fR\&.
  94
  95 .sp
  96 This Acme implementation can be used for Let's Encrypt free, automated and open certificate authority, their documentation can be viewed at \fBhttps://letsencrypt\&.org/docs/\fR\&.
  97
  98 .SH "AUTHOR"
  99 Raphaël Gertz (Rapsys) <acme@rapsys\&.eu>
 100
 101 .SH "BUGS"
 102 No known bugs.
 103
 104 .SH "SEE ALSO"
 105 \fBacme\fR(1), \fBacme-conf\fR(1), \fBacme-cert\fR(1)
 106
 107 .SH "ACME"
 108 Part of the \fBacme\fR(1) suite