Skip to content

Commit

Permalink
Fixes #4531 - Update Piranha Server documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mnriem committed Jan 16, 2025
1 parent cd1d837 commit 1177bb2
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions dist/server/src/site/markdown/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,62 @@ The following components are available in the Piranha Server distribution:
* Jakarta Servlet
* Jakarta WebSocket

## Download Piranha Server

Piranha Server is available as a zip or tar.gz 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 Server. Select the version by clicking
on the directory link and then download the zip or tar.gz file from there.

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

Note the name of the JAR file you want to download should look like
piranha-dist-server-X.Y.Z.zip or piranha-dist-server-X.Y.Z.tar.gz

## Starting the server

Assuming you have downloaded the zip or tar.gz file as previously indicated you
will need to unzip it into a directory of your choice. Then by going to the
`bin` directory you can run Piranha Server by issuing the following command
line:

```
./start.sh
```

On Windows use `start.cmd` instead.

## Stopping the server

To stop the server use:

```
./stop.sh
```

On Windows use `stop.cmd` instead.

## Deploying your application

Deploying your web application is as simple as copying your WAR file into the
`webapps` directory of the server and then stopping and starting the server.

## Running using Docker

If you want to run Piranha Server using Docker we have a base image
available for you using Eclipse Temurin as the Java runtime.

See https://github.com/orgs/piranhacloud/packages/container/package/server 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 as illustrated below:

```Dockerfile
FROM ghcr.io/piranhacloud/server:latest
COPY target/my.war /home/piranha/piranha/webapps/my.war
```
## Documentation

1. [Create a Hello World web application](create_a_hello_world_web_application.html)

0 comments on commit 1177bb2

Please sign in to comment.