Installing Studio on a Stand-Alone Server

A stand-alone server is a server that does not run SQreamDB based on binary files.

Installing NodeJS Version 12 on the Server 

Before installing Studio you must install NodeJS version 12 on the server.

To install NodeJS version 12 on the server:

Check if a version of NodeJS older than version 12.<x.x> has been installed on the target server.
```
$ node -v
```
The following is the output if a version of NodeJS has already been installed on the target server:
```
bash: /usr/bin/node: No such file or directory
```
If a version of NodeJS older than 12.<x.x> has been installed, remove it as follows:
- On CentOS:
```
$ sudo yum remove -y nodejs
```
- On Ubuntu:
```
$ sudo apt remove -y nodejs
```

If you have not installed NodeJS version 12, run the following commands:

On CentOS:

$ curl -sL https://rpm.nodesource.com/setup_12.x | sudo bash -
$ sudo yum clean all && sudo yum makecache fast
$ sudo yum install -y nodejs

On Ubuntu:

$ curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
$ sudo apt-get install -y nodejs

The following output is displayed if your installation has completed successfully:

Transaction Summary
==============================================================================================================================
Install  1 Package

Total download size: 22 M
Installed size: 67 M
Downloading packages:
warning: /var/cache/yum/x86_64/7/nodesource/packages/nodejs-12.22.1-1nodesource.x86_64.rpm: Header V4 RSA/SHA512 Signature, key ID 34fa74dd: NOKEY
Public key for nodejs-12.22.1-1nodesource.x86_64.rpm is not installed
nodejs-12.22.1-1nodesource.x86_64.rpm                                                                  |  22 MB  00:00:02
Retrieving key from file:///etc/pki/rpm-gpg/NODESOURCE-GPG-SIGNING-KEY-EL
Importing GPG key 0x34FA74DD:
 Userid     : "NodeSource <[email protected]>"
 Fingerprint: 2e55 207a 95d9 944b 0cc9 3261 5ddb e8d4 34fa 74dd
 Package    : nodesource-release-el7-1.noarch (installed)
 From       : /etc/pki/rpm-gpg/NODESOURCE-GPG-SIGNING-KEY-EL
Running transaction check
Running transaction test
Transaction test succeeded
Running transaction
Warning: RPMDB altered outside of yum.
  Installing : 2:nodejs-12.22.1-1nodesource.x86_64                                                                        1/1
  Verifying  : 2:nodejs-12.22.1-1nodesource.x86_64                                                                        1/1

Installed:
  nodejs.x86_64 2:12.22.1-1nodesource

Complete!

Confirm the Node version.
```
$ node -v
```

The following is an example of the correct output:
v12.22.1

Install Prometheus using binary packages.

For more information on installing Prometheus using binary packages, see Installing Prometheus Using Binary Packages.

Back to Installing Studio on a Stand-Alone Server

Installing Studio 

After installing the Dashboard Data Collector, you can install Studio.

To install Studio:

Copy the SQream Studio package from SQream Artifactory into the target server. For access to the Sqream Studio package, contact SQream Support.

Extract the package:

$ tar -xvf sqream-acceleration-studio-<version number>.x86_64.tar.gz

Navigate to the new package folder.
```
$ cd sqream-admin
```

Build the configuration file to set up Sqream Studio. You can use IP address 127.0.0.1 on a single server.
```
$ npm run setup -- -y --host=<SQreamD IP> --port=3108 --data-collector-url=http://<data collector IP address>:8100/api/dashboard/data
```
The above command creates the sqream-admin-config.json configuration file in the sqream-admin folder and shows the following output:
```
Config generated successfully. Run `npm start` to start the app.
```
For more information about the available set-up arguments, see Set-Up Arguments.

To access Studio over a secure connection, in your configuration file do the following:

Change your port value to 3109.

Change your ssl flag value to true.

The following is an example of the correctly modified configuration file:

{
  "debugSqream": false,
  "webHost": "localhost",
  "webPort": 8080,
  "webSslPort": 8443,
  "logsDirectory": "",
  "clusterType": "standalone",
  "dataCollectorUrl": "",
  "connections": [
    {
      "host": "127.0.0.1",
      "port":3109,
      "isCluster": true,
      "name": "default",
      "service": "sqream",
      "ssl":true,
      "networkTimeout": 60000,
      "connectionTimeout": 3000
    }
  ]
}

If you have installed Studio on a server where SQream is already installed, move the sqream-admin-config.json file to /etc/sqream/:
```
$ mv sqream-admin-config.json /etc/sqream
```

Back to Installing Studio on a Stand-Alone Server

Starting Studio Manually 

You can start Studio manually by running the following command:

$ cd /home/sqream/sqream-admin
$ NODE_ENV=production pm2 start ./server/build/main.js --name=sqream-studio -- start

The following output is displayed:

[PM2] Starting /home/sqream/sqream-admin/server/build/main.js in fork_mode (1 instance)
[PM2] Done.
┌─────┬──────────────────┬─────────────┬─────────┬─────────┬──────────┬────────┬──────┬───────────┬──────────┬──────────┬──────────┬──────────┐
│ id  │ name             │ namespace   │ version │ mode    │ pid      │ uptime │ ↺    │ status    │ cpu      │ mem      │ user     │ watching │
├─────┼──────────────────┼─────────────┼─────────┼─────────┼──────────┼────────┼──────┼───────────┼──────────┼──────────┼──────────┼──────────┤
│ 0   │ sqream-studio    │ default     │ 0.1.0   │ fork    │ 11540    │ 0s     │ 0    │ online    │ 0%       │ 15.6mb   │ sqream   │ disabled │
└─────┴──────────────────┴─────────────┴─────────┴─────────┴──────────┴────────┴──────┴───────────┴──────────┴──────────┴──────────┴──────────┘

