Add mirror usage to docs #33

2025-07-16T15:24:20+08:00

Thinker-Joe commented

2025-07-16 15:24:20 +08:00

(Migrated from github.com)

Summary

clarify daemon.json mirror configuration in README
expand mirror instructions in the homepage modal

https://chatgpt.com/codex/tasks/task_b_68773c59d6c48327b79ef7244b1bb17b

Summary by CodeRabbit

Documentation
- Updated the README with instructions for configuring Docker to use the proxy service as a registry mirror via the daemon.json file.
New Features
- Enhanced the Docker image acceleration modal with step-by-step guidance for setting up the registry mirror in Docker's daemon.json configuration.

## Summary - clarify daemon.json mirror configuration in README - expand mirror instructions in the homepage modal ------ https://chatgpt.com/codex/tasks/task_b_68773c59d6c48327b79ef7244b1bb17b  ## Summary by CodeRabbit * **Documentation** * Updated the README with instructions for configuring Docker to use the proxy service as a registry mirror via the daemon.json file. * **New Features** * Enhanced the Docker image acceleration modal with step-by-step guidance for setting up the registry mirror in Docker's daemon.json configuration.

coderabbitai[bot] commented

2025-07-16 15:24:26 +08:00

(Migrated from github.com)

Walkthrough

Instructions for configuring Docker to use the proxy service as a registry mirror via the daemon.json file have been added to both the README and the public-facing modal in the web interface. These updates provide users with an alternative method for Docker image acceleration by editing Docker's configuration.

Changes

File(s)	Change Summary
README.md	Added instructions for configuring Docker's `daemon.json` to use the proxy as a registry mirror.
src/public/index.html	Updated modal to include `daemon.json` configuration steps for Docker image acceleration.

Poem

A hop and a skip, new docs appear,
Docker runs faster, the method is clear.
Edit your config, restart with delight,
Images will pull at the speed of light!
🐇✨

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

## Walkthrough Instructions for configuring Docker to use the proxy service as a registry mirror via the `daemon.json` file have been added to both the README and the public-facing modal in the web interface. These updates provide users with an alternative method for Docker image acceleration by editing Docker's configuration. ## Changes | File(s) | Change Summary | |---------------------------|--------------------------------------------------------------------------------------------------------| | README.md | Added instructions for configuring Docker's `daemon.json` to use the proxy as a registry mirror. | | src/public/index.html | Updated modal to include `daemon.json` configuration steps for Docker image acceleration. | ## Poem > A hop and a skip, new docs appear, > Docker runs faster, the method is clear. > Edit your config, restart with delight, > Images will pull at the speed of light! > 🐇✨      --- Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. <details> <summary>❤️ Share</summary> - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code) </details> <details> <summary>🪧 Tips</summary> ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai?utm_source=oss&utm_medium=github&utm_campaign=sky22333/hubproxy&utm_content=33): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit <commit_id>, please review it.` - `Explain this complex logic.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai explain this code block.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and explain its main purpose.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` ### Support Need help? Create a ticket on our [support page](https://www.coderabbit.ai/contact-us/support) for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai generate docstrings` to [generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) for this PR. - `@coderabbitai generate sequence diagram` to generate a sequence diagram of the changes in this PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements. </details>

coderabbitai[bot] (Migrated from github.com) reviewed 2025-07-16 15:26:59 +08:00

coderabbitai[bot] (Migrated from github.com) left a comment

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (1)

70-81: Consider adding platform-specific notes and URL formatting guidance

The snippet itself is correct, but a few extra lines could save users troubleshooting time:

Docker expects the mirror URL without a trailing slash.

If the mirror is http rather than https, users must add it under "insecure-registries" instead of "registry-mirrors".

macOS/Windows (and Linux rootless) read ~/.docker/daemon.json; a short mention prevents confusion.

Adding a brief remark under the JSON block keeps the README self-contained.
src/public/index.html (1)
688-701: Use a <pre><code> wrapper to make the JSON block copy-friendly

The JSON example is rendered via a series of   tags and an inline  for the domain.
While this looks fine, users who triple-click to copy may accidentally omit braces or pick up extra spacing.

A minimal structural tweak improves UX:
-<div class="domain-examples">
+<pre class="domain-examples"><code>
 ...
-&nbsp;&nbsp;&nbsp;&nbsp;"https://"
+ "https://"
 ...
-保存后重启 Docker（例如执行 <code>sudo systemctl restart docker</code>）即可生效。
+</code></pre>
+
+保存后重启 Docker（例如执行 <code>sudo systemctl restart docker</code>）即可生效。
+
Benefits
• ensures monospace alignment without manual  
• makes “select-all / copy” grab the exact JSON text, domain included, without HTML artefacts.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c4c5993bd1 and 6bb6584cc2f359d53e27f2bfeaac43f759027b4b.

📒 Files selected for processing (2)

README.md (1 hunks)
src/public/index.html (1 hunks)

**Actionable comments posted: 0** <details> <summary>🧹 Nitpick comments (2)</summary><blockquote> <details> <summary>README.md (1)</summary><blockquote> `70-81`: **Consider adding platform-specific notes and URL formatting guidance** The snippet itself is correct, but a few extra lines could save users troubleshooting time: 1. Docker expects the mirror URL *without* a trailing slash. 2. If the mirror is `http` rather than `https`, users must add it under `"insecure-registries"` instead of `"registry-mirrors"`. 3. macOS/Windows (and Linux rootless) read `~/.docker/daemon.json`; a short mention prevents confusion. Adding a brief remark under the JSON block keeps the README self-contained. </blockquote></details> <details> <summary>src/public/index.html (1)</summary><blockquote> `688-701`: **Use a `<pre><code>` wrapper to make the JSON block copy-friendly** The JSON example is rendered via a series of ` ` tags and an inline `` for the domain. While this looks fine, users who triple-click to copy may accidentally omit braces or pick up extra spacing. A minimal structural tweak improves UX: ```diff -<div class="domain-examples"> +<pre class="domain-examples"><code> ... -    "https://" + "https://" ... -保存后重启 Docker（例如执行 <code>sudo systemctl restart docker</code>）即可生效。 +</code></pre> + +保存后重启 Docker（例如执行 <code>sudo systemctl restart docker</code>）即可生效。 + ``` Benefits • ensures monospace alignment without manual ` ` • makes “select-all / copy” grab the exact JSON text, domain included, without HTML artefacts. </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between c4c5993bd13bf3fa38a73c012518ee20f61b8c59 and 6bb6584cc2f359d53e27f2bfeaac43f759027b4b. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `README.md` (1 hunks) * `src/public/index.html` (1 hunks) </details> </details>

sky22333 commented

2025-07-16 15:47:17 +08:00

(Migrated from github.com)

@Thinker-Joe 感谢大佬贡献，在 README 中阐明 daemon.json 镜像配置就够了，在主页模式中展开镜像说明会导致页面过长出现滚动条，不美观，可以去掉前端中的额外说明我再合，感谢。

Pull request closed

Please reopen this pull request to perform a merge.

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: 3344/hubproxy#33

Add mirror usage to docs #33

Summary

Summary by CodeRabbit

Walkthrough

Changes

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Pull request closed

CodeRabbit Configuration File (`.coderabbit.yaml`)