Repository navigation
Conversation
Previously, the example configurations in `example_configurations/` only had `compose.dev.yml`, which builds the image locally from source. The READMEs already referenced the pre-built DockerHub images by name, but there was no compose file that actually used them. This adds a `compose.yml` per profile (repository, registry, discovery) that pulls the matching `eclipsebasyx/basyx-python-*:latest` image instead of building. `docker compose up` now uses the published image by default; `docker compose -f compose.dev.yml up` remains the explicit way to build from source for development. Fixes eclipse-basyx#640
Previously, the repository and discovery examples both used the compose project name `basyx-python-server` with a service called `app`, and the registry example set no name at all. Starting one example with `docker compose up` therefore replaced the container of the other. Each standalone example now uses its own project name (`basyx-python-repository`, `basyx-python-registry`, `basyx-python-discovery`), in both `compose.yml` and `compose.dev.yml`, so they can run side by side.
Previously, the header and separator rows of the AAS Registry table in the registry README were still padded for the old `/api/v3.1.1/` URLs, and the repository README named its image without the `:latest` tag, unlike the registry and discovery READMEs. This realigns the table and adds the missing tag.
Previously, the example configurations only ran a single service each. Users who wanted the repository, registry and discovery servers together had to start three separate compose projects. This adds `example_configurations/combined`, which runs all three services from one `compose.yml` using the pre-built DockerHub images, and from one `compose.dev.yml` that builds them locally. Each service stores its data in its own directory, which is added to `.gitignore`. The server `README.md` now lists the new example and explains the difference between `compose.yml` and `compose.dev.yml`. Fixes eclipse-basyx#640
Previously, no CI job looked at the compose files in `server/example_configurations`, so broken or outdated example configurations went unnoticed. The new job runs `docker compose config --quiet` on every `compose*.yml` file in that directory, which catches both invalid YAML and invalid compose keys. It fails if no compose files are found, so moving the directory cannot silently disable the check.
zrgt
reviewed
Nov 17, 2026
| | **GetDescription** | Return the self‑description of the AAS registry service | `GET http://localhost:8083/api/v3.1.1/description` | | ||
| | Function | Description | Example URL | | ||
| |--------------------------------------------------|----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| | ||
| | **GetAllAssetAdministrationShellDescriptors** | Return all AAS descriptor | `GET http://localhost:8083/api/v3.1/shell-descriptors` | |
Contributor
There was a problem hiding this comment.
Nit, pre-existing and optional since you are touching this table anyway: "Return all AAS descriptor" → "Return all AAS descriptors". Also, # AAS Registry: and # Submodel Registry: are H1 headings under the ## Features section; ### (without the colon) would fit the document structure.
zrgt
requested changes
Nov 17, 2026
Contributor
|
Tested locally at 613e54e (Docker 29.8.2, Compose v5.6.0, macOS). Everything works as described.
Not tested: the standalone |
zrgt
approved these changes
Nov 17, 2026
Previously, the `AAS Registry` and `Submodel Registry` headings in the registry README were H1 headings with a trailing colon, although they belong to the `Features` section. One table row also said "Return all AAS descriptor". This change turns them into H3 headings without the colon and fixes the plural.
image:-based compose files alongside compose.dev.ymlimage:-based example compose files
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.
Previously, the example configurations in
example_configurations/only had acompose.dev.yml, which builds the image from source. The READMEs named the pre-built DockerHub images, but no compose file used them. In addition:/api/v3.0/and/api/v3.1.1/instead of/api/v3.1.basyx-python-server, so starting one replaced the container of the other.This change:
compose.ymlper standalone example that pulls the matchingeclipsebasyx/basyx-python-*:latestimage.docker compose upnow uses the published image, andcompose.dev.ymlstays the way to build from source.combinedexample that runs the repository, registry and discovery services from one compose project, with both acompose.ymland acompose.dev.yml.server-compose-checkCI job, which runsdocker compose config --quieton everycompose*.ymlfile inserver/example_configurations.Fixes #640