Quick start

This walkthrough summarizes the installation order of the Riversoft® STCP DirectLink components on an Enterprise Linux server. The details of each step are in Installation and Configuration.

Note

If Riversoft STCP Gemini is already installed, the database, the repository, the API and the Portal are already in place: start at the Create the instance and a test user step.

Tip

Just want to try the product? Use the Docker test environment, which runs complete Riversoft STCP Gemini and Riversoft STCP DirectLink installations in containers, with no server to prepare.

Prerequisites:

Server with a supported operating system and administrator (root) access. See Requirements.
Supported database, available and reachable from the server.
Riversoft STCP DirectLink license file, provided by Riversoft.

Prepare the database

Download the script package for your DBMS and run the scripts in numerical order. See Database preparation.

Configure the Riversoft repository

curl https://repo.riversoft.com.br/configs/riversoft-el9.repo \
  --output /etc/yum.repos.d/riversoft-release.repo
dnf clean all && dnf makecache

Use the file that matches your system version (el8, el9 or el10).

Install and start the Riversoft STCP Gemini API

dnf install -y stcpgemini-api
cp /usr/local/stcpgemini-api/configs/example-config.json /usr/local/stcpgemini-api/configs/config.json

Adjust config.json (databases, port and certificate) and start the service:

systemctl start stcpgemini-api

Install the Riversoft Console Portal

dnf install -y stcpgemini-portal

Set the Portal EntryPoint to the API address. See Portal configuration.

Create the instance and a test user

Open the Riversoft Console Portal at the API address, sign in with the default administrator operator (stcpadmin) and change the password. Create the instance that Riversoft STCP DirectLink will use, or use the Riversoft STCP Gemini instance, and register a test user. See First access.

Note

When you create the Riversoft STCP DirectLink API network service in the instance, the Riversoft Console Portal fills in the default paths for static pages (/usr/local/stcpdirectlink/static) and page templates (/usr/local/stcpdirectlink/templates/riversoft/page). Change them only if Riversoft STCP DirectLink is installed in another directory. The static pages path must not end with a slash.

Install Riversoft STCP DirectLink and Riversoft STCP DirectLink Portal

dnf install -y stcpdirectlink stcpdirectlink-portal
cp /usr/local/stcpdirectlink/configs/example-config.json /usr/local/stcpdirectlink/configs/config.json
cp /usr/local/stcpdirectlink/static/portal/assets/configs/example-config.json /usr/local/stcpdirectlink/static/portal/assets/configs/config.json

The stcpdirectlink service is created when the package is installed, but it is not started.

Configure

In the Riversoft STCP DirectLink config.json, set cfgInstanceName to the instance name, and enter the database details, the license path in applLicense, the port and the certificate. See Riversoft STCP DirectLink configuration.

In the Riversoft STCP DirectLink Portal config.json (/usr/local/stcpdirectlink/static/portal/assets/configs/config.json), set url to the Riversoft STCP DirectLink API address. See Riversoft STCP DirectLink Portal configuration.

Test and start the service

Test the configuration in the foreground:

/usr/local/bin/stcpdirectlink \
  -noService \
  -config /usr/local/stcpdirectlink/configs/config.json \
  -lang enu \
  -langfile /usr/local/stcpdirectlink/configs/messages.json \
  -debugPath /usr/local/stcpdirectlink/logs

If there are no errors, stop the test (Ctrl+C) and start the service:

systemctl enable --now stcpdirectlink
systemctl status stcpdirectlink

Open Riversoft STCP DirectLink Portal

Open https://<domain>/portal, sign in with the test user, upload a file and check the download area. See Using Riversoft STCP DirectLink Portal.

Expected result: the Riversoft STCP Gemini API, the Riversoft Console Portal, Riversoft STCP DirectLink and Riversoft STCP DirectLink Portal running, with file exchange working through the portal.

For file routing and automation, also install Riversoft STCP Gemini Rename on the same server as Riversoft STCP DirectLink.

Next steps

API quick start

Using Riversoft STCP DirectLink Portal

Configuration

Docker test environment