Skip to content

Commit

Permalink
Fixes #4490 - Update Piranha Core Profile documentation (#4529)
Browse files Browse the repository at this point in the history
  • Loading branch information
mnriem authored Jan 14, 2025
1 parent 5b07392 commit 8ce00b3
Showing 1 changed file with 44 additions and 1 deletion.
45 changes: 44 additions & 1 deletion dist/coreprofile/src/site/markdown/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<a href="https://repo1.maven.org/maven2/cloud/piranha/dist/piranha-dist-coreprofile/">Download</a>

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)
Expand Down

0 comments on commit 8ce00b3

Please sign in to comment.