Skip to content

chore: add docker-compose deployment and improve container networking instructions#280

Merged
imbajin merged 11 commits intoapache:mainfrom
hugegraph:docker
Jul 1, 2025
Merged

chore: add docker-compose deployment and improve container networking instructions#280
imbajin merged 11 commits intoapache:mainfrom
hugegraph:docker

Conversation

@weijinglin
Copy link
Collaborator

This PR updates the hugegraph-llm/README.md and related Docker files to:

  • Add a new recommended deployment method using docker-compose (docker/docker-compose-network.yml), enabling one-command startup of both HugeGraph Server and RAG containers in the same network.
  • Clearly distinguish between docker-compose (multi-container, recommended) and manual single-container deployment, with step-by-step instructions for both.
  • Provide explicit examples for .env mounting, network creation, and container inter-communication (using container name as hostname).

This update makes it much easier for users to deploy, manage, and connect the RAG and HugeGraph containers, and helps avoid common pitfalls with Docker networking and environment configuration.

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jun 24, 2025
@github-actions github-actions bot added the llm label Jun 24, 2025
@dosubot dosubot bot added the documentation Improvements or additions to documentation label Jun 24, 2025
Copy link
Member

Choose a reason for hiding this comment

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

How do users know the key of configuration items 🤔

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The .env config file here is different from the .env file generated by rag demo. This config file is located in project_dir/docker directory & used in docker-compose deployment (only PROJECT_PATH is needed)

weijinglin and others added 8 commits June 25, 2025 14:24
Co-authored-by: imbajin <jin@apache.org>
Co-authored-by: imbajin <jin@apache.org>
Co-authored-by: imbajin <jin@apache.org>
Co-authored-by: imbajin <jin@apache.org>
Co-authored-by: imbajin <jin@apache.org>
Improves the main and hugegraph-llm README files for clarity, structure, and usability. Adds architecture diagrams, clearer quick start and deployment instructions, concise feature lists, and expanded usage examples for both web and code interfaces. Removes outdated links and redundant sections, and updates configuration and resource references for better onboarding.
@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Jul 1, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jul 1, 2025
@imbajin imbajin merged commit b027744 into apache:main Jul 1, 2025
10 checks passed
@imbajin imbajin deleted the docker branch July 1, 2025 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer llm size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants