Enhance README with Docker instructions#14
Enhance README with Docker instructions#14berezovskyi wants to merge 1 commit intoOpen-MBEE:developfrom
Conversation
Added Docker Compose instructions for running services and updated run command for SysML v2 server.
There was a problem hiding this comment.
Pull request overview
This PR enhances the README documentation by adding Docker Compose instructions for running the SysML v2 microservice along with its prerequisite services. The changes improve the developer experience by providing multiple deployment options and aligning port configurations.
- Added Docker Compose instructions as the primary method for running the full service stack
- Updated manual Docker run command to use port 8083 (matching Docker Compose) and bind to loopback address for improved security
- Added clarifying text to differentiate between running the full stack vs. a single container
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| docker compose -f .\docker-compose\docker-compose.yml up | ||
| ``` | ||
|
|
||
| To run a single container for the SysML v2 server (other components need to be started separately): | ||
|
|
||
| ``` | ||
| docker build -t org.openmbee.flexo.sysmlv2 . | ||
| docker run -p 8080:8080 org.openmbee.flexo.sysmlv2 | ||
| docker run -p 127.0.0.1:8083:8080 org.openmbee.flexo.sysmlv2 |
There was a problem hiding this comment.
The documentation states that binding to a loopback IP address is to avoid unintentionally exposing services externally, but this instruction only applies to the manual Docker run command. The Docker Compose file at docker-compose/docker-compose.yml uses "8083:8080" without loopback binding, which would expose the service externally. For consistency with the security goal, consider documenting this difference or ensuring both methods follow the same security practice.
| Via Docker Compose that starts the prerequisite services: | ||
|
|
||
| ``` | ||
| docker compose -f .\docker-compose\docker-compose.yml up |
There was a problem hiding this comment.
The path uses backslashes which are Windows-specific. For better cross-platform compatibility, use forward slashes instead. Docker Compose accepts forward slashes on all platforms including Windows.
| docker compose -f .\docker-compose\docker-compose.yml up | |
| docker compose -f ./docker-compose/docker-compose.yml up |
|
added changes to develop |
Added Docker Compose instructions for running services. Other changes: