Skip to content

Commit d8006d6

Browse files
authored
Update README.md
1 parent cdea0e3 commit d8006d6

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ for automating the process on remote servers.
1010
- [Installation](#installation)
1111
- [Overview](#overview)
1212
- [Getting started](#getting-started)
13+
- [Detailed guide to getting started with more examples](#detailed-guide-to-getting-started-with-more-examples)
1314
- [Wildcard certificates](#wildcard-certificates)
1415
- [Automating updates](#automating-updates)
1516
- [Structure](#structure)
@@ -87,25 +88,27 @@ desktop computer, or even a virtualbox) and add the checks, and
8788
certificates to a remote server ( providing you have a ssh with key,
8889
sftp or ftp access to the remote server).
8990

90-
```getssl
91-
getssl ver. 2.02
91+
```getssl -h
92+
getssl ver. 2.35
9293
Obtain SSL certificates from the letsencrypt.org ACME server
9394
94-
Usage: getssl [-h|--help] [-d|--debug] [-c|--create] [-f|--force] [-a|--all] [-q|--quiet] [-Q|--mute] [-u|--upgrade] [-k|--keep #] [-U|--nocheck] [-r|--revoke cert key] [-w working_dir] domain
95+
Usage: getssl [-h|--help] [-d|--debug] [-c|--create] [-f|--force] [-a|--all] [-q|--quiet] [-Q|--mute] [-u|--upgrade] [-k|--keep #] [-U|--nocheck] [-r|--revoke cert key] [-w working_dir] [--preferred-chain chain] domain
9596
9697
Options:
9798
-a, --all Check all certificates
98-
-d, --debug Outputs debug information
99+
-d, --debug Output debug information
99100
-c, --create Create default config files
100101
-f, --force Force renewal of cert (overrides expiry checks)
101102
-h, --help Display this help message and exit
103+
-i, --install Install certificates and reload service
102104
-q, --quiet Quiet mode (only outputs on error, success of new cert, or getssl was upgraded)
103-
-Q, --mute Like -q, but mutes notification about successful upgrade
105+
-Q, --mute Like -q, but also mute notification about successful upgrade
104106
-r, --revoke "cert" "key" [CA_server] Revoke a certificate (the cert and key are required)
105107
-u, --upgrade Upgrade getssl if a more recent version is available - can be used with or without domain(s)
106-
-k, --keep "#" Maximum amount of old getssl versions to keep when upgrading
108+
-k, --keep "#" Maximum number of old getssl versions to keep when upgrading
107109
-U, --nocheck Do not check if a more recent version is available
108110
-w working_dir "Working directory"
111+
--preferred-chain "chain" Use an alternate chain for the certificate
109112
```
110113

111114
## Getting started
@@ -165,6 +168,10 @@ Change the server in your config file to get a fully valid certificate.
165168
dns. The certificate can be used (and checked with getssl) on alternate
166169
ports.
167170

171+
## Detailed guide to getting started with more examples
172+
173+
[Guide to getting a certificate for example.com and www.example.com](https://github.com/srvrco/getssl/wiki/Guide-to-getting-a-certificate-for-example.com-and-www.example.com)
174+
168175
## Wildcard certificates
169176

170177
`getssl` supports creating wildcard certificates, i.e. _*.example.com_ which allows a single certificate to be used for any domain under *example.com*, e.g. *www.example.com*, *mail.example.com*. These must be validated using the dns-01 method.

0 commit comments

Comments
 (0)