Skip to content

Self-hosted workflows for coding-agent delivery. Orchestrate CodeBuddy, Codex and Claude Code with scripts and human approval gates. Includes Local workflows for coding assistants.

docs: use ./start.sh as the quick start (#107)

cocofhu95954d79d1b8
diff --git a/README.md b/README.md
index a3156338..d2045d2f 100644
--- a/README.md
+++ b/README.md
@@ -72,12 +72,12 @@ Requires **Git, curl, Docker (with Compose)** and **Python 3**. On a fresh Ubunt
```bash
git clone https://github.com/Tencent/LoopForge.git
cd LoopForge
-bash scripts/install.sh # or: ./start.sh
+./start.sh
```
-Both commands pull the GHCR release image pinned in `compose.yaml` without building locally. Use `./start.sh logs`, `stop`, `restart` or `pull` to manage it, and `./start.sh dev` to build the checkout from source.
+`./start.sh` pulls the GHCR release image pinned in `compose.yaml` without building locally (`bash scripts/install.sh` does the same). Use `./start.sh logs`, `stop`, `restart` or `pull` to manage it, and `./start.sh dev` to build the checkout from source.
-Open the URL printed by the installer and create your account; the first one becomes the administrator. The service listens on `0.0.0.0:8090` by default; on a cloud host open `http://<public IP>:8090` after allowing the port in your security group, or put an HTTPS reverse proxy in front. Restrict access to your own IP until the administrator account exists. The home page's quick-access guide walks you through adding a model key, connecting a repository and choosing an SOP.
+Open the address printed by the installer and create your account; the first one becomes the administrator. The service listens on `0.0.0.0:8090` by default. On a cloud host, the installer reads the public IP from the provider's metadata service and prints it; allow the port in your security group, or put an HTTPS reverse proxy in front. Restrict access to your own IP until the administrator account exists. The home page's quick-access guide walks you through adding a model key, connecting a repository and choosing an SOP.
### Try it without an API key
diff --git a/README.zh-CN.md b/README.zh-CN.md
index fce67ee9..5be02db8 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -72,12 +72,12 @@ https://github.com/user-attachments/assets/10b8ae2e-d7e7-4b78-8876-c45818d4a08f
```bash
git clone https://github.com/Tencent/LoopForge.git
cd LoopForge
-bash scripts/install.sh # 或:./start.sh
+./start.sh
```
-两条命令等价,都直接拉取 `compose.yaml` 中 pin 的 GHCR 发布镜像,不在本地构建。用 `./start.sh logs`、`stop`、`restart`、`pull` 管理服务;需要从源码构建时用 `./start.sh dev`。
+`./start.sh` 直接拉取 `compose.yaml` 中 pin 的 GHCR 发布镜像,不在本地构建(`bash scripts/install.sh` 效果相同)。用 `./start.sh logs`、`stop`、`restart`、`pull` 管理服务;需要从源码构建时用 `./start.sh dev`。
-打开安装脚本输出的访问链接创建账号,第一个账号自动成为管理员。服务默认监听 `0.0.0.0:8090`,云主机放通安全组端口后访问 `http://公网IP:8090`,或配置 HTTPS 反向代理;管理员账号创建前,建议只允许你的 IP 访问。首页的「快速接入」会带你配置模型凭据、绑定仓库并选好默认 SOP。
+打开安装脚本输出的地址创建账号,第一个账号自动成为管理员。服务默认监听 `0.0.0.0:8090`;在云主机上,安装脚本会从云厂商的元数据服务读取公网 IP 并直接打印出来,放通安全组端口即可访问,或配置 HTTPS 反向代理;管理员账号创建前,建议只允许你的 IP 访问。首页的「快速接入」会带你配置模型凭据、绑定仓库并选好默认 SOP。
### 免 API Key 体验
diff --git a/docs/deployment.md b/docs/deployment.md
index 05217ae4..3071069b 100644
--- a/docs/deployment.md
+++ b/docs/deployment.md
@@ -22,8 +22,7 @@ Use `AGENTFLOW_MYSQL_DSN` for your own MySQL deployment. A fresh account command
## Container installation
```bash
-bash scripts/install.sh # install or start in the background
-./start.sh # the same installer, plus the management commands below
+./start.sh # install or start in the background (same as bash scripts/install.sh)
./start.sh logs # follow platform logs
./start.sh stop # stop; ./start.sh down removes containers but keeps data volumes
./start.sh restart # restart the platform container