Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #4531 - Update Piranha Server documentation #4533

Merged
merged 1 commit into from
Jan 16, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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)
Loading