Starting Studio as a Service 

Sqream uses the Process Manager (PM2) to maintain Studio.

To start Studio as a service:

Run the following command:
```
$ sudo npm install -g pm2
```

Verify that the PM2 has been installed successfully.

$ pm2 list

The following is the output:

┌─────┬──────────────────┬─────────────┬─────────┬─────────┬──────────┬────────┬──────┬───────────┬──────────┬──────────┬──────────┬──────────┐
│ id  │ name             │ namespace   │ version │ mode    │ pid      │ uptime │ ↺    │ status    │ cpu      │ mem      │ user     │ watching │
├─────┼──────────────────┼─────────────┼─────────┼─────────┼──────────┼────────┼──────┼───────────┼──────────┼──────────┼──────────┼──────────┤
│ 0   │ sqream-studio    │ default     │ 0.1.0   │ fork    │ 11540    │ 2m     │ 0    │ online    │ 0%       │ 31.5mb   │ sqream   │ disabled │
└─────┴──────────────────┴─────────────┴─────────┴─────────┴──────────┴────────┴──────┴───────────┴──────────┴──────────┴──────────┴──────────┘

Start the service with PM2:

If the sqream-admin-config.json file is located in /etc/sqream/, run the following command:

$ cd /home/sqream/sqream-admin
$ NODE_ENV=production pm2 start ./server/build/main.js --name=sqream-studio -- start --config-location=/etc/sqream/sqream-admin-config.json

If the sqream-admin-config.json file is not located in /etc/sqream/, run the following command:

$ cd /home/sqream/sqream-admin
$ NODE_ENV=production pm2 start ./server/build/main.js --name=sqream-studio -- start

Verify that Studio is running.
```
$ netstat -nltp
```

Verify that SQream_studio is listening on port 8080, as shown below:

(Not all processes could be identified, non-owned process info
 will not be shown, you would have to be root to see it all.)
Active Internet connections (only servers)
Proto Recv-Q Send-Q Local Address           Foreign Address         State       PID/Program name
tcp        0      0 0.0.0.0:22              0.0.0.0:*               LISTEN      -
tcp        0      0 127.0.0.1:25            0.0.0.0:*               LISTEN      -
tcp6       0      0 :::8080                 :::*                    LISTEN      11540/sqream-studio
tcp6       0      0 :::22                   :::*                    LISTEN      -
tcp6       0      0 ::1:25                  :::*                    LISTEN      -

Verify the following:
1. That you can access Studio from your browser (http://<IP_Address>:8080).
1. That you can log in to SQream.

Save the configuration to run on boot.

$ pm2 startup

The following is an example of the output:

$ sudo env PATH=$PATH:/usr/bin /usr/lib/node_modules/pm2/bin/pm2 startup systemd -u sqream --hp /home/sqream

Copy and paste the output above and run it.

Save the configuration.
```
$ pm2 save
```

Back to Installing Studio on a Stand-Alone Server

Accessing Studio 

The Studio page is available on port 8080: http://<server ip>:8080.

If port 8080 is blocked by the server firewall, you can unblock it by running the following command:

$ firewall-cmd --zone=public --add-port=8080/tcp --permanent
$ firewall-cmd --reload

Back to Installing Studio on a Stand-Alone Server

Maintaining Studio with the Process Manager (PM2)

Sqream uses the Process Manager (PM2) to maintain Studio.

You can use PM2 to do one of the following:

To check the PM2 service status: pm2 list
To restart the PM2 service: pm2 reload sqream-studio
To see the PM2 service logs: pm2 logs sqream-studio

Back to Installing Studio on a Stand-Alone Server

Upgrading Studio 

To upgrade Studio you need to stop the version that you currently have.

To stop the current version of Studio:

List the process name:
```
$ pm2 list
```
The process name is displayed.
```
<process name>
```

Run the following command with the process name:
```
$ pm2 stop <process name>
```

If only one process is running, run the following command:
```
$ pm2 stop all
```

Change the name of the current sqream-admin folder to the old version.
```
$ mv sqream-admin sqream-admin-<old_version>
```

Extract the new Studio version.

$ tar -xf sqream-acceleration-studio-<version>tar.gz

Rebuild the configuration file. You can use IP address 127.0.0.1 on a single server.
```
$ npm run setup -- -y --host=<SQreamD IP> --port=3108
```

The above command creates the sqream-admin-config.json configuration file in the sqream_admin folder.

Copy the sqream-admin-config.json configuration file to /etc/sqream/ to overwrite the old configuration file.

Start PM2.
```
$ pm2 start all
```

Back to Installing Studio on a Stand-Alone Server

Installing Studio on a Stand-Alone Server

Installing NodeJS Version 12 on the Server

Installing Studio

Starting Studio Manually

Starting Studio as a Service

Accessing Studio

Maintaining Studio with the Process Manager (PM2)

Upgrading Studio

Installing NodeJS Version 12 on the Server 

Installing Studio 

Starting Studio Manually 

Starting Studio as a Service 

Accessing Studio 

Upgrading Studio 