From 627d81723ff9a30b0d19d6cdf15b49ec5307d93d Mon Sep 17 00:00:00 2001 From: srvrco Date: Wed, 1 Jun 2016 09:24:57 +0100 Subject: [PATCH] updating readme --- README.md | 41 ++++++++++++++++++++++------------------- 1 file changed, 22 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index f4b0f24..7388359 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,6 @@ # getssl Obtain SSL certificates from the letsencrypt.org ACME server. Suitable for automating the process on remote servers. -This was written in standard bash ( so can be run on a server, a desktop computer, or even virtualbox) and add the checks, and certificates to a remote server ( providing you have an ssh key on the remote server with access). - -``` -getssl ver. 1.00 -Obtain SSL certificates from the letsencrypt.org ACME server - -Usage: getssl [-h|--help] [-d|--debug] [-c|--create] [-f|--force] [-a|--all] [-q|--quiet] [-u|--upgrade] [-w working_dir] domain - -Options: - -h, --help Display this help message and exit - -d, --debug Outputs debug information - -c, --create Create default config files - -f, --force Force renewal of cert (overrides expiry checks) - -a, --all Check all certificates - -q, --quiet Quiet mode (only outputs on error) - -u, --upgrade Upgrade getssl if more recent version available - -w working_dir Working directory -``` - ## Features * **Bash** - It runs on virtually all linux machines. * **Get certificates for remote servers** - The tokens used to provide validation of domain ownership, and the certificates themselves can be automatically copied to remote servers (via ssh, sftp or ftp for tokens). The script doesn't need to run on the server itself. This can be useful if you don't have access to run such scripts on the server itself, as it's a shared server for example. @@ -45,6 +26,28 @@ Alternative you can use git git clone git@github.com:srvrco/getssl.git ``` +## Overview + +GetSSL was written in standard bash ( so can be run on a server, a desktop computer, or even a virtualbox) and add the checks, and certificates to a remote server ( providing you have a ssh with key, sftp or ftp access to the remote server). + +``` +getssl ver. 1.00 +Obtain SSL certificates from the letsencrypt.org ACME server + +Usage: getssl [-h|--help] [-d|--debug] [-c|--create] [-f|--force] [-a|--all] [-q|--quiet] [-u|--upgrade] [-w working_dir] domain + +Options: + -h, --help Display this help message and exit + -d, --debug Outputs debug information + -c, --create Create default config files + -f, --force Force renewal of cert (overrides expiry checks) + -a, --all Check all certificates + -q, --quiet Quiet mode (only outputs on error) + -u, --upgrade Upgrade getssl if more recent version available + -w working_dir Working directory +``` + + ## Structure The design aim was to provide flexibility in running the code. The default working directory is ~/.getssl ( which can be modified via the command line)