klefki/README.md

23 lines
506 B
Markdown
Raw Permalink Normal View History

2025-02-13 17:43:28 -08:00
<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