Skip to content

Quick start

This guide uses the database mode: the routing is registered in the Riversoft Console Portal and read by Riversoft® STCP Gemini Rename at run time.

Tip

To try the product without preparing a server, use the local test environment. It already includes Riversoft STCP Gemini Rename installed with Riversoft STCP Gemini Server and Riversoft STCP DirectLink.

Prerequisites:

  • Riversoft STCP Gemini Server or Riversoft STCP DirectLink installed on the same server, with the instance configured.
  • Riversoft repository configured. See Riversoft repository.
  • Riversoft STCP Gemini Rename license, provided by Riversoft.

Install the package

dnf install -y stcpren

Create the configuration file

cd /usr/local/stcpren/configs
cp example-config-db.json config.json

Enter the password encryption key (applConfigPassPhrase), the license (License), the instance (cfgInstanceName) and the configuration database connection. See Configuration.

Register a routing

In the Riversoft Console Portal, register a routing in the instance, for example INBOUND, with a rule that selects the files and sets the destination.

Test the routing

Check which rule would be applied to a file, without processing it:

stcpren -db -rules INBOUND -test /mailbox/IN/NOTES.TXT

Process the files

Process all files in a directory:

stcpren -db -rules INBOUND -scan /mailbox/IN

For automatic processing, configure Riversoft STCP Gemini Server or Riversoft STCP DirectLink to trigger the routing for each received file, or create a schedule. See Operation.