Skip to content

Commit 5cfc07a

Browse files
committed
Fixes #4490 - Update Piranha Core Profile documentation
1 parent 5b07392 commit 5cfc07a

File tree

1 file changed

+44
-1
lines changed
  • dist/coreprofile/src/site/markdown

1 file changed

+44
-1
lines changed

dist/coreprofile/src/site/markdown/index.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,50 @@ The following components are available in the Piranha Core Profile distribution:
1414
* Jakarta JSON Binding
1515
* Jakarta RESTful Web Services
1616

17-
## Documentation
17+
## Download Piranha Core Profile
18+
19+
Piranha Core Profile is available as a JAR file from Maven Central.
20+
21+
The download link below will take you to the location on Maven Central where you
22+
can download any version of Piranha Core Profle. Select the version by clicking
23+
on the directory link and then download the JAR file from there.
24+
25+
<a href="https://repo1.maven.org/maven2/cloud/piranha/dist/piranha-dist-coreprofile/">Download</a>
26+
27+
Note the name of the JAR file you want to download should look like
28+
piranha-dist-coreprofile-X.Y.Z.jar
29+
30+
## Quickstart
31+
32+
Assuming you have downloaded the JAR file as previously indicated running
33+
Piranha Core Profile is as simple as:
34+
35+
```
36+
java -jar piranha-dist-coreprofile-X.Y.Z.jar --war-file your-webapplication.war
37+
```
38+
39+
## Running using Docker
40+
41+
If you want to run Piranha Core Profile using Docker we have a base image
42+
available for you using Eclipse Temurin as the underlying runtime.
43+
44+
See https://github.com/piranhacloud/piranha/pkgs/container/coreprofile for
45+
more information and how to pull that image.
46+
47+
To use this as a base image you would create your own Dockerfile and add your
48+
WAR file using a COPY and change the CMD to point to your WAR file as
49+
illustrated below:
50+
51+
```Dockerfile
52+
FROM ghcr.io/piranhacloud/coreprofile:latest
53+
COPY target/my.war my.war
54+
USER root
55+
RUN chown -R piranha:piranha /home/piranha
56+
USER piranha
57+
CMD ["java", "-jar", "piranha-dist-coreprofile.jar", "--war-file", "my.war"]
58+
```
59+
60+
## Guides
1861

1962
1. [Create a REST service](create_a_rest_service.html)
2063
1. [Create a JSON REST service](create_a_json_rest_service.html)

0 commit comments

Comments
 (0)