From f40bdd5cbfbd7e0a83110ba5c442e3d862a04d0f Mon Sep 17 00:00:00 2001 From: Adora Laura Kalb Date: Mon, 29 Jul 2024 20:30:42 +0200 Subject: [PATCH] describe installation process --- docs/content/installation.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/content/installation.md b/docs/content/installation.md index a4792cd..d0c504f 100644 --- a/docs/content/installation.md +++ b/docs/content/installation.md @@ -9,7 +9,7 @@ Before building the project, ensure you have the following installed: - make: A build automation tool - Go: Version 1.22 or later -## Building the Project from source +## Building the Project from Source To build the project, first clone the projects git repository, then navigate to the project's root directory and run the following command: ```shell @@ -17,5 +17,14 @@ make build ``` This command will generate the `certwarden-deploy` binary in the `bin/` folder. -## Installation +## Getting pre-built Binaries +You can also get pre-built binaries from the [releases page](https://code.lila.network/adoralaura/certwarden-deploy/releases). Make sure you get the binaries fitting your architecture! +## Setting up automatic Certificate Renewals +Although not required for `certwarden-deploy` to work, it's highly rrecommended to set up automatic renewals for `certwarden-deploy`, so that you don't need to worry about rolling out your certificates every time they get renewed by CertWarden. + +To do that, there are example `systemd` Service and Timer files included in the `examples/` directory of the `certwarden-deploy` repository. + +Please make sure to customize them to your requirements (path to `certwarden-deploy` binary, user and group, execution interval...) and then drop them into the `/etc/systemd/system/` directory, then enable the timer with `systemctl enable --now certwarden-deploy.timer` + +If you kept the example schedule, `certwarden-deploy` will run every saturday at ~4am.