mirror of
https://github.com/memohai/Memoh.git
synced 2026-04-25 07:00:48 +09:00
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:
@@ -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
|
||||
|
||||
@@ -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?
|
||||
|
||||
Reference in New Issue
Block a user