From 8ce00b3e1c08f7b298ee74a200b72bc715050746 Mon Sep 17 00:00:00 2001 From: Manfred Riem Date: Tue, 14 Jan 2025 16:24:51 -0600 Subject: [PATCH] Fixes #4490 - Update Piranha Core Profile documentation (#4529) --- dist/coreprofile/src/site/markdown/index.md | 45 ++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/dist/coreprofile/src/site/markdown/index.md b/dist/coreprofile/src/site/markdown/index.md index a286fa346..4697f9924 100644 --- a/dist/coreprofile/src/site/markdown/index.md +++ b/dist/coreprofile/src/site/markdown/index.md @@ -14,7 +14,50 @@ The following components are available in the Piranha Core Profile distribution: * Jakarta JSON Binding * Jakarta RESTful Web Services -## Documentation +## Download Piranha Core Profile + +Piranha Core Profile is available as a JAR file from Maven Central. + +The download link below will take you to the location on Maven Central where you +can download any version of Piranha Core Profle. Select the version by clicking +on the directory link and then download the JAR file from there. + +Download + +Note the name of the JAR file you want to download should look like +piranha-dist-coreprofile-X.Y.Z.jar + +## Quickstart + +Assuming you have downloaded the JAR file as previously indicated running +Piranha Core Profile is as simple as: + +``` +java -jar piranha-dist-coreprofile-X.Y.Z.jar --war-file your-webapplication.war +``` + +## Running using Docker + +If you want to run Piranha Core Profile using Docker we have a base image +available for you using Eclipse Temurin as the underlying runtime. + +See https://github.com/piranhacloud/piranha/pkgs/container/coreprofile for +more information and how to pull that image. + +To use this as a base image you would create your own Dockerfile and add your +WAR file using a COPY and change the CMD to point to your WAR file as +illustrated below: + +```Dockerfile +FROM ghcr.io/piranhacloud/coreprofile:latest +COPY target/my.war my.war +USER root +RUN chown -R piranha:piranha /home/piranha +USER piranha +CMD ["java", "-jar", "piranha-dist-coreprofile.jar", "--war-file", "my.war"] +``` + +## Guides 1. [Create a REST service](create_a_rest_service.html) 1. [Create a JSON REST service](create_a_json_rest_service.html)