From 87258f91e9dc0be14886ffdfae09695997cfe703 Mon Sep 17 00:00:00 2001 From: Elliot Saba Date: Wed, 2 May 2018 14:34:23 -0700 Subject: [PATCH] Add usage example to `README.md` --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index da42a0f..0c795ac 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,43 @@ Certbot github: https://github.com/certbot/certbot This repository was originally forked from `@henridwyer`, many thanks to him for the good idea. I've rewritten about 90% of this repository, so it bears almost no resemblance to the original. This repository is _much_ more opinionated about the structure of your webservers/containers, however it is easier to use as long as all of your webservers follow that pattern. +# Usage + +Use this image with a `Dockerfile` such as: +```Dockerfile +FROM staticfloat/nginx-certbot +COPY *.conf /etc/nginx/conf.d/ +``` + +And a `.conf` file such as: +```nginx +server { + listen 443 ssl; + server_name server.company.com; + ssl_certificate /etc/letsencrypt/live/server.company.com/fullchain.pem; + ssl_certificate_key /etc/letsencrypt/live/server.company.com/privkey.pem; + + location / { + ... + } +} +``` + +Wrap this all up with a `docker-compose.yml` file: +```yml +version: '3' +services: + frontend: + restart: unless-stopped + build: frontend + ports: + - 80:80/tcp + - 443:443/tcp + environment: + - CERTBOT_EMAIL=owner@company.com + ... +``` + # Changelog ### 0.8