diff --git a/README.md b/README.md index d4de3634..1203a3f4 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,12 @@ The project is made of a backend and a frontend. Look into the respective folder information about prerequirements and getting started guides. ## License + The project is licensed under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). For details on the licensing terms, see the `LICENSE` file. ## Notice for Docker Image + This application provides container images for demonstration purposes. Eclipse Tractus-X product(s) installed within the image: @@ -25,15 +27,20 @@ Eclipse Tractus-X product(s) installed within the image: - Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/puris/blob/main/LICENSE) **Used Base Image [Frontend]** -- `node:lts-alpine` -- DockerHub: https://hub.docker.com/_/node/ -- GitHub project: https://github.com/nodejs/docker-node + +`nginxinc/nginx-unprivileged:alpine` + +- DockerHub: https://hub.docker.com/r/nginxinc/nginx-unprivileged +- GitHub project: https://github.com/nginxinc/docker-nginx-unprivileged **Used Base Image [Backend]** -- `maven:3.8.7-eclipse-temurin-17` -- DockerHub: https://hub.docker.com/_/maven/ -- GitHub project: https://github.com/carlossg/docker-maven +`eclipse-temurin:17-jre-alpine` + +- DockerHub: https://hub.docker.com/_/eclipse-temurin +- GitHub project: https://github.com/adoptium/containers -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 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. +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/backend/README.md b/backend/README.md index 32279223..b47b1745 100644 --- a/backend/README.md +++ b/backend/README.md @@ -4,12 +4,13 @@ ## Table of Contents + - [Prerequirements](#prerequirements) - [Getting Started](#getting-started) - [License](#license) - ## Prerequirements + The following things are needed to start PURIS: - A Java Runtime Environment + Maven or an equivalent Docker setup @@ -21,10 +22,12 @@ The following things are needed to start PURIS: See the [installation instructions](INSTALL.md) for information on how to start the application. ## License + The project is licensed under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). For details on the licensing terms, see the `LICENSE` file. ## Notice for Docker Image + This application provides container images for demonstration purposes. Eclipse Tractus-X product(s) installed within the image: @@ -34,12 +37,14 @@ Eclipse Tractus-X product(s) installed within the image: - Dockerfile Backend: https://github.com/eclipse-tractusx/puris/blob/main/backend/Dockerfile - Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/puris/blob/main/backend/LICENSE) - **Used Base Image [Backend]** -- `maven:3.8.7-eclipse-temurin-17` -- DockerHub: https://hub.docker.com/_/maven/ -- GitHub project: https://github.com/carlossg/docker-maven +`eclipse-temurin:17-jre-alpine` + +- DockerHub: https://hub.docker.com/_/eclipse-temurin +- GitHub project: https://github.com/adoptium/containers -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 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. +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/frontend/Dockerfile b/frontend/Dockerfile index ee1e03be..3157922a 100644 --- a/frontend/Dockerfile +++ b/frontend/Dockerfile @@ -1,7 +1,7 @@ # -# Copyright (c) 2022,2023 Volkswagen AG -# Copyright (c) 2022,2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) -# Copyright (c) 2022,2023 Contributors to the Eclipse Foundation +# Copyright (c) 2022-2024 Volkswagen AG +# Copyright (c) 2022-2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +# Copyright (c) 2022-2024 Contributors to the Eclipse Foundation # # See the NOTICE file(s) distributed with this work for additional # information regarding copyright ownership. @@ -47,7 +47,7 @@ COPY NOTICE.md /app/dist/NOTICE.md COPY DEPENDENCIES /app/dist/DEPENDENCIES # uses 101 restricted user -FROM nginxinc/nginx-unprivileged:stable-alpine +FROM nginxinc/nginx-unprivileged:alpine #FROM nginx:stable-alpine # commly it would be .../html/js/.*js, but due to the project structure the JS files are in .../html/assets @@ -64,6 +64,8 @@ RUN apk --no-cache add moreutils # use non-root user USER 101 +HEALTHCHECK --interval=30s --timeout=3s CMD wget -O /dev/null http://localhost:8080 || exit 1 + WORKDIR /usr/share/nginx/html COPY --from=build /app/dist . ENTRYPOINT [ "start-nginx.sh" ] diff --git a/frontend/README.md b/frontend/README.md index 5bcbe97b..f4df5dfd 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -4,12 +4,13 @@ ## Table of Contents + - [Prerequirements](#prerequirements) - [Getting Started](#getting-started) - [License](#license) - ## Prerequirements + The following things are needed to start PURIS: - `npm` or an equivalent Docker setup @@ -20,10 +21,12 @@ The following things are needed to start PURIS: See the [installation instructions](INSTALL.md) for information on how to start the application. ## License + The project is licensed under the [Apache License Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). For details on the licensing terms, see the `LICENSE` file. ## Notice for Docker Image + This application provides container images for demonstration purposes. Eclipse Tractus-X product(s) installed within the image: @@ -34,10 +37,13 @@ Eclipse Tractus-X product(s) installed within the image: - Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/puris/blob/main/frontend/LICENSE) **Used Base Image [Frontend]** -- `node:lts-alpine` -- DockerHub: https://hub.docker.com/_/node/ -- GitHub project: https://github.com/nodejs/docker-node +`nginxinc/nginx-unprivileged:alpine` + +- DockerHub: https://hub.docker.com/r/nginxinc/nginx-unprivileged +- GitHub project: https://github.com/nginxinc/docker-nginx-unprivileged -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 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. +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.