From e7b88b6bd0e641c4ef6fa36e4ae5cf85cfe39907 Mon Sep 17 00:00:00 2001 From: Tunahan Cicek Date: Tue, 20 Feb 2024 13:37:25 +0100 Subject: [PATCH] separate docker notice file --- .../publish-image-discovery-finder.yml | 3 ++- DOCKER_NOTICE.md | 24 +++++++++++++++++++ README.md | 24 +------------------ 3 files changed, 27 insertions(+), 24 deletions(-) create mode 100644 DOCKER_NOTICE.md diff --git a/.github/workflows/publish-image-discovery-finder.yml b/.github/workflows/publish-image-discovery-finder.yml index 3427e28..5f0915a 100644 --- a/.github/workflows/publish-image-discovery-finder.yml +++ b/.github/workflows/publish-image-discovery-finder.yml @@ -102,4 +102,5 @@ jobs: with: username: ${{ secrets.DOCKER_HUB_USER }} password: ${{ secrets.DOCKER_HUB_TOKEN }} - repository: ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }} \ No newline at end of file + repository: ${{ env.IMAGE_NAMESPACE }}/${{ env.IMAGE_NAME }} + readme-filepath: ./DOCKER_NOTICE.md \ No newline at end of file diff --git a/DOCKER_NOTICE.md b/DOCKER_NOTICE.md new file mode 100644 index 0000000..e6675c6 --- /dev/null +++ b/DOCKER_NOTICE.md @@ -0,0 +1,24 @@ +## Notice for Docker image +This application provides container images for demonstrations purposes. + +DockerHub: [https://hub.docker.com/r/tractusx/sldt-discovery-finder] (https://hub.docker.com/r/tractusx/sldt-discovery-finder) + +Eclipse Tractus-X product(s) installed within the image: + +Discovery Finder + +- GitHub: https://github.com/eclipse-tractusx/sldt-discovery-finder +- Project home: https://projects.eclipse.org/projects/automotive.tractusx +- Dockerfile: https://github.com/eclipse-tractusx/sldt-discovery-finder/blob/main/backend/Dockerfile +- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/item-relationship-service/blob/main/LICENSE) + +**Used base image** + +- [eclipse-temurin:17-jre-alpine](https://github.com/adoptium/containers) +- Official Eclipse Temurin DockerHub page: https://hub.docker.com/_/eclipse-temurin +- Eclipse Temurin Project: https://projects.eclipse.org/projects/adoptium.temurin +- Additional information about the Eclipse Temurin images: https://github.com/docker-library/repo-info/tree/master/repos/eclipse-temurin + +As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained). + +As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within. diff --git a/README.md b/README.md index 0e57f90..499de7f 100644 --- a/README.md +++ b/README.md @@ -34,26 +34,4 @@ Run `docker build -f backend/Dockerfile -t sldt-discovery-finder .` In case you want to publish your image into a remote container registry, apply the tag accordingly and `docker push` the image. ## Install Instructions -For detailed install instructions please refer to our [INSTALL.md](https://github.com/eclipse-tractusx/sldt-discovery-finder/blob/main/INSTALL.md). - -## Notice for Docker image - -DockerHub: [https://hub.docker.com/r/tractusx/sldt-discovery-finder] (https://hub.docker.com/r/tractusx/sldt-discovery-finder) -This application provides container images for demonstrations purposes. -Eclipse Tractus-X product(s) installed within the image: - -- GitHub: https://github.com/eclipse-tractusx/sldt-discovery-finder -- Project home: https://projects.eclipse.org/projects/automotive.tractusx -- Dockerfile: https://github.com/eclipse-tractusx/sldt-discovery-finder/blob/main/backend/Dockerfile -- Project license: Apache License, Version 2.0 - -**Used base image** - -- eclipse-temurin:17-jre-alpine -- Official Eclipse Temurin DockerHub page: https://hub.docker.com/_/eclipse-temurin -- Eclipse Temurin Project: https://projects.eclipse.org/projects/adoptium.temurin -- Additional information about the Eclipse Temurin images: https://github.com/docker-library/repo-info/tree/master/repos/eclipse-temurin - -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained). - -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within. +For detailed install instructions please refer to our [INSTALL.md](https://github.com/eclipse-tractusx/sldt-discovery-finder/blob/main/INSTALL.md). \ No newline at end of file