Skip to content

docs: add Windows Docker Desktop deployment guide#9339

Open
PersonalViolet wants to merge 2 commits into
AstrBotDevs:masterfrom
PersonalViolet:docs/dockerdesktop
Open

docs: add Windows Docker Desktop deployment guide#9339
PersonalViolet wants to merge 2 commits into
AstrBotDevs:masterfrom
PersonalViolet:docs/dockerdesktop

Conversation

@PersonalViolet

@PersonalViolet PersonalViolet commented Jul 21, 2026

Copy link
Copy Markdown

完善 Windows 用户的 Docker 部署文档,提供 Windows CMD 和 PowerShell 两种环境下的具体部署命令,解决 Windows 用户在部署时遇到的路径和环境变量配置问题。

Modifications / 改动点

  • 在 docs/zh/deploy/astrbot/docker.md 中新增"通过 Windows Docker Desktop 部署"章节

    • 添加 Windows CMD 部署命令(使用 %cd% 变量)
    • 添加 PowerShell 部署命令(使用 ${PWD} 变量)
    • 说明 TZ 环境变量需使用 IANA 时区格式(如 Asia/Shanghai)
  • 在 docs/en/deploy/astrbot/docker.md 中同步添加英文版本

  • This is NOT a breaking change. / 这不是一个破坏性变更。

Screenshots or Test Results / 运行截图或测试结果

en_doc zh_doc

Checklist / 检查清单

  • 😊 If there are new features added in the PR, I have discussed it with the authors through issues/emails, etc.
    / 如果 PR 中有新加入的功能,已经通过 Issue / 邮件等方式和作者讨论过。

  • 👀 My changes have been well-tested, and "Verification Steps" and "Screenshots" have been provided above.
    / 我的更改经过了良好的测试,并已在上方提供了“验证步骤”和“运行截图”

  • 🤓 I have ensured that no new dependencies are introduced, OR if new dependencies are introduced, they have been added to the appropriate locations in requirements.txt and pyproject.toml.
    / 我确保没有引入新依赖库,或者引入了新依赖库的同时将其添加到 requirements.txtpyproject.toml 文件相应位置。

  • 😮 My changes do not introduce malicious code.
    / 我的更改没有引入恶意代码。

Summary by Sourcery

Document Docker Desktop deployment on Windows for AstrBot, covering both CMD and PowerShell usage with correct time zone and data volume configuration.

Documentation:

  • Add Windows Docker Desktop deployment instructions in the English Docker guide, including CMD and PowerShell examples and TZ configuration notes.
  • Add corresponding Windows Docker Desktop deployment section to the Chinese Docker guide with localized CMD/PowerShell commands and IANA time zone guidance.

Copilot AI review requested due to automatic review settings July 21, 2026 09:12
@dosubot dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jul 21, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds Windows-specific Docker Desktop deployment instructions to the AstrBot Docker guides, helping Windows users run the container from both CMD and PowerShell with correct volume mounting and time zone configuration.

Changes:

  • Added a “Docker Desktop on Windows” section to the Chinese deployment guide with CMD/PowerShell examples and IANA TZ guidance.
  • Added the equivalent “Docker Desktop on Windows” section to the English deployment guide.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/zh/deploy/astrbot/docker.md Adds Windows Docker Desktop deployment section with CMD/PowerShell commands and TZ notes.
docs/en/deploy/astrbot/docker.md Adds English Windows Docker Desktop deployment section with CMD/PowerShell commands and TZ notes.

Comment thread docs/zh/deploy/astrbot/docker.md Outdated
sudo docker logs -f astrbot
```

## 通过Windows Docker Desktop部署
Comment thread docs/zh/deploy/astrbot/docker.md Outdated

`TZ` 的值请设置为 **IANA 时区标准格式**(地区/城市),例如中国为 `Asia/Shanghai`

```bash
Comment thread docs/en/deploy/astrbot/docker.md Outdated

Set `TZ` to the standard IANA time zone format (Region/City). Use `Asia/Shanghai` for China.

