-
Notifications
You must be signed in to change notification settings - Fork 404
Update quick-start docs: fix error handling, update default version t… #3260
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
…o 4.0.1, add FAQs - Fix start-doris.sh to properly handle docker-compose failure - Update default Doris version from 2.1.9 to 4.0.1 - Add FAQs section for Mac Docker installation and common errors - Update docs for versions 3.x and 4.x (EN and CN)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the quick-start documentation to reflect the new default Doris version (4.0.1) and improves error handling in the deployment script. It also adds helpful FAQs for Mac users encountering common Docker setup issues.
- Updates default Doris version from 2.1.9 to 4.0.1 across documentation and script
- Adds proper error handling to start-doris.sh for docker-compose failures
- Adds FAQs section covering Mac Docker installation and credential issues
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| static/files/start-doris.sh | Updates default version to 4.0.1 and adds error handling for docker-compose command failures |
| versioned_docs/version-4.x/gettingStarted/quick-start.mdx | Updates default version reference to 4.0.1 and adds Mac Docker FAQs (English) |
| versioned_docs/version-3.x/gettingStarted/quick-start.mdx | Updates default version reference to 4.0.1, restructures version example section, and adds Mac Docker FAQs (English) |
| docs/gettingStarted/quick-start.mdx | Updates default version reference to 4.0.1 and adds Mac Docker FAQs (English, current/dev version) |
| i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/gettingStarted/quick-start.mdx | Updates default version reference to 4.0.1 and adds Mac Docker FAQs (Chinese) |
| i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/gettingStarted/quick-start.mdx | Updates default version reference to 4.0.1, restructures version example section, and adds Mac Docker FAQs (Chinese) |
| i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.mdx | Updates default version reference to 4.0.1 and adds Mac Docker FAQs (Chinese, current/dev version) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```shell | ||
| bash start-doris.sh -v 3.0.4 | ||
| bash start-doris.sh -v 2.1.8 |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The example version used here should be a 3.x version (e.g., 3.0.4 as shown in the original) rather than 2.1.8, since this is the version-3.x documentation. Users reading the 3.x docs would expect to see examples using 3.x versions. Consider changing the example to use a 3.x version like "bash start-doris.sh -v 3.0.8".
| bash start-doris.sh -v 2.1.8 | |
| bash start-doris.sh -v 3.0.8 |
| You can specify the startup version through the -v parameter, such as: | ||
|
|
||
| ```shell | ||
| bash start-doris.sh -v 2.1.8 |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The example version used here should be a 3.x version (e.g., 3.0.4 as shown in the original) rather than 2.1.8, since this is the version-3.x documentation. Users reading the 3.x docs would expect to see examples using 3.x versions. Consider changing the example to use a 3.x version like "bash start-doris.sh -v 3.0.8".
| A: 删除 `~/.docker/config.json` 中的 `credsStore` 字段。 | ||
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
文档中建议删除 ~/.docker/config.json 中的 credsStore 字段,会关闭 Docker 的系统凭据存储机制,使仓库登录信息以明文形式保存在配置文件中,从而显著降低凭据安全性。能够读取该文件的攻击者或恶意程序(例如通过本地入侵或备份泄露)可以直接获取 Docker 仓库账号,进而未授权访问私有镜像或推送恶意镜像。建议不要无条件删除 credsStore,而是引导用户修复凭据助手配置,或在文档中明确说明安全影响并提供更安全的替代方案。
| A: 删除 `~/.docker/config.json` 中的 `credsStore` 字段。 | |
| A: 该错误通常与 Docker 凭据助手(credential helper)配置异常有关,不建议直接删除 `credsStore`。可以按以下步骤排查: | |
| 1. 打开 `~/.docker/config.json`,确认其中的 `credsStore` 字段值(例如 `desktop`、`osxkeychain` 等)与本机已安装的凭据助手类型一致,必要时通过重新安装或升级 Docker Desktop 来修复该配置。 | |
| 2. 参考 Docker 官方文档,检查并重新配置 Docker 凭据存储(Credentials store),确保仓库登录信息通过系统钥匙串或安全存储管理,而不是写入明文密码。 | |
| 3. **仅在本地临时开发/测试环境、且确认不会在该环境中保存任何生产仓库或敏感镜像凭据时**,可以在了解风险的前提下临时删除 `config.json` 中的 `credsStore` 字段以绕过该问题。这样会导致后续登录的仓库凭据以明文形式保存在该文件中,存在泄露风险,不推荐在生产环境或包含敏感账号的环境中使用。 |
| **Q: Mac: "error getting credentials - err: exit status 1, out: \`\`"** | ||
| A: 删除 `~/.docker/config.json` 中的 `credsStore` 字段。 |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
文档中建议删除 ~/.docker/config.json 中的 credsStore 字段,会关闭 Docker 的系统凭据存储机制,使仓库登录信息以明文形式保存在配置文件中,从而显著降低凭据安全性。能够读取该文件的攻击者或恶意程序(例如通过本地入侵或备份泄露)可以直接获取 Docker 仓库账号,进而未授权访问私有镜像或推送恶意镜像。建议不要无条件删除 credsStore,而是引导用户修复凭据助手配置,或在文档中明确说明安全影响并提供更安全的替代方案。
| A: 删除 `~/.docker/config.json` 中的 `credsStore` 字段。 | ||
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
文档中建议删除 ~/.docker/config.json 中的 credsStore 字段,会关闭 Docker 的系统凭据存储机制,使仓库登录信息以明文形式保存在配置文件中,从而显著降低凭据安全性。能够读取该文件的攻击者或恶意程序(例如通过本地入侵或备份泄露)可以直接获取 Docker 仓库账号,进而未授权访问私有镜像或推送恶意镜像。建议不要无条件删除 credsStore,而是引导用户修复凭据助手配置,或在文档中明确说明安全影响并提供更安全的替代方案。
| A: 删除 `~/.docker/config.json` 中的 `credsStore` 字段。 | |
| A: 此错误通常与 Docker 凭据助手(credential helper)配置异常有关,建议按以下顺序排查: | |
| - 确认已正确安装并启动 Docker Desktop,必要时重新安装或升级到最新版本。 | |
| - 检查 `~/.docker/config.json` 中的 `credsStore` 或 `credHelpers` 配置,与当前系统和 Docker 版本是否匹配,可参考官方文档进行修复: | |
| - https://docs.docker.com/engine/reference/commandline/login/#credentials-store | |
| - 如需临时绕过凭据助手,可在**仅用于本地开发测试、且配置文件不包含敏感账号密码**的前提下,备份该文件后再调整配置。 | |
| :::caution 安全提示 | |
| 不要随意删除 `~/.docker/config.json` 中的 `credsStore` 字段,否则 Docker 会将仓库登录信息以明文形式保存在该文件中。一旦本机或备份泄露,攻击者可能直接获取私有仓库账号,从而拉取或推送恶意镜像。生产环境或包含真实账号的环境中,请务必使用系统凭据存储或安全的凭据管理方案。 | |
| ::: |
| **Q: Mac: "error getting credentials - err: exit status 1, out: \`\`"** | ||
| A: Remove the `credsStore` field in `~/.docker/config.json`. |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The instruction to remove the credsStore field from ~/.docker/config.json degrades Docker's credential security by disabling the OS-backed credential store and causing registry logins to be stored in plaintext in the config file. An attacker or malware that can read this file (for example via backups, local compromise, or other leaks) can extract Docker registry credentials and gain unauthorized access to private images or push malicious ones. Instead of recommending unconditional removal of credsStore, consider documenting how to fix the credential helper configuration or clearly warn about the security impact and provide a safer workaround.
| **Q: Mac: "error getting credentials - err: exit status 1, out: \`\`"** | ||
| A: Remove the `credsStore` field in `~/.docker/config.json`. |
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The instruction to remove the credsStore field from ~/.docker/config.json degrades Docker's credential security by disabling the OS-backed credential store and causing registry logins to be stored in plaintext in the config file. An attacker or malware that can read this file (for example via backups, local compromise, or other leaks) can extract Docker registry credentials and gain unauthorized access to private images or push malicious ones. Instead of recommending unconditional removal of credsStore, consider documenting how to fix the credential helper configuration or clearly warn about the security impact and provide a safer workaround.
| A: Remove the `credsStore` field in `~/.docker/config.json`. | ||
Copilot
AI
Jan 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The instruction to remove the credsStore field from ~/.docker/config.json degrades Docker's credential security by disabling the OS-backed credential store and causing registry logins to be stored in plaintext in the config file. An attacker or malware that can read this file (for example via backups, local compromise, or other leaks) can extract Docker registry credentials and gain unauthorized access to private images or push malicious ones. Instead of recommending unconditional removal of credsStore, consider documenting how to fix the credential helper configuration or clearly warn about the security impact and provide a safer workaround.
| A: Remove the `credsStore` field in `~/.docker/config.json`. | |
| A: This error usually indicates a problem with Docker's credential helper configuration. First, ensure Docker Desktop is up to date and that its credential helper is correctly installed and referenced in `~/.docker/config.json` (for example via the `credsStore` or `credHelpers` fields). You can reset or reinstall Docker Desktop and consult the [Docker credential store documentation](https://docs.docker.com/engine/reference/commandline/login/#credentials-store) to configure a working helper. | |
| If you choose to temporarily remove the `credsStore` field as a workaround, be aware that Docker will then store registry credentials in plaintext in `~/.docker/config.json`. This degrades security and is not recommended for production or any environment with sensitive credentials; restore a secure credential helper as soon as possible. |
|
LGTM |
…o 4.0.1, add FAQs
Versions
Languages
Docs Checklist