Skip to content

Commit

Permalink
Cleanup README
Browse files Browse the repository at this point in the history
  • Loading branch information
hlandau committed Dec 6, 2015
1 parent 91e68bc commit cadc305
Showing 1 changed file with 2 additions and 41 deletions.
43 changes: 2 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,6 @@ $ sudo acmetool want example.com www.example.com
$ ls -l /var/lib/acme/live/example.com/
```

<!-- # Renew certificates automatically:
# Change '42' to a random integer in [0,59] to distribute the load on the server.
$ sudo /bin/sh -c "echo '42 0 * * * root /usr/local/bin/acmetool -batch' > /etc/cron.d/acmetool" -->

The `quickstart` subcommand is a recommended wizard which guides you through the
setup of ACME on your system.

Expand All @@ -83,43 +79,8 @@ hostnames are satisfied by valid certificates which aren't soon to expire.
If you run `acmetool reconcile` on a cronjob to facilitate automatic renewal,
pass `--batch` to ensure it doesn't attempt to interact with a terminal.

<!--
## Introduction
- A command line tool for acquiring certificates using a certificate storage
repository to automatically determine what certificates need to be requested.
- Acquiring a certificate is as simple as this:
`# acmetool want example.com`
If successfully acquired, the certificate will be placed in
`/var/lib/acme/live/example.com/{cert,chain,fullchain,privkey}`.
Running `acmetool -``-batch` as root on a cronjob will allow it to
automatically reacquire certificates before they expire. The certificate data
in `/var/lib/acme/live/example.com` will be updated automatically with the
new certificate. acmetool can optionally invoke a shell script after having
changed certificates if you need to reload a webserver.
- Works with Let's Encrypt.
- acmetool is designed to work like `make`. A filesystem-based certificate
repository expresses target domain names, and whenever acmetool is invoked,
it ensures that valid certificates are available to meet those names.
Certificates which will expire soon are renewed. The certificate matching
each target is symlinked into `/var/lib/acme/live/DOMAIN`, so the right
certificate for a given domain is always at `/var/lib/acme/live/DOMAIN`.
acmetool is thus idempotent and it minimises the use of state. All state is
explicitly kept in the certificate repository. There are essentially no
proprietary file formats or configuration or state files; only a repository
of certificates, a repository of ACME account keys and a set of targets. On
each invocation, ACME figures out which certificates satisfy which targets
and obtains certificates as necessary.
[Details on the state directory format.](https://github.com/hlandau/acme/blob/master/_doc/SCHEMA.md)
-->
You can increase logging severity for debugging purposes by passing
`--xlog.severity=debug`.

## Validation Options

Expand Down

0 comments on commit cadc305

Please sign in to comment.