Skip to content
Snippets Groups Projects
Commit d3686148 authored by ovari's avatar ovari Committed by ovari
Browse files

jams/admin.md: cleanup 

linkify
fix ordered list, i.e. numbering
fix formatting of code

Change-Id: I0bc8b4bcef1cc0b08f388f37c64737a872815eb3
parent 764cc77f
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
Showing
with 179 additions and 179 deletions
jams/admin.md
+ 179
− 179
View file @ d3686148
...@@ -91,30 +91,30 @@ The parameters **PORT**, **SSL_CERTIFICATE** and **SSL_CERTIFICATE_KEY** are opt ...@@ -91,30 +91,30 @@ The parameters **PORT**, **SSL_CERTIFICATE** and **SSL_CERTIFICATE_KEY** are opt
### A. Download and install JAMS ### A. Download and install JAMS
1. Visit https://jami.biz/ and download JAMS. 1. Visit <https://jami.biz/> and download JAMS.
1. Extract JAMS to C:\jams 2. Extract JAMS to C:\jams
### B. Download and install Java Development Kit (JDK) ### B. Download and install Java Development Kit (JDK)
1. Download JDK 11 from https://www.oracle.com/java/technologies/javase-jdk11-downloads.html (choose the corresponding VM architecture). 1. Download JDK 11 from <https://www.oracle.com/java/technologies/javase-jdk11-downloads.html> (choose the corresponding VM architecture).
1. Install it using the installation wizard. 2. Install it using the installation wizard.
### C. Download OpenSSL to generate a key and a certificate ### C. Download OpenSSL to generate a key and a certificate
1. Download the OpenSSL Binary Distributions for Microsoft Windows from https://kb.firedaemon.com/support/solutions/articles/4000121705. 1. Download the OpenSSL Binary Distributions for Microsoft Windows from <https://kb.firedaemon.com/support/solutions/articles/4000121705>.
Alternatively, select another [OpenSSL binary](https://wiki.openssl.org/index.php/Binaries). Alternatively, select another [OpenSSL binary](https://wiki.openssl.org/index.php/Binaries).
1. Once downloaded, extract it to `C:\openssl`. 2. Once downloaded, extract it to `C:\openssl`.
1. Create a `bin` folder inside, i.e., `C:\openssl\bin`. 3. Create a `bin` folder inside, i.e., `C:\openssl\bin`.
1. Create a new file inside the `bin` folder named `openssl.cnf` (make sure that the file extension is `.cnd` and not `.cnd.txt`). 4. Create a new file inside the `bin` folder named `openssl.cnf` (make sure that the file extension is `.cnd` and not `.cnd.txt`).
1. Copy and paste the default configuration below from http://www.flatmtn.com/article/setting-openssl-create-certificates.html. 5. Copy and paste the default configuration below from <http://www.flatmtn.com/article/setting-openssl-create-certificates.html>.
<pre> <pre>
<i># <i>#
# OpenSSL configuration file. # OpenSSL configuration file.
...@@ -159,7 +159,7 @@ The parameters **PORT**, **SSL_CERTIFICATE** and **SSL_CERTIFICATE_KEY** are opt ...@@ -159,7 +159,7 @@ The parameters **PORT**, **SSL_CERTIFICATE** and **SSL_CERTIFICATE_KEY** are opt
<b>[req_distinguished_name]</b> <b>[req_distinguished_name]</b>
<i># Variable name Prompt string <i># Variable name Prompt string
#------------------------- ----------------------------------</i> #-------------------------- -----------------------------------------------</i>
0.organizationName = Organization Name (company) 0.organizationName = Organization Name (company)
organizationalUnitName = Organizational Unit Name (department, division) organizationalUnitName = Organizational Unit Name (department, division)
emailAddress = Email Address emailAddress = Email Address
...@@ -174,7 +174,7 @@ The parameters **PORT**, **SSL_CERTIFICATE** and **SSL_CERTIFICATE_KEY** are opt ...@@ -174,7 +174,7 @@ The parameters **PORT**, **SSL_CERTIFICATE** and **SSL_CERTIFICATE_KEY** are opt
<i># Default values for the above, for consistency and less typing. <i># Default values for the above, for consistency and less typing.
# Variable name Value # Variable name Value
------------------------ ------------------------------</i> #-------------------------- -----------------------------------------------</i>
0.organizationName_default = My Company 0.organizationName_default = My Company
localityName_default = My Town localityName_default = My Town
stateOrProvinceName_default = State or Province stateOrProvinceName_default = State or Province
...@@ -201,17 +201,17 @@ In System variables, edit **Path** and add `C:\openssl\`. ...@@ -201,17 +201,17 @@ In System variables, edit **Path** and add `C:\openssl\`.
1. Open the **Command Prompt**. 1. Open the **Command Prompt**.
1. Execute the following command to set the path to the OpenSSL configuration file. 2. Execute the following command to set the path to the OpenSSL configuration file.
`set OPENSSL_CONF=C:\openssl\bin\openssl.cnf` `set OPENSSL_CONF=C:\openssl\bin\openssl.cnf`
1. Type `cd C:\jams` 3. Type `cd C:\jams`
1. To generate the **Key** and **Certificate**, type: 4. To generate the **Key** and **Certificate**, type:
`openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout server.key -out server.pem` `openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout server.key -out server.pem`
1. Follow the wizard. 5. Follow the wizard.
1. Once the key and certificate are generated, type `dir`. 6. Once the key and certificate are generated, type `dir`.
The output should look like: The output should look like:
<pre> <pre>
C:\jams>dir C:\jams>dir
...@@ -230,77 +230,77 @@ C:\jams>dir ...@@ -230,77 +230,77 @@ C:\jams>dir
3 Dir(s) 93,365,936,128 bytes free 3 Dir(s) 93,365,936,128 bytes free
</pre> </pre>
1. Execute the following command to start JAMS: 7. Execute the following command to start JAMS:
`java -jar jams-launcher.jar PORT_NUMBER (eg. 8443 or 443) server.pem server.key` `java -jar jams-launcher.jar PORT_NUMBER (eg. 8443 or 443) server.pem server.key`
1. Open a navigator on the server and visit https://localhost:443 or https://localhost:8443 to validate that JAMS is working. 8. Open a navigator on the server and visit <https://localhost:443> or <https://localhost:8443> to validate that JAMS is working.
1. Type CTRL+C to close the application. 9. Type CTRL+C to close the application.
### F. Expose the localhost to the Internet ### F. Expose the localhost to the Internet
1. Click on **Windows** and search for ***Windows Defender Firewall with Advanced Security***. 1. Click on **Windows** and search for ***Windows Defender Firewall with Advanced Security***.
1. Right-click **Inbound Rules** and click **New Rule…** 2. Right-click **Inbound Rules** and click **New Rule…**
1. Select **Port**, click **Next**. 3. Select **Port**, click **Next**.
1. Specify the port to use, for example, ***443*** or ***8443***, and click **Next**. 4. Specify the port to use, for example, ***443*** or ***8443***, and click **Next**.
1. Select **Allow the connection** and click **Next**. 5. Select **Allow the connection** and click **Next**.
1. Leave Domain Private and Public unchanged, and click **Next**. 6. Leave Domain Private and Public unchanged, and click **Next**.
1. Name the rule ***JAMS Inbound*** and click **Finish**. 7. Name the rule ***JAMS Inbound*** and click **Finish**.
1. Right-click on **Outbound Rules** and click **New Rule…** 8. Right-click on **Outbound Rules** and click **New Rule…**
1. Select **Port**, click **Next**. 9. Select **Port**, click **Next**.
1. Specify the port to use, for example, ***443*** or ***8443***, and click **Next**. 10. Specify the port to use, for example, ***443*** or ***8443***, and click **Next**.
1. Select **Allow the connection** and click **Next**. 11. Select **Allow the connection** and click **Next**.
1. Leave Domain Private and Public unchanged, and click **Next**. 12. Leave Domain Private and Public unchanged, and click **Next**.
1. Name the rule ***JAMS Outbound*** and click **Finish**. 13. Name the rule ***JAMS Outbound*** and click **Finish**.
1. The localhost is now available on the Internet. 14. The localhost is now available on the Internet.
The application can now be visited through the server domain name or IP address on port 443 or 8443. The application can now be visited through the server domain name or IP address on port 443 or 8443.
### G. Create a JAMS Windows Service (Embed Tomcat Server Windows Service) to start JAMS with the server ### G. Create a JAMS Windows Service (Embed Tomcat Server Windows Service) to start JAMS with the server
1. In order to create a JAMS Windows Service, the **NSSM (the Non-Sucking Service Manager)** can be used. 1. In order to create a JAMS Windows Service, the **NSSM (the Non-Sucking Service Manager)** can be used.
NSSM is available at http://nssm.cc/download and [https://github.com/kirillkovalenko/nssm](https://github.com/kirillkovalenko/nssm). NSSM is available at <http://nssm.cc/download> and <https://github.com/kirillkovalenko/nssm>.
1. Once NSSM has successfully downloaded, open a **Command Prompt** and change the directory to: 2. Once NSSM has successfully downloaded, open a **Command Prompt** and change the directory to:
<pre> <pre>
nssm-2.24\win64 nssm-2.24\win64
</pre> </pre>
1. To install and open a graphical user interface (GUI), type: 3. To install and open a graphical user interface (GUI), type:
<pre> <pre>
nssm.exe install JAMS nssm.exe install JAMS
</pre> </pre>
1. In the **Path** field, specify the path to the Java executable, for example: 4. In the **Path** field, specify the path to the Java executable, for example:
<pre> <pre>
"C:\Program Files\Common Files\Oracle\Java\javapath\java.exe" "C:\Program Files\Common Files\Oracle\Java\javapath\java.exe"
</pre> </pre>
1. In the **Startup directory**, for the installation folder path, type: 5. In the **Startup directory**, for the installation folder path, type:
<pre> <pre>
"C:\jams" "C:\jams"
</pre> </pre>
1. In the last field, add the following arguments: 6. In the last field, add the following arguments:
<pre> <pre>
-classpath "C:\jams" -jar jams-launcher.jar PORT_NUMBER server.pem server.key -classpath "C:\jams" -jar jams-launcher.jar PORT_NUMBER server.pem server.key
</pre> </pre>
where **PORT_NUMBER** is the port number to use to serve the application, for example, ***443*** or ***8443***. where **PORT_NUMBER** is the port number to use to serve the application, for example, ***443*** or ***8443***.
1. Now the JAMS application will start with the server. 7. Now the 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>
\ No newline at end of file \ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment