feat: Adds some initial documentation.

This commit is contained in:
2025-04-02 09:13:42 -04:00
parent e12e1193a0
commit 1922d27d46
2 changed files with 23 additions and 2 deletions

2
.prettierrc.yaml Normal file
View File

@@ -0,0 +1,2 @@
printWidth: 80
proseWrap: always

View File

@@ -1,3 +1,22 @@
# docs
---
date: 2025-4-02
updated: 2025-04-02
---
Documentation about how the homelab is setup.
# 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