From 6c2b04e6b9fc4add5e0df81503da03a0b9f4efdc Mon Sep 17 00:00:00 2001
From: Adora Laura Kalb <adora@lila.network>
Date: Sun, 28 Jul 2024 08:11:49 +0200
Subject: [PATCH] update quickstart docs

---
 README.md              | 23 ++++++++++++-----------
 docs/content/_index.md | 23 +++++++++++++++--------
 2 files changed, 27 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 7551e3c..fd010b2 100644
--- a/README.md
+++ b/README.md
@@ -12,9 +12,9 @@ Installation of the required CertWarden instance is out of scope of this documen
 To quickly get started with `certwarden-deploy`, just download the binary...
 
 ```shell
-# this downloads certwarden-deploy version 0.1.1 
+# this downloads certwarden-deploy version 0.2.1 
 # to /usr/local/bin/certwarden-deploy
-sudo wget https://code.lila.network/adoralaura/certwarden-deploy/releases/download/0.1.1/certwarden-deploy-0.1.1-linux-amd64 -O /usr/local/bin/certwarden-deploy
+sudo wget https://code.lila.network/adoralaura/certwarden-deploy/releases/download/0.2.1/certwarden-deploy-0.2.1-linux-amd64 -O /usr/local/bin/certwarden-deploy
 
 sudo chmod +x /usr/local/bin/certwarden-deploy
 ```
@@ -35,23 +35,24 @@ disable_certificate_validation: false
 
 # define all managed certificates here
 certificates:
-
     # name is a unique identifier that must start and end with an alphanumeric character, 
     # and can contain the following characters: a-zA-Z0-9._-
     # required
   - name: test-certificate.example.com
-
     # Contains the API-Key to fetch the certificate from the server
     # required
-
-    api_key: examplekey_notvalid_hrzjGDDw8z
-
-    # action to run when certificate was updated or --force is on
-    action: "/usr/bin/systemd reload caddy"
-
+    cert_secret: examplekey_notvalid_hrzjGDDw8z
     # path where to save the certificate
     # required
-    file_path: "/path/to/test-certificate.example.com-cert.pem"
+    cert_path: "/path/to/test-certificate.example.com-cert.pem"
+    # Contains the API-Key to fetch the private key from the server
+    # required
+    key_secret: examplekey_notvalid_hrzbbDDw8z
+    # path where to save the private key
+    # required
+    key_path: "/path/to/test-certificate.example.com-key.pem"
+    # action to run when certificate was updated or --force is on
+    action: "/usr/bin/systemd reload caddy"
 ```
 
 ... and run it!
diff --git a/docs/content/_index.md b/docs/content/_index.md
index 7da4798..4a94673 100644
--- a/docs/content/_index.md
+++ b/docs/content/_index.md
@@ -19,9 +19,9 @@ Installation of the required CertWarden instance is out of scope of this documen
 To quickly get started with `certwarden-deploy`, just download the binary...
 
 ```shell
-# this downloads certwarden-deploy version 0.1.1 
+# this downloads certwarden-deploy version 0.2.1
 # to /usr/local/bin/certwarden-deploy
-sudo wget https://code.lila.network/adoralaura/certwarden-deploy/releases/download/0.1.1/certwarden-deploy-0.1.1-linux-amd64 -O /usr/local/bin/certwarden-deploy
+sudo wget https://code.lila.network/adoralaura/certwarden-deploy/releases/download/0.2.1/certwarden-deploy-0.2.1-linux-amd64 -O /usr/local/bin/certwarden-deploy
 
 sudo chmod +x /usr/local/bin/certwarden-deploy
 ```
@@ -50,15 +50,22 @@ certificates:
 
     # Contains the API-Key to fetch the certificate from the server
     # required
-
-    api_key: examplekey_notvalid_hrzjGDDw8z
-
-    # action to run when certificate was updated or --force is on
-    action: "/usr/bin/systemd reload caddy"
+    cert_secret: examplekey_notvalid_hrzjGDDw8z
 
     # path where to save the certificate
     # required
-    file_path: "/path/to/test-certificate.example.com-cert.pem"
+    cert_path: "/path/to/test-certificate.example.com-cert.pem"
+
+    # Contains the API-Key to fetch the private key from the server
+    # required
+    key_secret: examplekey_notvalid_hrzbbDDw8z
+
+    # path where to save the private key
+    # required
+    key_path: "/path/to/test-certificate.example.com-key.pem"
+
+    # action to run when certificate was updated or --force is on
+    action: "/usr/bin/systemd reload caddy"
 ```
 
 ... and run it!