diff --git a/userguide/docs/admin.md b/userguide/docs/admin.md index 4d7fc6a520a93cdbdb650556638075961d2c5240..5483d0408c1b9bcfa52ef823ee84544b6f001037 100644 --- a/userguide/docs/admin.md +++ b/userguide/docs/admin.md @@ -1,14 +1,13 @@ ## 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 +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. @@ -32,11 +31,8 @@ The following is an example map of how you could configure JAMS behind Nginx (th 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 { +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: <pre> +<b>server { listen 443 ssl; listen [::]:443 ssl; ssl on; @@ -49,18 +45,15 @@ server { proxy_set_header X-Real-IP $remote_addr; proxy_set_header Host $http_host; } -} -``` +}</b></pre> 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] +Running JAMS as a Linux Service is fairly straightforward with systemd - you simply created a service unit file with the following structure: <pre> +<b>[Unit] Description=JAMS Server [Service] @@ -70,6 +63,6 @@ ExecStart=/usr/bin/java -jar [DIRECTORY WHERE JAMS WAS UNZIPPED]/jams-launcher.j [Install] WantedBy=multi-user.target -``` +</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) \ No newline at end of file diff --git a/userguide/docs/clients.md b/userguide/docs/clients.md index a338b1cd5c9fc8b7f67a96458c732615813de941..23bab1ded6105eb630260aa0efd447de7708e115 100644 --- a/userguide/docs/clients.md +++ b/userguide/docs/clients.md @@ -24,7 +24,7 @@ Select the option **"Connect to a JAMS server"** which will lead you to the foll <img src="./img/client/windows/windows-step2.png" alt="Step 2" style="height:400px;width:500px"/> </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. +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 @@ -40,7 +40,7 @@ Select the option **"Connect to account manager"** which will lead you to the fo <img src="./img/client/macos/macos-step2.png" alt="Step 2" style="height:400px;width:500px"/> </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. +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 diff --git a/userguide/docs/index.md b/userguide/docs/index.md index 34ac45315f1b082928cbf265715692f709661814..6527f04f27876eb476924a978c3059b9f28a36e1 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 @@ -32,19 +32,16 @@ The diagram below shows the entire process of how a device enrolls with JAMS: ## 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. +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> +<b>openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout server.key -out server.pem</b></pre> -4. Launch your JAMS instance. 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``` +4. Launch your JAMS instance. Navigate to the directory where you have extracted the JAMS package and execute the following command: <pre> +<b>java -jar jams-launcher.jar PORT SSL_CERTIFICATE SSL_CERTIFICATE_KEY</b></pre> | Argument | Details | | ------------- |------------- | @@ -55,9 +52,12 @@ The diagram below shows the entire process of how a device enrolls with JAMS: <br/> An example of the command would be: -``java -jar jams-launcher 8080 server.pem server.key`` +<pre> +<b>java -jar jams-launcher 8080 server.pem server.key</b></pre> + +**Current limitations:** JAMS does not support reading encrypted private keys which require a password unlock. -Please note that any port above 1024 can be safely used to run JAMS. +Please also note that any port above 1024 will safely run JAMS. ## Step 1: create your admininistrator account