From 6dec28c4e389418312aa998be36fa215fbf9c51d Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@iml.unibe.ch>
Date: Thu, 31 Mar 2022 10:00:29 +0200
Subject: [PATCH] update docs
---
docs/10_Home.md | 11 +++++++++--
docs/20_Installation.md | 3 +--
readme.md | 4 ++--
templates/readme.md | 4 ++++
4 files changed, 16 insertions(+), 6 deletions(-)
create mode 100644 templates/readme.md
diff --git a/docs/10_Home.md b/docs/10_Home.md
index 62e9c37..56bd992 100644
--- a/docs/10_Home.md
+++ b/docs/10_Home.md
@@ -1,7 +1,14 @@
-# iml-certman
+# IML certman
-Wrapper for **acme.sh** to create Let's Encrypt certificates based on CSR files using DNS authentication.
+Wrapper for **acme.sh** to create Let's Encrypt certificates using DNS authentication.
It was written to create/ renew all needed certificates at a central system to deploy it from there (Ansible, Puppet, ...).
source: <https://git-repo.iml.unibe.ch/open-source/iml-certman>
license: GNU GPL 3.0 <http://www.gnu.org/licenses/gpl-3.0.html>
+
+## Requirements
+
+* bash
+* openssl
+* curl
+* acme.sh client
diff --git a/docs/20_Installation.md b/docs/20_Installation.md
index 16dd86e..0417755 100644
--- a/docs/20_Installation.md
+++ b/docs/20_Installation.md
@@ -10,7 +10,7 @@
* optional: set custom target for generated certificates
* optional: for testing enable Let's Encrypt stage server to prevent running into weekly limits during tests
* optional: set a filter that must match to new certificate and all aliases
- * templates/csr.txt
+ * UNUSED: templates/csr.txt
* set location, company and department ... remark: (currently?) it is removed by LE
A suggested structure is having acme.sh and this wrapper below the same parent directory, i.e.
@@ -26,7 +26,6 @@ A suggested structure is having acme.sh and this wrapper below the same parent d
+-- iml-certman/
|
+-- certs/
- +-- csr/
+-- templates/
+ cm.sh
+ inc_config.sh
diff --git a/readme.md b/readme.md
index ba7283c..17906c1 100644
--- a/readme.md
+++ b/readme.md
@@ -1,6 +1,6 @@
-# iml-certman
+# IML certman
-Wrapper for **acme.sh** to create Let's Encrypt certificates based on CSR files using DNS authentication.
+Wrapper for **acme.sh** to create Let's Encrypt certificates using DNS authentication.
It was written to create/ renew all needed certificates at a central system to deploy it from there (Ansible, Puppet, ...).
source: <https://git-repo.iml.unibe.ch/open-source/iml-certman>
diff --git a/templates/readme.md b/templates/readme.md
new file mode 100644
index 0000000..3dc2c6a
--- /dev/null
+++ b/templates/readme.md
@@ -0,0 +1,4 @@
+# CSR template is not used anymore
+
+We added support for authentication with an dns alias.
+The CSR template won't be used anymore.
--
GitLab