garmr/README.md
2022-11-08 15:54:53 +00:00

22 lines
791 B
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<img alt="Hel (1889) by Johannes Gehrts." src="https://upload.wikimedia.org/wikipedia/commons/c/c5/Hel_%281889%29_by_Johannes_Gehrts.jpg" width="256" />
# [Garmr](https://en.wikipedia.org/wiki/Garmr)
> In Norse mythology, Garmr or Garm (Old Norse: Garmr [ˈɡɑrmz̠]; "rag") is a wolf or dog associated with both Hel and Ragnarök, and described as a blood-stained guardian of Hel's gate.
Garmr is the backend of fwlnx, guarding the system from invalid configurations. It takes the users configuration via a HTTP API and feeds it into the NixOS config to setup the whole system.
# API endpoints
## `GET /config`
Gives you the current configuration as json.
## `PUT /config`
Upload a json configration to this endpoint to reconfigure fwlnx.
---
Made with ❤️‍🔥 and 🐹.