docs: add docker compose instructions and mac port forwarding tip to …#781
Merged
qin-ctx merged 1 commit intovolcengine:mainfrom Mar 19, 2026
Merged
Conversation
|
dingben.db@bytedance.com seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
qin-ctx
approved these changes
Mar 19, 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 does this PR do?
This PR updates the Quick Start documentation (both English and Chinese versions) to include instructions for deploying OpenViking as an independent service using Docker Compose.
Additionally, it provides a crucial troubleshooting tip for macOS users who might encounter a
Connection reset by peererror when trying to access the service from the host machine.Changes made:
InstallationtoInstallation & Startup/安装与启动.docker-compose.ymltemplate to quickly start the OpenViking server, including volume mappings for configuration (ov.conf) and data.127.0.0.1by default for security reasons. Provided asocatport forwarding solution within thedocker-compose.ymlcommand to allow Mac hosts to access the container, without needing to modify the OpenViking security configuration (like setting aroot_api_keyand exposing to0.0.0.0).Why is this needed?
Connection resetissue due to Docker Desktop's networking model combined with OpenViking's strict127.0.0.1binding policy when no root key is set. This PR provides a ready-to-use and secure workaround.Type of change