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)
This commit is contained in:
BBQ
2026-02-13 18:38:51 +08:00
parent 33d7662798
commit fbc2ab7593
3 changed files with 7 additions and 3 deletions
+4
View File
@@ -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
+3 -3
View File
@@ -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?