Skip to content
Snippets Groups Projects
Commit e2b8a574 authored by Larbi Gharib's avatar Larbi Gharib
Browse files

Readme openssl

Change-Id: If70d806c3ebff76b99c257c382c6b9294a92294d
parent 0330cc15
No related branches found
No related tags found
No related merge requests found
......@@ -2,37 +2,43 @@
##### Requirements
* JDK 11+
* maven
- JDK 11+
- maven
##### Building from source
Clone the contents of this repository and run
```
mvn clean packge
mvn clean package
```
This will create a distribution folder called ``jams`` in the root folder. You can
This will create a distribution folder called `jams` in the root folder. You can
then launch the server by running
```java -jar jams-launcher```
`java -jar jams-launcher`
If you want to start the server with an SSL certificate and on a port different
from 8080, then run:
```java -jar jams-launcher 8443 server.pem server.key```
`java -jar jams-launcher 8443 server.pem server.key`
Where the ``pem`` and ``key`` files are a pem encoded certificate and key.
Where the `pem` and `key` files are a pem encoded certificate and key.
To generate the documentation you will need ``apidoc`` installed on your system.
This can be completed by running ``npm install -g apidoc``, if for some reason
that does not work, you can clone their project from : https://github.com/apidoc/apidoc
##### How to generate server.pem and server.key pair
In order to generate a pair of pem and key use the following command using openssl
`openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout server.key -out server.pem`
To generate the documentation you will need `apidoc` installed on your system.
This can be completed by running `npm install -g apidoc`, if for some reason
that does not work, you can clone their project from : https://github.com/apidoc/apidoc
and install it from source.
To build the documentation, change enter the ``jams-server`` directory and simply run:
To build the documentation, change enter the `jams-server` directory and simply run:
```apidoc -i src/ -o doc/```
`apidoc -i src/ -o doc/`
##### Building the Docker container
......@@ -47,4 +53,3 @@ To run the docker container (assuming you want to have it on port 80 locally):
```
docker run -p 80:8080 --rm jams:latest
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment