Installing the Documentation

1. On Linux, create a user WITHOUT root privileges to install and run the documentation, for example x3ds.

   This user will be used:

   • for performing the installation of the documentation.
   • for post install and admin tasks
   • for documentation uninstallation

   This user will run all documentation processes and own installed files.

2. On Windows, create a user with administrator privileges to install and run the documentation.

   This user will be used:

   • for performing the installation of the documentation.
   • for post install and admin tasks
   • for documentation uninstallation

   Administrator rights will be required at installation time for several tasks such as updating the registry.

1. Generate certificate requests with the openssl command:

   openssl req -new -newkey rsa:2048 -nodes -days 365 -subj
             "/C=country/ST=state/L=city/O=organization/OU=departement/CN=fully.qualified.server.name"
             -out my_certificate.csr -keyout my_certificate.key 
   

   Important: The certificate CN attribute must be equal to: The ServerName, as set in the Reverse Proxy. The FQDN (including case). The certificate must not contain protocol (https://) or port information (443).

   Answer the questions (with the constraints on Common Name above). If you use an optional pass phrase (not recommended), you will need to provide it to the reverse proxy.

   This command generates .key and .csr files.

2. Keep the .key files and send the .csr files to the authority in charge of signing your certificates.

   Specify that the certificates are intended for Apache Httpd (if you use it). The certificate authority will send the .cer (or .crt) signed files back to you.

   On the reverse proxy, only use the .cer (or .crt) and .key.

3. Make sure that you have configured your SSL certificate () on the reverse proxy as follows on Linux:

   SSLCertificateFile
           /path/to/your.cer

   SSLCertificateKeyFile
           /path/to/your.key

   and on Windows:

   SSLCertificateFile
           \path\to\your.cer

   SSLCertificateKeyFile
           \path\to\your.key

DOC_Apps_3DEXP.AllOS\1 on Windows

DOC_Apps_3DEXP.AllOS/1 on Linux

then start the installation as follows:

• Windows: double-click setup.exe for the GUI mode or use StartTUI.exe for the TUI mode
• Linux: ./StartGUI.sh for the GUI, or ./StartTUI.sh

The Dassault Systèmes 3DEXPERIENCE Documentation nodeJS R2022x installer appears.

Click Next.

The default installation location for documentation in English on Windows is C:\Program Files\Dassault Systemes\B424doc and On Linux /usr/DassaultSystemes/B424doc

The roles that you can install are organized by industries.

• Use the Filter to directly access the component you want to install.
• Click to expand the tree or to collapse it.
• Click to select all the roles or to deselect all the roles.

• Show Installable Components displays all the roles that are available for installation
• Show Selected Components displays only the selected roles
• Show Installed Components (if available) displays the roles already installed

The components are identified by role name. Some components require additional roles to be selected.

As you make your selections, the installer updates information about the space available and the space required for your installation.

After the selection, click Next.

The Node.js server hosts the documentation.

An option allows to check that the port is free.

This feature uses the user's mail client.

A reverse proxy receives HTTPS requests to link contextual help from an app to the installed documentation.

The Node.js server that hosts documentation only supports an http protocol. The 3DEXPERIENCE web client only accepts an https protocol to define the user documentation for contextual help from apps (this location can be changed from the Platform Management dashboard.) A reverse proxy is required to forward requests from the web client to the Node.js server.

For more information about 3DEXPERIENCE User Assistance Setting, see Installation and Setup| Administrate| 3DEXPERIENCE Platform| Platform Management| Platform Management Dashboard.

The reverse proxy uses an https protocol and forwards requests to the Node.js server using an http protocol. An administrator must set up and install the reverse proxy separately from the documentation installation.

For example, if you install the English documentation on a host named "myhostname" using port 4040, and the reverse proxy alias is https://doc2022x, English documentation is accessible at https://doc2022x/English, which is forwarded to the Node.js server as http://myhostname:4040/English.

Click Next.

For Windows:

After the installation this service is started:

Dassault Systemes 3DEXPERIENCE Documentation nodeJS R2022x

The traces of the service are stored in service.<date>.log in the Temp folder (For example, C:\Users\<username>\AppData\Local\Temp\service.2021-08-30.log).

The traces of the Node.js server are stored in ds_docnode<port>.log the Temp folder (For example, C:\Users\<username>\AppData\Local\Temp\ds_docnode4040.log).

For Linux:

After the installation, start the service manually following the Information about Node.js instructions. See /usr/DassaultSystemes/B424doc/StartDocumentationUsingJavaSearch.txt

1. First, customize the reverse proxy server name and server alias, for example

   ServerName myreverseproxy
   ServerAlias myreverseproxy

2. Then, activate SSL:

   SSLEngine on
   SSLProxyEngine on

3. Then, specify the SSL certificates definition, for example

   SSLCertificateFile "pathtoyourcertificate\mysreverseproxy.cer"
   SSLCertificateKeyFile "pathtoyourcertificate\myreverseproxy.key"

<Location />
AddOutputFilterByType DEFLATE text/plain
AddOutputFilterByType DEFLATE text/xml
AddOutputFilterByType DEFLATE text/html
AddOutputFilterByType DEFLATE text/css
AddOutputFilterByType DEFLATE application/xml
AddOutputFilterByType DEFLATE application/x-javascript
AddOutputFilterByType DEFLATE application/javascript
AddOutputFilterByType DEFLATE image/svg+xml
AddOutputFilterByType DEFLATE application/json
AddOutputFilterByType DEFLATE application/ds-json
AddOutputFilterByType DEFLATE text/javascript
AddOutputFilterByType DEFLATE application/xhtml+xml
AddOutputFilterByType DEFLATE application/rss+xml
AddOutputFilterByType DEFLATE application/atom_xml
AddOutputFilterByType DEFLATE application/x-font-ttf
RequestHeader set X-Forwarded-Proto "https"
RequestHeader set X-Forwarded-Port "443"
ProxyPass http://myhostname:4040/
ProxyPassReverse http://myhostname:4040/
# Cross-origin resource sharing (CORS)
SetEnvIf Origin "^http(s):\/\/(.+\.)?(dsone.3ds.com)(:\d{1,5})?$" origin_is=$0
Header always set Access-Control-Allow-Origin %{origin_is}e env=origin_is
Header set Access-Control-Allow-Credentials "true"
Header set Access-Control-Allow-Methods "GET, POST, OPTIONS, HEAD, PUT, DELETE, PATCH"
Header set Access-Control-Allow-Headers "accept,x-requested-method,origin,x-requested-with,x-request,cache-control,content-type,last-modified,x-utc-offset,SecurityContext,X-DS-CSRFTOKEN,keep-alive,DS-API-Version,DS-Client-Step-Name,DS-Request-ID,ENO_CSRF_TOKEN,SecurityToken,DS-Change-Authoring-Context,DS-Configuration-Authoring-Context"
Header set Access-Control-Expose-Headers "DS-Request-ID,X-DS-CSRFTOKEN,X-3DComment-Has-Moderation-Rights"
Header set Access-Control-Max-Age "600"
</Location>