From 1922d27d46c3684871904934a45bd0a99297c60b Mon Sep 17 00:00:00 2001 From: Michael Housh Date: Wed, 2 Apr 2025 09:13:42 -0400 Subject: [PATCH] feat: Adds some initial documentation. --- .prettierrc.yaml | 2 ++ README.md | 23 +++++++++++++++++++++-- 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 .prettierrc.yaml diff --git a/.prettierrc.yaml b/.prettierrc.yaml new file mode 100644 index 0000000..282cbf2 --- /dev/null +++ b/.prettierrc.yaml @@ -0,0 +1,2 @@ +printWidth: 80 +proseWrap: always diff --git a/README.md b/README.md index d843d05..226ca64 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ -# docs +--- +date: 2025-4-02 +updated: 2025-04-02 +--- -Documentation about how the homelab is setup. \ No newline at end of file +# Homelab Documentation + +Documentation about how the homelab is setup. + +## Containers + +Services run inside of docker containers that are spread between several +servers, which run them. The containers are deployed using a container +orchestrator, currently using [komo](https://komo.housh.dev). + +All of the services have a corresponding repository for their configuration that +is hosted on an [internal git server](https://git.housh.dev/homelab). The +configuration will consist of a docker compose file (generally named +`compose.yaml`). There is often an `example.env` file service the example are +for documentation purposes. The environment variables themselves as well that +will have the names of environment variables needed for the service to run, the +values in are setup in the container orchestrator for the