diff --git a/README.md b/README.md new file mode 100644 index 0000000..8f8f72d --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +## Generate Free SSL Certificates + +This docker container generates free SSL certificates using Letsencrypt using Cloudlfare DNS Plugin + + +# How to use +1. Copy ` .env.example` to `.env` and fill it. \ + CLOUDFLARE_EMAIL is your cloudflare account email \ + CLOUDFLARE_API_KEY you can get it from (https://dash.cloudflare.com/profile/api-tokens)[Cloudflare profile > API Tokens] + CERTBOT_EMAIL this email is for letsencrypt to send you cert expiry notification + DOMAINS write domains you want ssl for seperated by commas, wildcard is supported (*.example.com) +2. Save following content as `compose.yml` +```yml +services: + certgen: + image: git.shihaam.dev/shihaam/gen-ssl-letsencrypt-cf + hostname: certgen + volumes: + - ./certs:/etc/letsencrypt/archive + env_file: .env + restart: no +# certgen-sar: +# image: git.shihaam.dev/shihaam/gen-ssl-letsencrypt-cf +# hostname: certgen-sar +# volumes: +# - ./certs:/etc/letsencrypt/archive +# env_file: .env_sar +# restart: no +``` +3. Run `docker compose up` and wait +4. Your cert and key will be saved in `certs` folder + +