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

Reorder admin guide

Change-Id: I1781b9a8575f3a35d5bc38fba7bec16ad4062427
parent a06d7e84
No related branches found
No related tags found
No related merge requests found
## Troubleshooting and resetting
If you ever need to restart from 0 (i.e. reset everything and drop existing data) you can do so by deleting the following files in the distribution folder (<your project root folder>/jams): <pre>
<b>The internal jams folder: <your project root folder>/jams/jams
derby.log
oauth.key
oauth.pub
config.json
</b></pre>
This will reset the server to its original state and you will be able to run the configuration wizard again. Before performing this operation, please make sure to shutdown the server.
# Admin Guide # Admin Guide
By default JAMS runs an embedded tomcat server visible on port 8080, however this is not practical for many reasons. This guide is designed By default JAMS runs an embedded tomcat server visible on port 8080, however this is not practical for many reasons. This guide is designed to help you setup Jams to run in a production environment.
to help you setup Jams to run in a production environment.
## JAMS & Nginx ## JAMS & Nginx
...@@ -49,23 +35,18 @@ Typically you would add a new site called ``jams-site.conf`` to your nginx confi ...@@ -49,23 +35,18 @@ Typically you would add a new site called ``jams-site.conf`` to your nginx confi
This is the preferred setup method by most admins, as local traffic is usually ran unencrypted since it is usually either inter-VM connection, a VLAN or another dedicated link. This is the preferred setup method by most admins, as local traffic is usually ran unencrypted since it is usually either inter-VM connection, a VLAN or another dedicated link.
## Troubleshooting and resetting
## Running JAMS as a Linux Service If you ever need to restart from 0 (i.e. reset everything and drop existing data) you can do so by deleting the following files in the distribution folder (<your project root folder>/jams): <pre>
<b>The internal jams folder: <your project root folder>/jams/jams
Running JAMS as a Linux Service is fairly straightforward with systemd - you simply created a service unit file with the following structure: <pre> derby.log
<b>[Unit] oauth.key
Description=JAMS Server oauth.pub
config.json
[Service]
Type=simple
WorkingDirectory=[DIRECTORY WHERE JAMS WAS UNZIPPED]
ExecStart=/usr/bin/java -jar [DIRECTORY WHERE JAMS WAS UNZIPPED]/jams-launcher.jar PORT SSL_CERTIFICATE SSL_CERTIFICATE_KEY
[Install]
WantedBy=multi-user.target
</b></pre> </b></pre>
The parameters PORT, SSL_CERTIFICATE and SSL_CERTIFICATE_KEY are optional (however, PORT can be used alone whereas the SSL_CERTIFICATE comes in pair with SSL_CERTIFICATE_KEY)
This will reset the server to its original state and you will be able to run the configuration wizard again. Before performing this operation, please make sure to shutdown the server.
## Running JAMS as Windows Service ## Running JAMS as Windows Service
...@@ -263,3 +244,20 @@ where PORT_NUMBER is the port number you want to use to serve the application ex ...@@ -263,3 +244,20 @@ where PORT_NUMBER is the port number you want to use to serve the application ex
Now your JAMS application will start with the server. Now your JAMS application will start with the server.
Source: [https://medium.com/@lk.snatch/jar-file-as-windows-service-bonus-jar-to-exe-1b7b179053e4](https://medium.com/@lk.snatch/jar-file-as-windows-service-bonus-jar-to-exe-1b7b179053e4) Source: [https://medium.com/@lk.snatch/jar-file-as-windows-service-bonus-jar-to-exe-1b7b179053e4](https://medium.com/@lk.snatch/jar-file-as-windows-service-bonus-jar-to-exe-1b7b179053e4)
## Running JAMS as a Linux Service
Running JAMS as a Linux Service is fairly straightforward with systemd - you simply created a service unit file with the following structure:
<b>[Unit]
Description=JAMS Server
[Service]
Type=simple
WorkingDirectory=[DIRECTORY WHERE JAMS WAS UNZIPPED]
ExecStart=/usr/bin/java -jar [DIRECTORY WHERE JAMS WAS UNZIPPED]/jams-launcher.jar PORT SSL_CERTIFICATE SSL_CERTIFICATE_KEY
[Install]
WantedBy=multi-user.target
</b>
The parameters PORT, SSL_CERTIFICATE and SSL_CERTIFICATE_KEY are optional (however, PORT can be used alone whereas the SSL_CERTIFICATE comes in pair with SSL_CERTIFICATE_KEY)
\ No newline at end of file
...@@ -68,17 +68,13 @@ ...@@ -68,17 +68,13 @@
</div> </div>
<div class="navbar-collapse collapse card bg-secondary" id="toc-collapse"> <div class="navbar-collapse collapse card bg-secondary" id="toc-collapse">
<ul class="nav flex-column"> <ul class="nav flex-column">
<li class="nav-item" data-level="2"><a class="nav-link" href="#troubleshooting-and-resetting">Troubleshooting and resetting</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="1"><a class="nav-link" href="#admin-guide">Admin Guide</a> <li class="nav-item" data-level="1"><a class="nav-link" href="#admin-guide">Admin Guide</a>
<ul class="nav flex-column"> <ul class="nav flex-column">
<li class="nav-item" data-level="2"><a class="nav-link" href="#jams-nginx">JAMS &amp; Nginx</a> <li class="nav-item" data-level="2"><a class="nav-link" href="#jams-nginx">JAMS &amp; Nginx</a>
<ul class="nav flex-column"> <ul class="nav flex-column">
</ul> </ul>
</li> </li>
<li class="nav-item" data-level="2"><a class="nav-link" href="#running-jams-as-a-linux-service">Running JAMS as a Linux Service</a> <li class="nav-item" data-level="2"><a class="nav-link" href="#troubleshooting-and-resetting">Troubleshooting and resetting</a>
<ul class="nav flex-column"> <ul class="nav flex-column">
</ul> </ul>
</li> </li>
...@@ -86,24 +82,18 @@ ...@@ -86,24 +82,18 @@
<ul class="nav flex-column"> <ul class="nav flex-column">
</ul> </ul>
</li> </li>
<li class="nav-item" data-level="2"><a class="nav-link" href="#running-jams-as-a-linux-service">Running JAMS as a Linux Service</a>
<ul class="nav flex-column">
</ul>
</li>
</ul> </ul>
</li> </li>
</ul> </ul>
</div> </div>
</div></div> </div></div>
<div class="col-md-9" role="main"><a class="md-content__icon pdf-download-btn" download href="../pdf/combined.pdf" title="Download"><i class="fa fas fa-download"></i><small> PDF</small></a> <div class="col-md-9" role="main"><a class="md-content__icon pdf-download-btn" download href="../pdf/combined.pdf" title="Download"><i class="fa fas fa-download"></i><small> PDF</small></a>
<h2 id="troubleshooting-and-resetting">Troubleshooting and resetting</h2>
<p>If you ever need to restart from 0 (i.e. reset everything and drop existing data) you can do so by deleting the following files in the distribution folder (<your folder="" project="" root="">/jams): <pre>
<b>The internal jams folder: <your folder="" project="" root="">/jams/jams
derby.log
oauth.key
oauth.pub
config.json
</your></b></pre></your></p>
<p>This will reset the server to its original state and you will be able to run the configuration wizard again. Before performing this operation, please make sure to shutdown the server.</p>
<h1 id="admin-guide">Admin Guide</h1> <h1 id="admin-guide">Admin Guide</h1>
<p>By default JAMS runs an embedded tomcat server visible on port 8080, however this is not practical for many reasons. This guide is designed <p>By default JAMS runs an embedded tomcat server visible on port 8080, however this is not practical for many reasons. This guide is designed to help you setup Jams to run in a production environment.</p>
to help you setup Jams to run in a production environment.</p>
<h2 id="jams-nginx">JAMS &amp; Nginx</h2> <h2 id="jams-nginx">JAMS &amp; Nginx</h2>
<p>It is generally not recommended to expose JAMS directly to the outside world and while it is required to run JAMS in SSL mode, we usually <p>It is generally not recommended to expose JAMS directly to the outside world and while it is required to run JAMS in SSL mode, we usually
recommend users to place it behind Nginx or a similar web server which proxies requests between the outside world and Jams.</p> recommend users to place it behind Nginx or a similar web server which proxies requests between the outside world and Jams.</p>
...@@ -128,18 +118,15 @@ recommend users to place it behind Nginx or a similar web server which proxies r ...@@ -128,18 +118,15 @@ recommend users to place it behind Nginx or a similar web server which proxies r
} }
}</b></pre></p> }</b></pre></p>
<p>This is the preferred setup method by most admins, as local traffic is usually ran unencrypted since it is usually either inter-VM connection, a VLAN or another dedicated link.</p> <p>This is the preferred setup method by most admins, as local traffic is usually ran unencrypted since it is usually either inter-VM connection, a VLAN or another dedicated link.</p>
<h2 id="running-jams-as-a-linux-service">Running JAMS as a Linux Service</h2> <h2 id="troubleshooting-and-resetting">Troubleshooting and resetting</h2>
<p>Running JAMS as a Linux Service is fairly straightforward with systemd - you simply created a service unit file with the following structure: <pre> <p>If you ever need to restart from 0 (i.e. reset everything and drop existing data) you can do so by deleting the following files in the distribution folder (<your folder="" project="" root="">/jams): <pre>
<b>[Unit] <b>The internal jams folder: <your folder="" project="" root="">/jams/jams
Description=JAMS Server</b></pre></p> derby.log
<p>[Service] oauth.key
Type=simple oauth.pub
WorkingDirectory=[DIRECTORY WHERE JAMS WAS UNZIPPED] config.json
ExecStart=/usr/bin/java -jar [DIRECTORY WHERE JAMS WAS UNZIPPED]/jams-launcher.jar PORT SSL_CERTIFICATE SSL_CERTIFICATE_KEY</p> </your></b></pre></your></p>
<p>[Install] <p>This will reset the server to its original state and you will be able to run the configuration wizard again. Before performing this operation, please make sure to shutdown the server.</p>
WantedBy=multi-user.target
</p></div></div></div></body></html>
<p>The parameters PORT, SSL_CERTIFICATE and SSL_CERTIFICATE_KEY are optional (however, PORT can be used alone whereas the SSL_CERTIFICATE comes in pair with SSL_CERTIFICATE_KEY)</p>
<h2 id="running-jams-as-windows-service">Running JAMS as Windows Service</h2> <h2 id="running-jams-as-windows-service">Running JAMS as Windows Service</h2>
<h3 id="download-and-install-jams">Download and install JAMS</h3> <h3 id="download-and-install-jams">Download and install JAMS</h3>
<p>Visit https://jami.net/services/ and downalod JAMS.</p> <p>Visit https://jami.net/services/ and downalod JAMS.</p>
...@@ -290,6 +277,18 @@ nssm.exe install JAMS ...@@ -290,6 +277,18 @@ nssm.exe install JAMS
<p>where PORT_NUMBER is the port number you want to use to serve the application example 443 or 8443</p> <p>where PORT_NUMBER is the port number you want to use to serve the application example 443 or 8443</p>
<p>Now your JAMS application will start with the server.</p> <p>Now your JAMS application will start with the server.</p>
<p>Source: <a href="https://medium.com/@lk.snatch/jar-file-as-windows-service-bonus-jar-to-exe-1b7b179053e4">https://medium.com/@lk.snatch/jar-file-as-windows-service-bonus-jar-to-exe-1b7b179053e4</a></p> <p>Source: <a href="https://medium.com/@lk.snatch/jar-file-as-windows-service-bonus-jar-to-exe-1b7b179053e4">https://medium.com/@lk.snatch/jar-file-as-windows-service-bonus-jar-to-exe-1b7b179053e4</a></p>
<h2 id="running-jams-as-a-linux-service">Running JAMS as a Linux Service</h2>
<p>Running JAMS as a Linux Service is fairly straightforward with systemd - you simply created a service unit file with the following structure: <br/>
<b>[Unit]
Description=JAMS Server</b></p>
<p>[Service]
Type=simple
WorkingDirectory=[DIRECTORY WHERE JAMS WAS UNZIPPED]
ExecStart=/usr/bin/java -jar [DIRECTORY WHERE JAMS WAS UNZIPPED]/jams-launcher.jar PORT SSL_CERTIFICATE SSL_CERTIFICATE_KEY</p>
<p>[Install]
WantedBy=multi-user.target
</p></div></div></div></body></html>
<p>The parameters PORT, SSL_CERTIFICATE and SSL_CERTIFICATE_KEY are optional (however, PORT can be used alone whereas the SSL_CERTIFICATE comes in pair with SSL_CERTIFICATE_KEY)</p>
<footer class="col-md-12"> <footer class="col-md-12">
......
...@@ -404,5 +404,5 @@ You will be redirected to the JAMS interface.</p> ...@@ -404,5 +404,5 @@ You will be redirected to the JAMS interface.</p>
</html> </html>
<!-- <!--
MkDocs version : 1.1.2 MkDocs version : 1.1.2
Build Date UTC : 2020-11-22 01:04:58.475709+00:00 Build Date UTC : 2020-11-22 01:43:55.216806+00:00
--> -->
No preview for this file type
This diff is collapsed.
No preview for this file type
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