```bash

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds documentation for deploying AstrBot via Docker Desktop on Windows using CMD and PowerShell in both English and Chinese. The reviewer suggested using the official Docker Hub image (soulter/astrbot:latest) by default instead of the DaoCloud mirror, and recommended using Windows-style backslashes (\) for local volume paths to ensure compatibility and prevent potential path resolution issues.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/en/deploy/astrbot/docker.md Outdated
Set `TZ` to the standard IANA time zone format (Region/City). Use `Asia/Shanghai` for China.

```bash
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "%cd%/data:/AstrBot/data" --name astrbot m.daocloud.io/docker.io/soulter/astrbot:latest

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

在英文文档中,默认应该使用官方的 Docker Hub 镜像 soulter/astrbot:latest,而不是国内的 DaoCloud 镜像源。此外,在 Windows CMD 环境下,本地路径建议使用反斜杠 \(即 %cd%\data)以符合 Windows 的路径规范,避免部分环境下出现路径解析问题。

Suggested change
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "%cd%/data:/AstrBot/data" --name astrbot m.daocloud.io/docker.io/soulter/astrbot:latest
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "%cd%\data:/AstrBot/data" --name astrbot soulter/astrbot:latest

Comment thread docs/en/deploy/astrbot/docker.md Outdated
Set `TZ` to the standard IANA time zone format (Region/City). Use `Asia/Shanghai` for China.

```bash
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "${PWD}/data:/AstrBot/data" --name astrbot m.daocloud.io/docker.io/soulter/astrbot:latest

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

在英文文档中,默认应该使用官方的 Docker Hub 镜像 soulter/astrbot:latest,而不是国内的 DaoCloud 镜像源。此外,在 Windows PowerShell 环境下,本地路径建议使用反斜杠 \(即 ${PWD}\data)以符合 Windows 的路径规范,避免部分环境下出现路径解析问题。

Suggested change
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "${PWD}/data:/AstrBot/data" --name astrbot m.daocloud.io/docker.io/soulter/astrbot:latest
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "${PWD}\data:/AstrBot/data" --name astrbot soulter/astrbot:latest

Comment thread docs/zh/deploy/astrbot/docker.md Outdated
`TZ` 的值请设置为 **IANA 时区标准格式**(地区/城市),例如中国为 `Asia/Shanghai`

```bash
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "%cd%/data:/AstrBot/data" --name astrbot m.daocloud.io/docker.io/soulter/astrbot:latest

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

建议在此处默认使用官方镜像 soulter/astrbot:latest,以保持与文档前文(第 65 行)的一致性。如果用户在中国大陆境内,可以参考前文的提示自行替换为 DaoCloud 镜像源。此外,在 Windows CMD 环境下,本地路径建议使用反斜杠 \(即 %cd%\data)以符合 Windows 的路径规范。

Suggested change
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "%cd%/data:/AstrBot/data" --name astrbot m.daocloud.io/docker.io/soulter/astrbot:latest
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "%cd%\data:/AstrBot/data" --name astrbot soulter/astrbot:latest

Comment thread docs/zh/deploy/astrbot/docker.md Outdated
`TZ` 的值请设置为 **IANA 时区标准格式**(地区/城市),例如中国为 `Asia/Shanghai`

```bash
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "${PWD}/data:/AstrBot/data" --name astrbot m.daocloud.io/docker.io/soulter/astrbot:latest

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

建议在此处默认使用官方镜像 soulter/astrbot:latest,以保持与文档前文(第 65 行)的一致性。如果用户在中国大陆境内,可以参考前文的提示自行替换为 DaoCloud 镜像源。此外,在 Windows PowerShell 环境下,本地路径建议使用反斜杠 \(即 ${PWD}\data)以符合 Windows 的路径规范。

Suggested change
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "${PWD}/data:/AstrBot/data" --name astrbot m.daocloud.io/docker.io/soulter/astrbot:latest
docker run -itd -p 6185:6185 -p 6199:6199 -e TZ=Asia/Shanghai -v "${PWD}\data:/AstrBot/data" --name astrbot soulter/astrbot:latest

- Change default image to official registry (soulter/astrbot:latest)
- Move DaoCloud mirror to TIP section
- Update PowerShell code block language tag to powershell
- Synchronize Chinese and English versions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants