adoralaura/certwarden-deploy
1
0
Fork 0
Code Issues 1 Pull requests Releases 5 Activity

update quickstart docs
All checks were successful
ci/woodpecker/push/deploy-docs Pipeline was successful
Details

Browse source
This commit is contained in:
Adora Laura Kalb 2024-07-28 08:11:49 +02:00
parent b988e4cf51
commit 6c2b04e6b9
Signed by: adoralaura
SSH key fingerprint: SHA256:3XrkbR8ikAZJVtYfaUliX1MhmJYVAe/ocIb/MiDHBJ8
2 changed files with 27 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -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... To quickly get started with `certwarden-deploy`, just download the binary...
```shell ```shell
# this downloads certwarden-deploy version 0.1.1 # this downloads certwarden-deploy version 0.2.1
# to /usr/local/bin/certwarden-deploy # 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 sudo chmod +x /usr/local/bin/certwarden-deploy
``` ```
@ -35,23 +35,24 @@ disable_certificate_validation: false
# define all managed certificates here # define all managed certificates here
certificates: certificates:
# name is a unique identifier that must start and end with an alphanumeric character, # name is a unique identifier that must start and end with an alphanumeric character,
# and can contain the following characters: a-zA-Z0-9._- # and can contain the following characters: a-zA-Z0-9._-
# required # required
- name: test-certificate.example.com - name: test-certificate.example.com
# Contains the API-Key to fetch the certificate from the server # Contains the API-Key to fetch the certificate from the server
# required # required
cert_secret: examplekey_notvalid_hrzjGDDw8z
api_key: examplekey_notvalid_hrzjGDDw8z
# action to run when certificate was updated or --force is on
action: "/usr/bin/systemd reload caddy"
# path where to save the certificate # path where to save the certificate
# required # 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! ... and run it!

23
docs/content/_index.md
View file

@ -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... To quickly get started with `certwarden-deploy`, just download the binary...
```shell ```shell
# this downloads certwarden-deploy version 0.1.1 # this downloads certwarden-deploy version 0.2.1
# to /usr/local/bin/certwarden-deploy # 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 sudo chmod +x /usr/local/bin/certwarden-deploy
``` ```
@ -50,15 +50,22 @@ certificates:
# Contains the API-Key to fetch the certificate from the server # Contains the API-Key to fetch the certificate from the server
# required # required
cert_secret: examplekey_notvalid_hrzjGDDw8z
api_key: examplekey_notvalid_hrzjGDDw8z
# action to run when certificate was updated or --force is on
action: "/usr/bin/systemd reload caddy"
# path where to save the certificate # path where to save the certificate
# required # 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! ... and run it!