From 55c1079554dc81bfcde1f832bb24155825fbce08 Mon Sep 17 00:00:00 2001 From: Beda Schmid Date: Wed, 5 Aug 2026 16:26:14 +0000 Subject: [PATCH] Update Readme --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2aca6f5..c2fd31a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ -# mealie +# Mealie + +Self-hosted recipe manager with persistent application data and a PostgreSQL database. + +## Deployment layout + +- **Compose:** `/srv/docker/mealie/docker-compose.yml` +- **Static configuration/source:** no additional static configuration or build source +- **Non-secret environment:** registration policy, runtime UID/GID, timezone, public URL, PostgreSQL topology, +and OpenAI model are declared inline in Compose; there is no project-local `.env` +- **Secrets:** `/srv/docker/secrets/mealie/.env` +- **NVMe application state:** `/srv/appdata/mealie/data` and `/srv/appdata/mealie/postgres` +- **Bulk HDD data:** none +- **Other mounts:** none + +Secrets are never committed to this repository. The central secret environment +is supplied to the Mealie and PostgreSQL services. + +## Dependencies and recovery + +- **Networks/dependencies:** Mealie depends on the healthy PostgreSQL service through the private +`mealie_internal` network and uses the external `npm_proxy` network at `192.168.98.13` +- **Back up:** `/srv/appdata/mealie/data`, `/srv/appdata/mealie/postgres`, and the separately protected Mealie +secret environment +- **Re-creatable:** the Mealie and PostgreSQL containers; no persistent cache is declared