Browse Source

Merge pull request #41 from chmodas/minor-documentation-fixes

Minor documentation fixes
pull/42/head
Rodolphe Bréard 4 years ago
committed by GitHub
parent
commit
f3838532b6
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 12
      README.md
  2. 6
      man/en/acmed.toml.5

12
README.md

@ -64,17 +64,17 @@ For exhaustive references, the following man pages are available:
An easy way to read those pages without installing ACMEd is to downloads and pipe them to the man utility: An easy way to read those pages without installing ACMEd is to downloads and pipe them to the man utility:
``` ```
curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/master/man/en/acmed.8" | man -l -
curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/master/man/en/acmed.toml.5" | man -l -
curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/master/man/en/tacd.8" | man -l -
curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/acmed.8" | man -l -
curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/acmed.toml.5" | man -l -
curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/tacd.8" | man -l -
``` ```
Alternatively, using zsh, you can use the following variants. Useful on system where man is unable to read from stdin (yes BSD, that's you). Alternatively, using zsh, you can use the following variants. Useful on system where man is unable to read from stdin (yes BSD, that's you).
``` ```
man =(curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/master/man/en/acmed.8")
man =(curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/master/man/en/acmed.toml.5")
man =(curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/master/man/en/tacd.8")
man =(curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/acmed.8")
man =(curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/acmed.toml.5")
man =(curl -sSf "https://raw.githubusercontent.com/breard-r/acmed/main/man/en/tacd.8")
``` ```

6
man/en/acmed.toml.5

@ -694,7 +694,9 @@ tos_agreed = true
[[account]] [[account]]
name = "my test account" name = "my test account"
email = "certs@exemple.net"
contacts = [
{ mailto = "certs@exemple.net" }
]
[[certificate]] [[certificate]]
endpoint = "example name" endpoint = "example name"
@ -776,7 +778,7 @@ env.HTTP_ROOT = "/srv/http"
.Pp .Pp
It is also possible to use It is also possible to use
.Xr sendmail 8 .Xr sendmail 8
in a hook in order to notif someone when the certificate request process is done.
in a hook in order to notify someone when the certificate request process is done.
.Bd -literal -offset indent .Bd -literal -offset indent
[[hook]] [[hook]]
name = "email-report" name = "email-report"

Loading…
Cancel
Save