From fbc2ab759368c12313a9a2bd0ba72c6faf8825a6 Mon Sep 17 00:00:00 2001 From: BBQ Date: Fri, 13 Feb 2026 18:38:51 +0800 Subject: [PATCH] docs: improve README, DEPLOYMENT and move CONTRIBUTING - README: emphasize Docker requirement with get-started link, move silent install under one-click and de-emphasize - DEPLOYMENT: clarify default config path and that only config file is mounted - Move CONTRIBUTING.md to .github/CONTRIBUTING.md (git mv) --- CONTRIBUTING.md => .github/CONTRIBUTING.md | 0 DEPLOYMENT.md | 4 ++++ README.md | 6 +++--- 3 files changed, 7 insertions(+), 3 deletions(-) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (100%) diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md index 09ae1d9c..b7df301c 100644 --- a/DEPLOYMENT.md +++ b/DEPLOYMENT.md @@ -30,6 +30,10 @@ That's it. No containerd, nerdctl, or buildkit required on the host. ## Custom Configuration +By default, Docker Compose uses `docker/config/config.docker.toml` (no file in project root is mounted; only this config file is mounted into the containers). + +To use your own config, create and edit it in the project root, then point `MEMOH_CONFIG` at it (path is on the host; run `docker compose` from the project root): + ```bash cp docker/config/config.docker.toml config.toml nano config.toml diff --git a/README.md b/README.md index 03415c22..d2f39097 100644 --- a/README.md +++ b/README.md @@ -27,12 +27,14 @@ Memoh is a AI agent system platform. Users can create their own AI bots and chat ## Quick Start -One-click install (requires Docker): +One-click install (**requires [Docker](https://www.docker.com/get-started/)**): ```bash curl -fsSL https://raw.githubusercontent.com/memohai/Memoh/main/scripts/install.sh | sh ``` +*Silent install with all defaults: `curl -fsSL ... | sh -s -- -y`* + Or manually: ```bash @@ -43,8 +45,6 @@ docker compose up -d Visit http://localhost after startup. Default login: `admin` / `admin123` -Silent install with all defaults: `curl -fsSL ... | sh -s -- -y` - See [DEPLOYMENT.md](DEPLOYMENT.md) for custom configuration and production setup. ## Why Memoh?