Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
jami-jams
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
savoirfairelinux
jami-jams
Commits
e2b8a574
Commit
e2b8a574
authored
4 years ago
by
Larbi Gharib
Browse files
Options
Downloads
Patches
Plain Diff
Readme openssl
Change-Id: If70d806c3ebff76b99c257c382c6b9294a92294d
parent
0330cc15
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+18
-13
18 additions, 13 deletions
README.md
with
18 additions
and
13 deletions
README.md
+
18
−
13
View file @
e2b8a574
...
...
@@ -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 pack
a
ge
```
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
```
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment