Skip to content

docs: add Docker Hub pull instructions to server README #489

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.

Sign up for GitHub

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
zrgt merged 1 commit into from
May 4, 2026
Merged

docs: add Docker Hub pull instructions to server README #489

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,22 @@ The files are only read, changes won't persist.
Alternatively, the container can also be told to use the [Local-File Backend][2] instead, which stores Asset Administration Shells (AAS) and Submodels as individual *JSON* files and allows for persistent changes (except supplementary files, i.e. files referenced by `File` SubmodelElements).
See [below](#options) on how to configure this.

## Docker Hub

Pre-built images are published to [Docker Hub][11] on every release.
Pull the latest version via:
```
$ docker pull eclipsebasyx/basyx-python-server:latest
```

Or pin to a specific release:
```
$ docker pull eclipsebasyx/basyx-python-server:2.0.1
```

## Building

The container image can be built via:
If you need to build the image locally (e.g. for development), run:
```
$ docker build -t basyx-python-server -f Dockerfile ..
```
Expand Down Expand Up @@ -130,3 +143,4 @@ This Dockerfile is inspired by the [tiangolo/uwsgi-nginx-docker][10] repository.
[8]: https://basyx-python-sdk.readthedocs.io/en/latest/adapter/json.html
[9]: https://basyx-python-sdk.readthedocs.io/en/latest/adapter/xml.html
[10]: https://github.com/tiangolo/uwsgi-nginx-docker
[11]: https://hub.docker.com/r/eclipsebasyx/basyx-python-server
Loading