Add manpages for pebble, pebble-challtestsrv (#332)
These documents can be viewed with (for example) `man -M pebble/docs pebble`, or the whole docs directory can be added to `manpath` for ease of use.
This commit is contained in:
parent
abe2768b4c
commit
81e322f7a0
|
|
@ -0,0 +1,50 @@
|
|||
.TH PEBBLE-CHALLTESTSRV 1
|
||||
.SH NAME
|
||||
pebble\-challtestsrv \- ACME challenge mock server
|
||||
.SH SYNOPSIS
|
||||
.B pebble
|
||||
[\fB\-defaultIPv4\fR \fIstring\fR]
|
||||
[\fB\-defaultIPv6\fR \fIstring\fR]
|
||||
[\fB\-dns01\fR \fIstring\fR]
|
||||
[\fB\-http01\fR \fIstring\fR]
|
||||
[\fB\-https01\fR \fIstring\fR]
|
||||
[\fB\-management\fR \fIstring\fR]
|
||||
[\fB\-tlsalpn01\fR \fIstring\fR]
|
||||
.SH DESCRIPTION
|
||||
.B pebble-challtestsrv
|
||||
is a utility that responds to HTTP-01,
|
||||
DNS-01, and TLS-ALPN-01 ACME challenges. It can also be used as a
|
||||
mock DNS server letting developers mock `A`, `AAAA`, `CNAME`, and
|
||||
`CAA` DNS data for specific hostnames.
|
||||
.PP
|
||||
Important note: The `pebble-challtestsrv` utility is for TEST USAGE
|
||||
ONLY. It is trivially insecure, offering no authentication
|
||||
whatsoever. Only use this library in a controlled test environment.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR \-defaultIPv4\ \fIstring\fR
|
||||
Default IPv4 address for mock DNS responses to A queries (default
|
||||
"127.0.0.1")
|
||||
.TP
|
||||
.BR \-defaultIPv6\ \fIstring\fR
|
||||
Default IPv6 address for mock DNS responses to AAAA queries (default
|
||||
"::1")
|
||||
.TP
|
||||
.BR \-dns01\ \fIstring\fR
|
||||
Comma separated bind addresses/ports for DNS-01 challenges and fake
|
||||
DNS data. Set empty to disable. (default ":8053")
|
||||
.TP
|
||||
.BR \-http01\ \fIstring\fR
|
||||
Comma separated bind addresses/ports for HTTP-01 challenges. Set empty
|
||||
to disable. (default ":5002")
|
||||
.TP
|
||||
.BR \-https01\ \fIstring\fR
|
||||
Comma separated bind addresses/ports for HTTPS HTTP-01 challenges. Set
|
||||
empty to disable. (default ":5003")
|
||||
.TP
|
||||
.BR \-management\ \fIstring\fR
|
||||
Bind address/port for management HTTP interface (default ":8055")
|
||||
.TP
|
||||
.BR -tlsalpn01\ \fIstring\fR
|
||||
Comma separated bind addresses/ports for TLS-ALPN-01 and HTTPS HTTP-01
|
||||
challenges. Set empty to disable. (default ":5001")
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
.TH PEBBLE 1
|
||||
.SH NAME
|
||||
pebble \- ACME (RFC 8555) test server
|
||||
.SH SYNOPSIS
|
||||
.B pebble
|
||||
[\fB\-config\fR \fIstring\fR]
|
||||
[\fB\-dnsserver\fR \fIstring\fR]
|
||||
[\fB\-strict\fR]
|
||||
.SH DESCRIPTION
|
||||
.B pebble
|
||||
is a miniature version of Boulder that can assist in the
|
||||
development and testing of ACME clients against the standard without
|
||||
having to setup a full production-capable ACME server.
|
||||
.PP
|
||||
pebble is NOT designed for production use and is for testing only. By
|
||||
design, it will drop all of its state between invocations and will
|
||||
randomize keys and certificates used for issuance!
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR \-config\ \fIstring\fR
|
||||
File path to the Pebble configuration file (default
|
||||
"test/config/pebble-config.json")
|
||||
.TP
|
||||
.BR \-dnsserver\ \fIstring\fR
|
||||
Define a custom DNS server address (ex: 192.168.0.56:5053 or
|
||||
8.8.8.8:53).
|
||||
.TP
|
||||
.BR \-strict
|
||||
Enable strict mode to test upcoming API breaking changes
|
||||
Loading…
Reference in New Issue