Repository navigation
server: Add image:-based example compose files
#659
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
Merged
s-heppner
merged 7 commits into
eclipse-basyx:develop
from
rwth-iat:improve/example-configs-use-published-images
Nov 18, 2026
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
6e065f2
server: Add `image:`-based compose files alongside `compose.dev.yml`
paul-gerber-svg c620281
Fix stale API base path in example_configurations READMEs
paul-gerber-svg 8a038e1
server: Give example compose projects distinct names
s-heppner 057ac27
Align example configuration READMEs
s-heppner aad8229
server: Add `combined` example configuration
s-heppner 613e54e
CI: Add `server-compose-check` job
s-heppner 3b3b277
server: Fix headings and wording in registry README
s-heppner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Combined | ||
| This example Docker compose configuration runs the repository, registry and discovery servers together, using the | ||
| pre-built images from DockerHub: | ||
|
|
||
| - [`eclipsebasyx/basyx-python-repository:latest`](https://hub.docker.com/r/eclipsebasyx/basyx-python-repository) | ||
| - [`eclipsebasyx/basyx-python-registry:latest`](https://hub.docker.com/r/eclipsebasyx/basyx-python-registry) | ||
| - [`eclipsebasyx/basyx-python-discovery:latest`](https://hub.docker.com/r/eclipsebasyx/basyx-python-discovery) | ||
|
|
||
| ``` | ||
| $ docker compose up | ||
| ``` | ||
|
|
||
| To build the images locally from source instead, use `compose.dev.yml`. This is usually only necessary for development: | ||
| ``` | ||
| $ docker compose -f compose.dev.yml up | ||
| ``` | ||
|
|
||
| The servers can be accessed from your host system at: | ||
|
|
||
| | Service | URL | Input | Storage | | ||
| |------------|--------------------------------|----------------------|------------------------| | ||
| | Repository | http://localhost:8080/api/v3.1 | `./repository/input` | `./repository/storage` | | ||
| | Registry | http://localhost:8083/api/v3.1 | `./registry/input` | `./registry/storage` | | ||
| | Discovery | http://localhost:8084/api/v3.1 | - | `./discovery/storage` | | ||
|
|
||
| Each service stores its data persistently in its own directory on your host system. | ||
| For the available endpoints of each service, see the | ||
| [repository](../repository_standalone/README.md), [registry](../registry_standalone/README.md) and | ||
| [discovery](../discovery_standalone/README.md) examples. | ||
| To get a different setup, the `compose.yml` (or `compose.dev.yml`) file can be adapted using the options described in | ||
| the main server [README.md](../../README.md#options). | ||
|
|
||
| Note that `compose.dev.yml` builds the images from the `server` directory. The local `sdk` directory is passed in as an | ||
| additional build context named `sdk`. To include the package license, a second additional build context `license` | ||
| passes in the repository root. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| name: basyx-python-server | ||
| services: | ||
| repository: | ||
| build: | ||
| context: ../.. | ||
| additional_contexts: | ||
| - sdk=../../../sdk | ||
| - license=../../.. | ||
| dockerfile: ./docker/repository/Dockerfile | ||
| ports: | ||
| - "8080:80" | ||
| volumes: | ||
| - ./repository/input:/input | ||
| - ./repository/storage:/storage | ||
| environment: | ||
| STORAGE_PERSISTENCY: True | ||
| registry: | ||
| build: | ||
| context: ../.. | ||
| additional_contexts: | ||
| - sdk=../../../sdk | ||
| - license=../../.. | ||
| dockerfile: ./docker/registry/Dockerfile | ||
| ports: | ||
| - "8083:80" | ||
| volumes: | ||
| - ./registry/input:/input | ||
| - ./registry/storage:/storage | ||
| environment: | ||
| STORAGE_PERSISTENCY: True | ||
| discovery: | ||
| build: | ||
| context: ../.. | ||
| additional_contexts: | ||
| - sdk=../../../sdk | ||
| - license=../../.. | ||
| dockerfile: ./docker/discovery/Dockerfile | ||
| ports: | ||
| - "8084:80" | ||
| environment: | ||
| storage_path: /storage/discovery_store.json | ||
| volumes: | ||
| - ./discovery/storage:/storage |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| name: basyx-python-server | ||
| services: | ||
| repository: | ||
| image: eclipsebasyx/basyx-python-repository:latest | ||
|
zrgt marked this conversation as resolved.
Resolved
|
||
| ports: | ||
| - "8080:80" | ||
| volumes: | ||
| - ./repository/input:/input | ||
| - ./repository/storage:/storage | ||
| environment: | ||
| STORAGE_PERSISTENCY: True | ||
| registry: | ||
| image: eclipsebasyx/basyx-python-registry:latest | ||
| ports: | ||
| - "8083:80" | ||
| volumes: | ||
| - ./registry/input:/input | ||
| - ./registry/storage:/storage | ||
| environment: | ||
| STORAGE_PERSISTENCY: True | ||
| discovery: | ||
| image: eclipsebasyx/basyx-python-discovery:latest | ||
| ports: | ||
| - "8084:80" | ||
| environment: | ||
| storage_path: /storage/discovery_store.json | ||
| volumes: | ||
| - ./discovery/storage:/storage | ||
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
2 changes: 1 addition & 1 deletion
2
server/example_configurations/discovery_standalone/compose.dev.yml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| name: basyx-python-server | ||
| name: basyx-python-discovery | ||
| services: | ||
| app: | ||
| build: | ||
|
|
||
10 changes: 10 additions & 0 deletions
10
server/example_configurations/discovery_standalone/compose.yml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| name: basyx-python-discovery | ||
| services: | ||
| app: | ||
| image: eclipsebasyx/basyx-python-discovery:latest | ||
| ports: | ||
| - "8084:80" | ||
| environment: | ||
| storage_path: /storage/discovery_store.json | ||
| volumes: | ||
| - ./storage:/storage |
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
1 change: 1 addition & 0 deletions
1
server/example_configurations/registry_standalone/compose.dev.yml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| name: basyx-python-registry | ||
| services: | ||
| app: | ||
| build: | ||
|
|
||
11 changes: 11 additions & 0 deletions
11
server/example_configurations/registry_standalone/compose.yml
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| name: basyx-python-registry | ||
| services: | ||
| app: | ||
| image: eclipsebasyx/basyx-python-registry:latest | ||
| ports: | ||
| - "8083:80" | ||
| volumes: | ||
| - ./input:/input | ||
| - ./storage:/storage | ||
| environment: | ||
| STORAGE_PERSISTENCY: True |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.