Repository navigation
docs: add cloud server install guide, platform support and a Chinese deployment guide - #163
Open
newexploreor wants to merge 5 commits into
Open
newexploreor wants to merge 5 commits into
newexploreor wants to merge 5 commits into
Conversation
Document supported platforms (macOS and Linux; Windows not yet), a step-by-step cloud server install with HTTPS, upgrades and backups, and a note on slow GitHub access from mainland China cloud hosts.
Collaborator
|
LoopForge PR Review — head
|
The Chinese README and Local usage guide linked to the English-only deployment guide. Add docs/deployment.zh-CN.md with the same sections, add language switches, and point Chinese links and anchors to it.
Collaborator
|
LoopForge PR Review — head Verdict: ✅ Pass
|
Take main's Quick start, executor table and remote-host notes, and keep only this branch's macOS/Linux support statement, so the docs do not regress the executor credentials table. Co-Authored-By: Claude Code <noreply@anthropic.com>
Merging main took main's README wholesale and dropped the cloud-server install chapter added by this PR. Re-add it after the GitLab/SSH paragraph, keeping main's Quick start, executor table and Go version lines as the review asked. Co-Authored-By: Claude Code <noreply@anthropic.com>
Upgrade by checking out a release tag and running ./start.sh pull instead of git pull, which fails on a tag checkout and can drift from the pinned image on main. Point README.zh-CN and the Local usage guide back to the English deployment guide until the Chinese translation is synced, and mark the translation as out of date. Co-Authored-By: Claude Code <noreply@anthropic.com>
Collaborator
|
LoopForge PR Review - head Verdict: Pass
|
Yanami-2K
requested changes
Nov 14, 2026
Yanami-2K
left a comment
Collaborator
There was a problem hiding this comment.
云服务器安装步骤本身很有价值,但以下几点需要先处理:
- 中文部署指南是已知过时的版本
docs/deployment.zh-CN.md开头自己写了“本译文基于较早版本的英文指南,尚未同步…当前镜像版本、升级步骤、MIRROR、Git SSH、升级需要哪些迁移”,但本 PR 同时把README.zh-CN.md和docs/local/usage.zh-CN.md原本指向英文指南的链接改到了这份译文。中文用户会拿到缺步骤的说明。这也和 PR 描述里“中文指南与英文指南有相同的 11 个标题和 8 个代码块”不一致。建议二选一:把译文完整同步到当前英文版;或者本 PR 先不改链接、不加译文。 - 升级文档与 #188 重叠
README.md/README.zh-CN.md新增的“升级与备份”折叠段,和 #188 写进两份 README 及docs/deployment.md的升级说明是同一主题、同一位置。请等 #188 合入后 rebase,升级步骤只保留一份,其他地方链接过去,避免两处描述不一致。另外,PR 描述写的升级方式是git pull && ./start.sh,但 README 内容要求“不要用 git pull”,请同步更新描述。 - 与其他打开的 PR 冲突 第 74 行“Runs on macOS and Linux; Windows is not supported for server deployment yet”:
注:README.md、README.zh-CN.md、docs/deployment.zh-CN.md 的 patch 被截断,英文 README 的 HTTPS/备份段和译文后半部分没有看全。
This was referenced Nov 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
New users deploying to a cloud server had no step-by-step path in the README, and two common problems were undocumented: Windows is not supported, and some mainland China cloud hosts clone from GitHub so slowly that conversation workspaces fail to open.
Both
README.mdandREADME.zh-CN.md(Quick start) now:AGENTFLOW_SECURE_COOKIES=true) and upgrades and backups (git pull && ./start.sh, manualmigrations/, amysqldumpcommand).docs/deployment.zh-CN.md, a Chinese translation of the deployment guide with the same sections. The Chinese README anddocs/local/usage.zh-CN.mdpreviously linked to the English-only guide; their links and anchors now point to the Chinese guide, and both guides have a language switch.Scope
Compatibility
Documentation only; no behavior change.
Validation
Checked against the code: the release workflow publishes
linux/amd64,linux/arm64; the MySQL container exposesMYSQL_ROOT_PASSWORDand the database isloopforge; new installs writeLOOPFORGE_IMAGE=''to.env, sogit pull && ./start.shmoves to the newly pinned image;.envchanges take effect by re-running./start.sh; the English anchordocs/deployment.md#slow-networks-clone-and-image-build-limitsexists, and everydocs/deployment.zh-CN.md#…anchor in the Chinese README matches a heading slug generated bygithub-slugger(the slugger GitHub uses). The Chinese guide has the same 11 headings and 8 code blocks as the English one.Safety