1
0
mirror of https://github.com/moepman/acertmgr.git synced 2024-11-14 17:25:26 +01:00
acertmgr/README.md
2016-04-12 11:49:17 +02:00

60 lines
1.3 KiB
Markdown

ACERTMGR
========
This is an automated certificate manager using ACME/letsencrypt.
Running ACERTMGR
----------------
The main file acertmgr.py is intended to be run regularly (e.g. as daily cron job) as root.
Requirements
------------
* Python (2.7+ and 3.4+ should work)
* PyYAML
* acme\_tiny (`acme_tiny.py` in $PYTHONHOME or $PYTHONPATH or placed next to `acertmgr.py`)
Configuration
-------------
The main configuration is read from `/etc/acme/acme.conf`, domains for which certificates should be obtained/renewed should be configured in `/etc/acme/domains.d/{fqdn}.conf`.
All configuration files use yaml syntax.
* Example global configuration file:
```yaml
---
mode: webdir
#mode: standalone
webdir: /var/www/acme-challenge/
defaults:
format: split
```
* Example domain configuration file:
```yaml
---
mail.example.com:
- user: postfix
group: postfix
perm: '400'
notify: '/etc/init.d/postfix reload'
- user: dovecot
group: dovecot
perm: '400'
notify: '/etc/init.d/dovecot reload'
```
Security
--------
Please keep the following in mind when using this software:
* DO read the source code, since it is intended to be run as root
* Make sure that your configuration files are NOT writable by other users - arbitrary commands can be executed after updating certificates