diff --git a/userguide/docs/admin.md b/userguide/docs/admin.md
index bac9ef04a6e84c4d9ed3401bbaf9dcf3fc49564c..67d91bc7ac19d9083007777d884bc740ba3fd5ef 100644
--- a/userguide/docs/admin.md
+++ b/userguide/docs/admin.md
@@ -25,7 +25,7 @@ recommend users to place it behind Nginx or a similar web server which proxies r
The following is an example map of how you could configure JAMS behind Nginx (the process would be similar if you wanted to use any other type of proxying solution):
<p align="center">
- <img src="./img/map.png" alt="Create an admin account" style="height:250px;width:600px"/>
+ <img src="../img/map.png" alt="Create an admin account" style="height:250px;width:600px"/>
</p>
The IP 10.10.0.1 is random, and should be seen as an example.
@@ -69,19 +69,19 @@ The parameters PORT, SSL_CERTIFICATE and SSL_CERTIFICATE_KEY are optional (howev
## Running JAMS as Windows Service
-# Download and install JAMS
+### Download and install JAMS
Visit https://jami.net/services/ and downalod JAMS.
Extract JAMS to c:\jams
-# Download and install JDK 11
+### Download and install JDK 11
Download JDK 11 from https://www.oracle.com/java/technologies/javase-jdk11-downloads.html (choose the conresponding architecture of your VM)
Install it using the install wizard.
-# Download openssl to generate a key and a certificate
+### Download openssl to generate a key and a certificate
Download OpenSSL from https://kb.firedaemon.com/support/solutions/articles/4000121705 (or choose another source https://wiki.openssl.org/index.php/Binaries)
@@ -89,6 +89,8 @@ Once downloaded extract it to c:\openssl then create a folder bin inside c:\open
Create a new file inside bin named openssl.cnf (make sure that the file extension is .cnd and not .cnd.txt) and copy past the following default configuration http://www.flatmtn.com/article/setting-openssl-create-certificates.html
+<pre>
+<b>
#
# OpenSSL configuration file.
#
@@ -147,7 +149,7 @@ commonName_max = 64
# Default values for the above, for consistency and less typing.
# Variable name Value
-#------------------------ ------------------------------
+------------------------ ------------------------------
0.organizationName_default = My Company
localityName_default = My Town
stateOrProvinceName_default = State or Providence
@@ -161,11 +163,13 @@ authorityKeyIdentifier = keyid:always,issuer:always
[ v3_req ]
basicConstraints = CA:FALSE
subjectKeyIdentifier = hash
+</b>
+</pre>
-# Add OpenSSL to Sytem Environment variables
+### Add OpenSSL to Sytem Environment variables
Go to Edit the system environment variables -> Environment Variables, then in System variables edit Path and add c:\openssl\
-# Configure OpenSSL
+### Configure OpenSSL
Execute the following command to set the path to OpenSSL configuration.
set OPENSSL_CONF=c:\openssl\bin\openssl.cnf
@@ -178,6 +182,8 @@ Follow the wizard.
Once the key and certificate are generated execute the dir command you should see an output like this:
+<pre>
+<b>
c:\jams>dir
Volume in drive C has no label.
Volume Serial Number is BC94-9EF2
@@ -194,6 +200,8 @@ c:\jams>dir
2020-10-22 04:05 PM 2,047,932 userguide.pdf
5 File(s) 40,650,898 bytes
3 Dir(s) 93,365,936,128 bytes free
+</b>
+</pre>
Now execute the following command tot start JAMS
@@ -203,7 +211,7 @@ Open a navigator on the server and visite https://localhost:443 or https://local
Click CTRL + C to close the application
-# Expose your localhost to the internet
+### Expose your localhost to the internet
Click on Windows ans search for Windows Defender Firewall with Advanced Security.
@@ -229,26 +237,29 @@ Name you Rule JAMS Outbound and click Finish.
You are all set. You can now visit you application trought the server domain name or ip address on port 443 or 8443.
-# Create a JAMS Windows Service (Embed Tomcat Server Windows Service) to start JAMS with the server
+### Create a JAMS Windows Service (Embed Tomcat Server Windows Service) to start JAMS with the server
-In order to create a JAMS Windows Service you can use the tool NSSM provided on http://nssm.cc/download (https://github.com/kirillkovalenko/nssm)
+In order to create a JAMS Windows Service you can use the tool NSSM provided on http://nssm.cc/download [https://github.com/kirillkovalenko/nssm](https://github.com/kirillkovalenko/nssm)
Once downloaded open a command prompt and change directory to nssm-2.24\win64 then execute:
+<pre>
nssm.exe install JAMS
-
+</pre>
A GUI interface will open.
-In the Path field specify the path to the Java executable example "C:\Program Files\Common Files\Oracle\Java\javapath\java.exe".
+In the Path field specify the path to the Java executable example:
+<pre>"C:\Program Files\Common Files\Oracle\Java\javapath\java.exe".</pre>
-In the Startup directory put the "C:\jams" installation folder path.
+In the Startup directory put the <pre>"C:\jams" installation folder path.</pre>
In the last field Arguments add the following arguments:
-
+<pre>
-classpath "c:\jams" -jar jams-launcher.jar PORT_NUMBER server.pem server.key
+</pre>
where PORT_NUMBER is the port number you want to use to serve the application example 443 or 8443
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
+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)
diff --git a/userguide/docs/clients.md b/userguide/docs/clients.md
index 3f657c9cdb19df6b08d44d6ed96db738db9cc8a7..a6a4ff889dd8862faf18e3994f62e80c198f137f 100644
--- a/userguide/docs/clients.md
+++ b/userguide/docs/clients.md
@@ -15,13 +15,13 @@ For the purposes of this tutorial, we assume that
Open Jami, go to the login page. Click on "Advanced":
<p align="center">
- <img src="./img/client/linux/linux-step1.png" alt="Step 1" style="height:1024;width:768"/>
+ <img src="../img/client/linux/linux-step1.png" alt="Step 1" style="height:1024;width:768"/>
</p>
Select the option **"Connect to a JAMS server"** which will lead you to the following screen:
<p align="center">
- <img src="./img/client/linux/linux-step2.png" alt="Step 2" style="height:1024;width:768"/>
+ <img src="../img/client/linux/linux-step2.png" alt="Step 2" style="height:1024;width:768"/>
</p>
The **Jami Account Management Server URL** in this case would be the DNS address of your server and the username and password which correspond to your account. If you have configured the server with an LDAP/AD backend, it would be your LDAP/AD username and password.
@@ -31,13 +31,13 @@ The **Jami Account Management Server URL** in this case would be the DNS address
Open Jami, go to the login page. Click on "Advanced":
<p align="center">
- <img src="./img/client/windows/windows-step1.png" alt="Step 1" style="height:1024;width:768"/>
+ <img src="../img/client/windows/windows-step1.png" alt="Step 1" style="height:1024;width:768"/>
</p>
Select the option **"Connect to a JAMS server"** which will lead you to the following screen:
<p align="center">
- <img src="./img/client/windows/windows-step2.png" alt="Step 2" style="height:1024;width:768"/>
+ <img src="../img/client/windows/windows-step2.png" alt="Step 2" style="height:1024;width:768"/>
</p>
The **Jami Account Management Server URL** in this case would be the DNS address of your server and the username and password which correspond to your account. If you have configured the server with an LDAP/AD backend, it would be your LDAP/AD username and password.
@@ -47,13 +47,13 @@ The **Jami Account Management Server URL** in this case would be the DNS address
Open Jami, go to the login page. Click on "Advanced":
<p align="center">
- <img src="./img/client/macos/macos-step1.png" alt="Step 1" style="height:768;width:1024"/>
+ <img src="../img/client/macos/macos-step1.png" alt="Step 1" style="height:768;width:1024"/>
</p>
Select the option **"Connect to account manager"** which will lead you to the following screen:
<p align="center">
- <img src="./img/client/macos/macos-step2.png" alt="Step 2" style="height:768;width:1024"/>
+ <img src="../img/client/macos/macos-step2.png" alt="Step 2" style="height:768;width:1024"/>
</p>
The **Jami Account Management Server URL** in this case would be the DNS address of your server and the username and password which correspond to your account. If you have configured the server with an LDAP/AD backend, it would be your LDAP/AD username and password.
@@ -63,13 +63,13 @@ The **Jami Account Management Server URL** in this case would be the DNS address
Open Jami, go to the login page.
<p align="center">
- <img src="./img/client/android/android-step1.png" alt="Step 1" style="height:400px;width:200px"/>
+ <img src="../img/client/android/android-step1.png" alt="Step 1" style="height:400px;width:200px"/>
</p>
Select the option **"Connect to management server"** which will lead you to the following screen:
<p align="center">
- <img src="./img/client/android/android-step2.png" alt="Step 2" style="height:400px;width:200px"/>
+ <img src="../img/client/android/android-step2.png" alt="Step 2" style="height:400px;width:200px"/>
</p>
The server in this case would be the DNS address of your server and the username and password which correspond to your account. If you have configured the server with an LDAP/AD backend, it would be your LDAP/AD username and password.
@@ -77,13 +77,13 @@ The server in this case would be the DNS address of your server and the username
## Connect from an iOS device
Open Jami, go to the login page.
<p align="center">
- <img src="./img/client/ios/ios-step1.png" alt="Step 1" style="height:400px;width:200px"/>
+ <img src="../img/client/ios/ios-step1.png" alt="Step 1" style="height:400px;width:200px"/>
</p>
Select the option **"Connect to account manager"** which will lead you to the following screen:
<p align="center">
- <img src="./img/client/ios/ios-step2.png" alt="Step 2" style="height:400px;width:200px"/>
+ <img src="../img/client/ios/ios-step2.png" alt="Step 2" style="height:400px;width:200px"/>
</p>
The server in this case would be the DNS address of your server and the username and password which correspond to your account. If you have configured the server with an LDAP/AD backend, it would be your LDAP/AD username and password.
\ No newline at end of file
diff --git a/userguide/docs/doc.md b/userguide/docs/doc.md
deleted file mode 100644
index 7e6e04685d71a0c87d9b77f16378bc7767de5660..0000000000000000000000000000000000000000
--- a/userguide/docs/doc.md
+++ /dev/null
@@ -1,333 +0,0 @@
-# Getting Started
-
-JAMS is a server application used to enroll Jami clients into an Enterprise context. Currently, JAMS supports 3 sources for user authentication: LDAP, Active Directory and an embedded database.
-
-## Obtaining JAMS
-
-The latest Beta build of JAMS can be downloaded at: ``https://git.jami.net/savoirfairelinux/jami-jams``
-
-## System Requirements
-
-* Windows, Linux or Mac OS operating system
-* Java 11 or higher
-* 4 GB RAM
-* 1 CPU
-
-## JAMS Concepts
-
-JAMS was built with security in mind, therefore it is intimately related to the X509 certificate management workflows.
-
-The central concepts which are used in JAMS are the Certification Authority (CA) and the Certificate Signing Requests (CSR).
-
-In the JAMS paradigm, a device (Jami client) requests a certificate to the server then presents it to other devices to be recognized as a valid member of the organization. Therefore, JAMS must be provided with a certificate authority in order to work properly.
-
-In order to be completely secure, JAMS does not generate certificates for devices, but instead issues certificates based on a certificate signing request sent to it by the device, therefore removing the need to send a private key over the wire.
-
-The diagram below shows the entire process of how a device enrolls with JAMS:
-
-<p align="center">
- <img src="img/device_enroll.png" alt="Device Enrollement" style="height:250px;width:400px" />
-</p>
-
-​
-## Getting Started
-
-1. Download the latest version of JAMS from: <https://jami.net/services/>
-
-2. Unpack the .tar file to a directory of your choice.
-
-3. It is mandatory to run JAMS using a secure SSL connection. To request your SSL certificate files using OpenSSL and generate a pair of PEM and KEY, enter the following command:
-
-``openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout server.key -out server.pem``
-
-**Current limitation:** JAMS does not support reading encrypted private keys which require a password unlock.
-
-4. Navigate to the directory where you have extracted the JAMS package and execute the following command:
-
-```java -jar jams-launcher.jar PORT SSL_CERTIFICATE SSL_CERTIFICATE_KEY```
-
-| Argument | Details |
-| ------------- |------------- |
-| **PORT** | The TCP port on which you want JAMS to listen for incoming connections |
-| **SSL_CERTIFICATE** | The location of the PEM-formatted SSL Certificate file |
-| **SSL_CERTIFICATE_KEY** | The location of the PEM-formatted key file which is used with the SSL Certificate file from above |
-
-<br/>
-An example of the command would be:
-
-``java -jar jams-launcher 8080 server.pem server.key``
-
-Please note that any port above 1024 can be safely used to run JAMS.
-
-## Step 1: create your admininistrator account
-
-This account will have administrative control and the rights to manage your users and group of Jami users.
-
-<p align="center">
- <img src="img/step1.png" alt="Create an admin account" style="height:347px;width:310px" />
-</p>
-
-
-## Step 2: setup the Certification Authority
-
-The second step is to define your Certification Authority.
-
-**Important:** a CA is not a server-side ssl certificate, it is a certificate which has the power to issue other certificates. Do not use the import option unless your company's security officer has issued you a CA certificate. Most commercially available certificates (i.e. those issued by godaddy, letsencrypt, etc... ) are not CA certificates. If you are an end-user we highly recommend you use to create a self-signed CA option as providing an incorrect certificate type will lead to a non-functional server.
-
-<p align="center">
- <img src="img/step2-1.png" alt="Create an admin account" style="height:470px;width:265px" />
- <img src="img/step2-2.png" alt="Create an admin account" style="height:309px;width:247px" />
-</p>
-
-
-This certificate will be used to sign the enrollement requests which come from Jami devices. If you are not familiar with the X509 standard, we highly recommend you read the following
-articles to get familiar with the processes and practices which surround it:
-
-<https://www.securew2.com/blog/public-key-infrastructure-explained/>
-<https://cheapsslsecurity.com/blog/understanding-the-role-of-certificate-authorities-in-pki/>
-
-## Step 3: setup the user database
-
-JAMS supports 3 different sources for the authentication of users:
-
-* LDAP-compatible directory (such as OpenLDAP)
-* Microsoft Active Directory
-* Local embedded database
-
-<br/>
-
-### Option 1: LDAP authentication
-
-If your company provides you with LDAP directory for user management, you will need to know its access information and a automated account which has read-only rights to do use look-ups.
-
-<p align="center">
- <img src="img/ldap.png" style="height:478px;width:250px" />
-</p>
-
-Your admin should provide you most of this information but we do provide a detailed overview over each field in case you need some extra help:
-
-
-| Field | Details |
-| ------------- |------------- |
-| **Use StartTLS** | Your LDAP server can be configured to use either TLS/STARTTLS or PLAIN sockets, if STARTTLS is used you should mark this as true |
-| **Server Address** | The address of your server with respect to the JAMS server, your LDAP does not need to be publicly accessible but should be accessible to JAMS. You should have either ``ldap://`` or ``ldaps://`` preceding the address. |
-| **Port** | The port on which the LDAP server is listening for requests (usually 389 for PLAIN/STARTTLS and 636 for SSL/TLS) |
-| **Administrator Username** | This is **NOT** the LDAP's administration account credentials, but the credentials of the account which has Read permissions to the LDAP database in order to lookup users. The format is generally ``cn=bot,ou=robots,dc=domain,dc=org`` |
-| **Password** | The password used by the account above. |
-| **BaseDN** | The base realm where the users accounts are located, in most cases it is ``ou=users,dc=company,dc=org`` |
-
-<br/>
-
-### Option 2: Microsoft Active Directory
-
-If your company provides you with Active Directory for user management, you will need to know its access information and an automated account which has read-only rights to do use look-ups.
-
-
-<p align="center">
- <img src="img/ad.png"style="height:439px;width:240px" />
-</p>
-
-Your admin should provide you most of this information but we do provide a detailed overview over each field in case you need some extra help:
-
-| Field | Details |
-| ------------- |------------- |
-| **Port** | The port on which Active Directory is listening (generally it is either 389 or 636) |
-| **Host** | The address of your server with respect to the JAMS server, your Active Directory does not need to be publicly accessible but should be accessible to JAMS. |
-| **Administrator Username** | This is **NOT** the Active Directory's administration account credentials, but the credentials of the account which has Read permissions to the Active Directory database in order to lookup users. The format is generally ``cn=bot,ou=robots,dc=domain,dc=net`` |
-| **Password** | The password used by the account above. |
-| **Use SSL** | Whenever this server uses SSL for data transmission |
-| **Domain Name** | This is the legacy-formatted Windows Domain Name (i.e. ``WINDOMAIN``) |
-
-<br/>
-
-### Option 3: local embedded database
-
-The local database does not require any additional configuration, everything in the process is automated. This option allows you to create Jami users on the fly directly from the JAMS interface.
-
-<p align="center">
- <img src="img/local.png" style="height:307px;width:244px" />
-</p>
-
-**Advanced settings:** by default, the option "Use public nameserver" is disabled. Usernames of your Jami users will not be stored on the public Jami nameserver and your users will only be able to communicate with users from your organization.
-
-If you want your users to be searchable by external users and allow them to communicate with any Jami users, and not only the one from your organization, enable this option,
-
-## Step 4: setup the server parameters
-
-<p align="center">
- <img src="img/step4.png" style="height:452px;width:239px" />
-</p>
-
-| Parameter | Details |
-| ------------- |------------- |
-| **CORS Domain Name** | The domain on which the JAMS client and administration UI will be running. |
-| **Certificate Revocation List Lifetime** | The frequency at which the CRL is updated in memory |
-| **Device Lifetime** | How long a device's certificate is valid before being considered stale and requiring re-enrollement |
-| **User Account Lifetime** | How long a user account is valid before being considered stale and requiring re-enrollement |
-
-
-**Important** The *CORS Domain Name* corresponds to the web address used to access the Web UI. By default, it is set to the same URL as the one where you deploy JAMS. Only set a different URL if the Web UI has a different URL to the one where JAMS is deployed.
-
-<br/>
-
-Click on "Set Server Parameters" to finalize the configuration.
-You will be redirected to the JAMS interface.
-
-<p align="center">
- <img src="img/jams-dashboard.png" style="height:233px;width:457px" />
-</p>
-
-If you have configured JAMS with your LDAP or Active Directory, the list of users should of your organization shoud be visible in JAMS. If you have selected the local embedded database, you can now start creating new users by clicking on "Create User"
-
-## 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):
-
-```
-The internal jams folder: <your project root folder>/jams/jams
-derby.log
-oauth.key
-oauth.pub
-config.json
-```
-
-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
-
-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.
-
-
-## JAMS & Nginx
-
-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.
-
-The following is an example map of how you could configure JAMS behind Nginx (the process would be similar if you wanted to use any other type of proxying solution):
-
-<p align="center">
- <img src="img/map.png" alt="Create an admin account" style="height:250px;width:600px"/>
-</p>
-
-The IP 10.10.0.1 is random, and should be seen as an example.
-
-
-Typically you would add a new site called ``jams-site.conf`` to your nginx configurations which would contain the following entries if you wanted to place an SSL certificate at the Nginx level:
-
-
-```
-server {
- listen 443 ssl;
- listen [::]:443 ssl;
- ssl on;
- ssl_certificate /etc/certificates/mycertificate.pem
- ssl_certificate_key /etc/certificates/mycertificatekey.pem
- client_max_body_size 100M;
- server_name jams.mycompany.com;
- location / {
- proxy_pass http://10.10.0.1:8080/;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header Host $http_host;
- }
-}
-```
-
-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.
-
-
-## 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:
-
-```
-[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
-```
-
-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)
-
-# Client Guide
-
-Depending on your operating system, we have included the tutorial on how to connect to the management server from the Windows, MacOS, Android and iOS clients.
-
-
-For the purposes of this tutorial, we assume that
-
-1. The server and the device trying to connect are either
- 1. On the same network
- 2. The server is publicly accessible to the outside world
-2. You have a valid username/password pair to connect to the server
-
-## Connect from a Windows device
-
-Open Jami, go to the login page. Click on "Advanced":
-
-<p align="center">
- <img src="img/client/windows/windows-step1.png" alt="Step 1" style="height:400px;width:700px"/>
-</p>
-
-Select the option **"Connect to a JAMS server"** which will lead you to the following screen:
-
-<p align="center">
- <img src="img/client/windows/windows-step2.png" alt="Step 2" style="height:400px;width:700px"/>
-</p>
-
-The ```Jami Account Management Server URL``` in this case would be the DNS address of your server and the username and password which correspond to your account. If you have configured the server with an LDAP/AD backend, it would be your LDAP/AD username and password.
-
-## Connect from a MacOS device
-
-Open Jami, go to the login page. Click on "Advanced":
-
-<p align="center">
- <img src="img/client/macos/macos-step1.png" alt="Step 1" style="height:400px;width:444px"/>
-</p>
-
-Select the option **"Connect to account manager"** which will lead you to the following screen:
-
-<p align="center">
- <img src="img/client/macos/macos-step2.png" alt="Step 2" style="height:400px;width:700px"/>
-</p>
-
-The ```Jami Account Management Server URL``` in this case would be the DNS address of your server and the username and password which correspond to your account. If you have configured the server with an LDAP/AD backend, it would be your LDAP/AD username and password.
-
-## Connect from an Android device
-
-Open Jami, go to the login page.
-
-<p align="center">
- <img src="img/client/android/android-step1.png" alt="Step 1" style="height:400px;width:200px"/>
-</p>
-
-Select the option **"Connect to management server"** which will lead you to the following screen:
-
-<p align="center">
- <img src="img/client/android/android-step2.png" alt="Step 2" style="height:400px;width:200px"/>
-</p>
-
-The server in this case would be the DNS address of your server and the username and password which correspond to your account. If you have configured the server with an LDAP/AD backend, it would be your LDAP/AD username and password.
-
-## Connect from an iOS device
-
-Open Jami, go to the login page.
-
-<p align="center">
- <img src="img/client/ios/ios-step1.png" alt="Step 1" style="height:400px;width:200px"/>
-</p>
-
-Select the option **"Connect to account manager"** which will lead you to the following screen:
-
-<p align="center">
- <img src="img/client/ios/ios-step2.png" alt="Step 2" style="height:400px;width:200px"/>
-</p>
-
-The server in this case would be the DNS address of your server and the username and password which correspond to your account. If you have configured the server with an LDAP/AD backend, it would be your LDAP/AD username and password.
-
diff --git a/userguide/docs/index.md b/userguide/docs/index.md
index 4bde8d5ee897f2dd5942e093e82f26c2da9ad4cb..04813e2e837330136a5207620e2d74aa3894bd6f 100644
--- a/userguide/docs/index.md
+++ b/userguide/docs/index.md
@@ -4,7 +4,7 @@ JAMS is a server application used to enroll Jami clients into an Enterprise cont
## Obtaining JAMS
-The latest Beta build of JAMS can be downloaded at: <https://git.jami.net/savoirfairelinux/jami-jams>
+The latest Beta build of JAMS can be downloaded at: ``https://git.jami.net/savoirfairelinux/jami-jams``
## System Requirements
@@ -26,22 +26,25 @@ In order to be completely secure, JAMS does not generate certificates for device
The diagram below shows the entire process of how a device enrolls with JAMS:
<p align="center">
- <img src="img/device_enroll.png" alt="Device Enrollement" style="height:250px;width:400px" />
+ <img src="../img/device_enroll.png" alt="Device Enrollement" style="height:250px;width:400px" />
</p>
​
## Getting Started
-
1. Download the latest version of JAMS from: <https://jami.net/services/>
2. Unpack the .tar file to a directory of your choice.
-3. It is mandatory to run JAMS using a secure SSL connection. To request your SSL certificate files using OpenSSL and generate a pair of PEM and KEY, enter the following command: <pre>
-openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout server.key -out server.pem</pre>
+3. It is mandatory to run JAMS using a secure SSL connection. To request your SSL certificate files using OpenSSL and generate a pair of PEM and KEY, enter the following command:
+
+``openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout server.key -out server.pem``
+
+**Current limitation:** JAMS does not support reading encrypted private keys which require a password unlock.
-4. Launch your JAMS instance. Navigate to the directory where you have extracted the JAMS package and execute the following command:<pre>
-java -jar jams-launcher.jar PORT SSL_CERTIFICATE SSL_CERTIFICATE_KEY</pre>
+4. Navigate to the directory where you have extracted the JAMS package and execute the following command:
+
+```java -jar jams-launcher.jar PORT SSL_CERTIFICATE SSL_CERTIFICATE_KEY```
| Argument | Details |
| ------------- |------------- |
@@ -52,19 +55,16 @@ java -jar jams-launcher.jar PORT SSL_CERTIFICATE SSL_CERTIFICATE_KEY</pre>
<br/>
An example of the command would be:
-<pre>java -jar jams-launcher 8080 server.pem server.key</pre>
-
-**Current limitations:** JAMS does not support reading encrypted private keys which require a password unlock.
-
-Please also note that any port above 1024 will safely run JAMS.
+``java -jar jams-launcher 443 server.pem server.key``
+Please note that any port above 1024 can be safely used to run JAMS.
## Step 1: create your admininistrator account
This account will have administrative control and the rights to manage your users and group of Jami users.
<p align="center">
- <img src="img/step1.png" alt="Create an admin account" style="height:768;width:1024" />
+ <img src="../img/step1.png" alt="Create an admin account" />
</p>
@@ -75,8 +75,8 @@ The second step is to define your Certification Authority.
**Important:** a CA is not a server-side ssl certificate, it is a certificate which has the power to issue other certificates. Do not use the import option unless your company's security officer has issued you a CA certificate. Most commercially available certificates (i.e. those issued by godaddy, letsencrypt, etc... ) are not CA certificates. If you are an end-user we highly recommend you use to create a self-signed CA option as providing an incorrect certificate type will lead to a non-functional server.
<p align="center">
- <img src="img/step2-1.png" alt="Create an admin account" style="height:470px;width:265px" />
- <img src="img/step2-2.png" alt="Create an admin account" style="height:309px;width:247px" />
+ <img src="../img/step2-1.png" alt="Create an admin account" />
+ <img src="../img/step2-2.png" alt="Create an admin account" />
</p>
@@ -101,7 +101,7 @@ JAMS supports 3 different sources for the authentication of users:
If your company provides you with LDAP directory for user management, you will need to know its access information and a automated account which has read-only rights to do use look-ups.
<p align="center">
- <img src="img/ldap.png" style="height:478px;width:250px" />
+ <img src="../img/ldap.png" />
</p>
Your admin should provide you most of this information but we do provide a detailed overview over each field in case you need some extra help:
@@ -124,7 +124,7 @@ If your company provides you with Active Directory for user management, you will
<p align="center">
- <img src="img/ad.png"style="height:439px;width:240px" />
+ <img src="../img/ad.png" />
</p>
Your admin should provide you most of this information but we do provide a detailed overview over each field in case you need some extra help:
@@ -145,7 +145,7 @@ Your admin should provide you most of this information but we do provide a detai
The local database does not require any additional configuration, everything in the process is automated. This option allows you to create Jami users on the fly directly from the JAMS interface.
<p align="center">
- <img src="img/local.png" style="height:307px;width:244px" />
+ <img src="../img/local.png" />
</p>
**Advanced settings:** by default, the option "Use public nameserver" is disabled. Usernames of your Jami users will not be stored on the public Jami nameserver and your users will only be able to communicate with users from your organization.
@@ -155,7 +155,7 @@ If you want your users to be searchable by external users and allow them to comm
## Step 4: setup the server parameters
<p align="center">
- <img src="img/step4.png" style="height:452px;width:239px" />
+ <img src="../img/step4.png" />
</p>
| Parameter | Details |
@@ -174,7 +174,7 @@ Click on "Set Server Parameters" to finalize the configuration.
You will be redirected to the JAMS interface.
<p align="center">
- <img src="img/jams-dashboard.png" style="height:233px;width:457px" />
+ <img src="../img/jams-dashboard.png" />
</p>
-If you have configured JAMS with your LDAP or Active Directory, the list of users should of your organization shoud be visible in JAMS. If you have selected the local embedded database, you can now start creating new users by clicking on "Create User"
\ No newline at end of file
+If you have configured JAMS with your LDAP or Active Directory, the list of users should of your organization shoud be visible in JAMS. If you have selected the local embedded database, you can now start creating new users by clicking on "Create User"
diff --git a/userguide/mkdocs.yml b/userguide/mkdocs.yml
index 19d92c13ba7eb096f0fe6247a7d4bd074abad068..10a2b4ddce7ced71a7f31b11437acfe1c547f40e 100644
--- a/userguide/mkdocs.yml
+++ b/userguide/mkdocs.yml
@@ -1,4 +1,7 @@
site_name: Jams User Guide
+nav:
+ - Admin: admin.md
+ - Clients: clients.md
plugins:
- - search
- - mkpdfs
\ No newline at end of file
+ - search
+ - mkpdfs