Compare commits
3 commits
74c32b87b9
...
2fe2b980be
Author | SHA1 | Date | |
---|---|---|---|
2fe2b980be | |||
f40bdd5cbf | |||
fcdc147dd2 |
3 changed files with 20 additions and 9 deletions
|
@ -21,6 +21,8 @@ uniqueHomePage = false # change to false to add sidebar to homepage
|
||||||
[params.author]
|
[params.author]
|
||||||
name = 'Adora Laura Kalb'
|
name = 'Adora Laura Kalb'
|
||||||
|
|
||||||
|
[outputs]
|
||||||
|
home = ['html', 'rss', 'search']
|
||||||
|
|
||||||
[menu]
|
[menu]
|
||||||
[[menu.shortcuts]]
|
[[menu.shortcuts]]
|
||||||
|
|
|
@ -25,9 +25,9 @@ sudo chmod +x /usr/local/bin/certwarden-deploy
|
||||||
```
|
```
|
||||||
|
|
||||||
... fill out the config file...
|
... fill out the config file...
|
||||||
```shell
|
|
||||||
vi /etc/certwarden-deploy/config.yaml
|
|
||||||
```
|
`vi /etc/certwarden-deploy/config.yaml`
|
||||||
```yaml
|
```yaml
|
||||||
# Base URL of the CertWarden instance
|
# Base URL of the CertWarden instance
|
||||||
# required
|
# required
|
||||||
|
@ -77,7 +77,7 @@ I use my own [Forgejo](https://forgejo.org/) Instance [code.lila.network](https:
|
||||||
* If you have a trivial fix or improvement, go ahead and send a diff to the maintainer(s) of this repository (see
|
* If you have a trivial fix or improvement, go ahead and send a diff to the maintainer(s) of this repository (see
|
||||||
[MAINTAINERS.md](https://code.lila.network/adoralaura/certwarden-deploy/src/branch/main/MAINTAINERS.md)).
|
[MAINTAINERS.md](https://code.lila.network/adoralaura/certwarden-deploy/src/branch/main/MAINTAINERS.md)).
|
||||||
|
|
||||||
* If you plan to do something more involved, first please [send me a mail]( mailto:dev@lauka.net?subject=%5Bcertwarden-deploy%5D)mso I can create an account for you.
|
* If you plan to do something more involved, first please [send me a mail](mailto:dev@lauka.net?subject=%5Bcertwarden-deploy%5D) so I can create an account for you.
|
||||||
|
|
||||||
### Non-development Contibutions
|
### Non-development Contibutions
|
||||||
|
|
||||||
|
@ -90,4 +90,4 @@ share what works.
|
||||||
You can find the Changelog here: [Changelog](https://code.lila.network/adoralaura/certwarden-deploy/src/branch/main/CHANGELOG.md)
|
You can find the Changelog here: [Changelog](https://code.lila.network/adoralaura/certwarden-deploy/src/branch/main/CHANGELOG.md)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
`certwarden-deploy` is available under the MIT license. See the [LICENSE](https://code.lila.network/adoralaura/certwarden-deploy/src/branch/main/LICENSE) file for more info.
|
`certwarden-deploy` is available under the MIT license. See the [License page](/license/) for more info.
|
||||||
|
|
|
@ -9,7 +9,7 @@ Before building the project, ensure you have the following installed:
|
||||||
- make: A build automation tool
|
- make: A build automation tool
|
||||||
- Go: Version 1.22 or later
|
- 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:
|
To build the project, first clone the projects git repository, then navigate to the project's root directory and run the following command:
|
||||||
```shell
|
```shell
|
||||||
|
@ -17,5 +17,14 @@ make build
|
||||||
```
|
```
|
||||||
This command will generate the `certwarden-deploy` binary in the `bin/` folder.
|
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.
|
||||||
|
|
Loading…
Reference in a new issue