From c2e0fc241f2c6a638e49234cae2883b8d1e75103 Mon Sep 17 00:00:00 2001 From: Emilien Mantel Date: Wed, 31 May 2023 11:20:16 +0200 Subject: [PATCH] :pencil2: Fix doc typo --- README.md | 21 ++++++++++++++++----- doc/ssl.md | 8 ++++---- 2 files changed, 20 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 740fe50..9281d04 100644 --- a/README.md +++ b/README.md @@ -104,24 +104,35 @@ Fine configuration Note ---- -- Active support for Debian. +- Active support for Debian/Ubuntu. - FreeBSD support is experimental. I only test (for the moment) 10.2 (but it can work on other versions). Dependencies ------------ -None +See: [requirements.yml](requirements.yml). -If you need to dev this role locally ------------------------------------- +If you need to dev this role locally on Vagrant +------------------------------------------------ Before use vagrant, run once: -``` +```commandline ansible-galaxy install -p ./tests/ HanXHX.php,master ``` +If you need to dev this role locally with molecule +-------------------------------------------------- + +Check available scenarios in [molecule](molecule) directory. + +With `debian-12` scenario: + +```commandline +molecule -v -c molecule/_shared/base.yml verify -s debian-12 +``` + Example Playbook ---------------- diff --git a/doc/ssl.md b/doc/ssl.md index d95e6d1..fd66775 100644 --- a/doc/ssl.md +++ b/doc/ssl.md @@ -8,7 +8,7 @@ Variables - `nginx_dh`: DH content - `nginx_dh_length`: DH key length (default is 2048) -- `nginx_dh_path`: file localation +- `nginx_dh_path`: file location - `nginx_ssl_dir`: directory where you install your SSL/TLS keys - `nginx_ssl_pairs` @@ -20,7 +20,7 @@ Note: `name` is used to deploy key/cert. With defaults values dans `name` = "foo ### Content mode -Key/Cert content is stored in variable. Usefull with vault. +Key/Cert content is stored in variable. Useful with vault. - `key`: content of the private key - `cert`: content of the public key @@ -36,7 +36,7 @@ You can use these variables if you use another task/role to manages your certifi Create a self-signed pair and deploy it. Do not use this feature in production. -- `self_signed`: set true to use this featrure +- `self_signed`: set true to use this feature - `force`: optional feature (default: false), force regen pair (not idempotent) ### Acme @@ -45,7 +45,7 @@ Uses acme.sh to create free certificates. It uses HTTP-01 challenge. Use this fe - `acme`: set true to use this feature. It uses `name` (can be a string or string list). -Have a look to [acme configuratuion](acme.md configuration). +Have a look to [acme configuration](acme.md configuration). Tips ----