klefki/README.md
Jared Allard a0c82943d5
Some checks failed
tests / golangci-lint (push) Failing after 29s
tests / go test (push) Failing after 47s
chore: initial commit w/ stencil
2025-02-13 18:01:03 -08:00

22 lines
506 B
Markdown

<div align="center">
<img src=".github/images/klefki.png" alt="Klefki" width="300" />
<p><em>LUKS automatic unlocking over network.</em></p>
<hr />
</div>
## Usage
Install a release from [the releases](/releaases) tab, or build from
source.
## Build from Source
1. Clone the repository: `git clone https://git.rgst.io/homelab/klefki`
2. Install [mise](https://mise.jdx.dev) then run `mise install`
3. Run `mise run build` and get an accompanying build at `./bin/klefki`
## License
AGPL-3.0