jami
/
jami-docs
mirror of https://git.jami.net/savoirfairelinux/jami-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

jams/admin.md: cleanup (attempt 2) 

Follow up to patch: https://review.jami.net/c/jami-docs/+/29999

fix formatting of `code`

Change-Id: Ifa346227a35acf6736b87d725a4335e1907d0741
This commit is contained in:
ovari123 2025-01-24 19:14:28 -04:00 committed by Adrien Béraud
parent ba06c6b2ae
commit 04ad360416
1 changed files with 120 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
jams/admin.md
View File

@ -4,7 +4,6 @@ By default, the [Jami Account Management Server (JAMS)](https://jami.biz/) runs
However, this is impractical for many reasons.
This guide is designed to help with setting up a JAMS to run in a production environment.
## JAMS and Nginx
It is generally not recommended to expose JAMS directly to the outside world.
@ -51,7 +50,6 @@ This is the preferred setup method by most admins, as local traffic is usually r
Since the CA is generated during the JAMS initial configuration, Nginx needs to be restarted once the initial setup is completed.
```
## Troubleshooting and resetting
If a restart from 0 (i.e., reset everything and drop existing data) is required, delete the following files in the distribution folder (`<project-root-folder>/jams`):
@ -66,7 +64,6 @@ If a restart from 0 (i.e., reset everything and drop existing data) is required,
This will reset the server to its original state, and the configuration wizard is able to be run again.
Before performing this operation, please ensure that the server is shut down.
## Running JAMS as a GNU/Linux Service
Running JAMS as a GNU/Linux Service is fairly straightforward with systemd—simply create a service unit file with the following structure:
@ -85,24 +82,20 @@ Running JAMS as a GNU/Linux Service is fairly straightforward with systemd—sim
The parameters **PORT**, **SSL_CERTIFICATE** and **SSL_CERTIFICATE_KEY** are optional (however, **PORT** can be used alone, whereas the **SSL_CERTIFICATE** comes in a pair with **SSL_CERTIFICATE_KEY**).
## Running JAMS as a Windows Service
### A. Download and install JAMS
1. Visit <https://jami.biz/> and download JAMS.
2. Extract JAMS to C:\jams
### 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).
2. Install it using the installation wizard.
### 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>.
@ -157,8 +150,8 @@ The parameters **PORT**, **SSL_CERTIFICATE** and **SSL_CERTIFICATE_KEY** are opt
distinguished_name = req_distinguished_name
req_extensions = v3_req
<b>[req_distinguished_name]</b>
<i># Variable name Prompt string
<b>[req_distinguished_name]</b><i>
# Variable name Prompt string
#-------------------------- -----------------------------------------------</i>
0.organizationName = Organization Name (company)
organizationalUnitName = Organizational Unit Name (department, division)
@ -190,13 +183,11 @@ The parameters **PORT**, **SSL_CERTIFICATE** and **SSL_CERTIFICATE_KEY** are opt
subjectKeyIdentifier = hash
</pre>
### D. Add OpenSSL to System Environment Variables
Go to Edit the system environment variables → Environment Variables.
In System variables, edit **Path** and add `C:\openssl\`.
### E. Configure OpenSSL
1. Open the **Command Prompt**.
@ -237,10 +228,9 @@ In System variables, edit **Path** and add `C:\openssl\`.
9. Type CTRL+C to close the application.
### F. Expose the localhost to the Internet
1. Click on **Windows** and search for ***Windows Defender Firewall with Advanced Security***.
1. Press the Windows key or click the Windows icon and search for ***Windows Defender Firewall with Advanced Security***.
2. Right-click **Inbound Rules** and click **New Rule…**
@ -269,7 +259,6 @@ In System variables, edit **Path** and add `C:\openssl\`.
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.
### 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.