===== Install Redpeaks cockpit =====

The application can be installed on most common Linux distributions, the syntax of the commands described below might change from one distribution to another \\
\\
To install Redpeaks Cockpit, download the install package and extract the compressed file in your home directory. **Do not copy the archive in /opt folder** 

  tar -xvzf Redpeaks-Cockpit-VERSION_BUILD_NUMBER.tar.gz

This will create the following files: 

  * **Redpeaks.Cockpit.tar.gz** : The application package
  * **update.sh** : The update script
  * **install.sh** : The install script
  * **promonitor-cockpit.service** : The Service configuration file

  Run install.sh 

The Redpeaks Cockpit is installed by default in **/opt** \\
You can now start the application:

  systemctl start promonitor-cockpit

==== User access ====

  * The installer will automatically create a dedicated promonitor service user for running the application.
  * **For security reasons, do not run the application as root**
  * Please follow the policy of least privilege for all access granted to run or maintain the application. 

===== Update Redpeaks =====

  * It is recommended to update Redpeaks via the web superadmin UI.
  * However, it is possible to update from the OS directly
  * Once you downloaded and decompressed the update package, you can stop the application and run the update script:

  systemctl stop promonitor-cockpit
  ./update.sh
  systemctl start promonitor-cockpit

  * Update will create a new folder for the application and redirect the link from the old version to the new one.

{{:common:icon_note.png}} Older versions are not deleted during an update from the OS. You will have to delete old version folders manually
  
===== How to change the installation folder =====

Before to installing Redpeaks Cockpit, open install.sh script and update the pmDir variable 

<code>
pmDir="/opt"
</code>

Then, open promonitor-cockpit.service and set the same folder on the following lines : 

  WorkingDirectory=/opt/Pro.Monitor-Cockpit/
  ExecStart=/opt/Pro.Monitor-Cockpit/bin/startup.sh
  
===== How to change the HTTP/HTTPS ports =====

Change **port.http.nonssl** and **port.http.ssl** value in the file **/opt/Pro.Monitor-Cockpit/bin/setenv.sh**

  systemctl stop promonitor-cockpit
  vi /opt/Pro.Monitor-Cockpit/bin/setenv.sh  # change the appropriate port
  systemctl start promonitor-cockpit

====== Memory tuning ======

==== Linux ====

Change the -Xms and -Xmx value in /opt/Pro.Monitor-Cockpit/bin/setenv.sh to define minimum and maximum allocated memory

  systemctl stop promonitor-cockpit
  vi /opt/Pro.Monitor-Cockpit/bin/setenv.sh
  systemctl start promonitor-cockpit


===== Manage firewall settings =====

  * Application ports must be open:
    * 9888 for HTTPS
    * 9443 for HTTPS


  * Example on REDHAT / CENTOS 7 :

  sudo firewall-cmd –zone=public –add-port=9888/tcp –permanent
  sudo firewall-cmd –reload

  * Other example for different Linux distributions:

  sudo iptables -I INPUT -p tcp -m tcp –dport 9888 -j ACCEPT
  sudo service iptables save

===== Reverse proxy =====

  * If you intend to install the application behind a NGINX reverse proxy, you need to add the below parameter to the **location** section:

  proxy_pass http://<LOCAL SERVER>:<LOCAL PORT>;
  proxy_set_header Upgrade $http_upgrade;
  proxy_set_header Connection "Upgrade";
  proxy_set_header host $host;
  proxy_set_header X-forward-for $proxy_add_x_forwarded_for;