Parameter reference
This page lists the parameters of the Riversoft® STCP DirectLink config.json file, with type and default value. How each group is used is described in Configuration.
Note
config.json is read at startup. After changing any parameter, restart the service. In the Default column, “—” means there is no default value.
Transfer and links
Details: Configuration › Transfer and links.
| Parameter | Type | Default | Description |
|---|---|---|---|
downloadEnable | boolean | — | Enables downloads. |
downloadExpireDays | integer | 1 | Download link validity, in days. 0 uses 24 hours. |
downloadPinExpireSeconds | integer | 180 | Download PIN validity. Values up to 60 use 180 seconds; larger values are adjusted to multiples of 60. |
uploadEnable | boolean | — | Enables uploads. |
uploadMaxFileSize | integer | — | Maximum upload size, in bytes. |
uploadValidateJSON | boolean | — | Enables JSON validation in the upload flow. |
secureLinkPinMaxLen | integer | 6 | Maximum secure link PIN length. A value less than or equal to zero uses 6. |
secureLinkPinExpireSeconds | integer | 180 | Secure link PIN validity. Values up to 60 use 180 seconds. |
reportMaxLines | integer | 100 | Report lines per page. Values less than or equal to zero or greater than 1000 use 100. |
Details: Configuration › Email.
| Parameter | Type | Default | Description |
|---|---|---|---|
emailEnable | boolean | — | Enables email notifications. |
emailServerAddress | string | — | SMTP server host. |
emailServerPort | integer | — | SMTP port, for example 587. |
emailAuthUser | string | — | SMTP user. |
emailAuthPswd | string | — | SMTP password or secret reference. |
emailAuthType | string | — | Authentication type accepted by the provider. |
emailTemplatesPath | string | required with emailEnable | Email templates directory. Required when emailEnable is true. |
emailSendFrom | string | — | Message sender. |
emailReplyTo | string | — | Reply-To header address. |
emailFormatMimeFrom | string | — | From header format. |
emailSendConfirmationEnable | boolean | — | Sends a confirmation after the transfer. |
emailSendConfirmationToSenderEnable | boolean | — | Also sends the confirmation to the sender. |
emailSendRetryMaximum | integer | — | Maximum number of sending attempts. |
emailSendRetryWaitSeconds | integer | — | Interval between attempts, in seconds. |
emailCheckValidMXDisable | boolean | — | Disables the MX record check of the recipient’s domain. |
emailProvider | string | empty | Email sending provider. Empty uses SMTP, the only supported provider. |
SMS and WhatsApp
Details: Configuration › SMS and WhatsApp.
| Parameter | Type | Default | Description |
|---|---|---|---|
smsEnable | boolean | — | Enables SMS or WhatsApp notifications. |
smsSendConfirmationEnable | boolean | — | Sends a transfer confirmation. |
smsTemplatesPath | string | required with smsEnable | Templates directory. Required when the feature is enabled. |
smsProvider | string | — | Provider, for example whatsapp. |
smsEndpoint | string | — | Provider HTTP endpoint. |
smsAuthUser | string | — | Authentication identifier at the provider. |
smsAuthPswd | string | — | Provider secret or secret reference. |
smsSender | string | — | Sender identifier, such as the WhatsApp Business ID. |
smsSendConfirmationToSenderEnable | boolean | — | Sends the sender, by SMS, the confirmation that the recipient downloaded the file. |
Routing and distribution
Details: Configuration › Routing and distribution.
| Parameter | Type | Default | Description |
|---|---|---|---|
routeEnable | boolean | — | Enables file routing. |
routeTableCSVFile | string | — | CSV file that maps origin, destination and recipients. |
routeCSVDelimiter | string | — | CSV separator, usually ;. |
routeScanTimerMs | integer | — | Scan interval, in milliseconds. |
routeScanSplitFilenameRegex | string | — | Regular expression that splits origin and file name (origin and filename groups). |
routeExternalCmdEnable | boolean | — | Enables an external command in routing. |
routeExternalCmd | string | — | External command, with an absolute path. |
routeExternalCmdParams | string | — | External command parameters. |
routePath | list of strings | — | Additional directories scanned by routing. |
routeCopyFileEnable | boolean | — | Copies the file to routeCopyPath. |
routeCopyPath | string | — | Copy path template; accepts placeholders such as <destination> and <filename>. |
routeDirectLinkEnable | boolean | — | Generates a Riversoft STCP DirectLink link for the routed file. |
routeDirectLinkTableIndex | string | — | Column used to find the route, for example destination. |
routeDirectLinkUrl | string | — | Riversoft STCP DirectLink API base URL. |
routeMoveFileEnable | boolean | — | Moves the file to routeMovePath after processing. |
routeMovePath | string | — | Backup path template; accepts <origin>, <filename> and <unixtime>. |
routeRemoveFile | boolean | — | Removes the original file after processing. |
URL shortener
Details: Configuration › URL shortener.
| Parameter | Type | Default | Description |
|---|---|---|---|
urlShortnerEnable | boolean | — | Enables URL shortening. |
urlShortnerProvider | string | — | Provider, for example bitly. |
urlShortnerEndpoint | string | — | Provider API endpoint. |
urlShortnerToken | string | — | Provider token or secret reference. |
Cloudflare Turnstile
Details: Configuration › Cloudflare Turnstile.
| Parameter | Type | Default | Description |
|---|---|---|---|
turnstileEnable | boolean | — | Requires the Turnstile token. With false, the header is ignored. |
turnstileSecretKey | string | required with turnstileEnable | Widget secret key or secret reference. Required when turnstileEnable is true; without it, the service does not start. |
turnstileEndpoint | string | https://challenges.cloudflare.com/turnstile/v0/siteverify | Validation endpoint. Change it only for an outbound proxy or tests. |
turnstileTimeoutSeconds | integer | 10 | Maximum validation time. Values less than or equal to 0 use the default. |
STCP configuration database
Details: Configuration › STCP configuration database.
| Parameter | Type | Default | Description |
|---|---|---|---|
cfgProvider | string | — | stcpgeminidb for the Riversoft STCP Gemini Server database or stcpwindows for the Riversoft STCP Enterprise Server configuration. |
cfgInstanceName | string | — | STCP instance name. |
cfgDbName | string | — | Database name or path, according to the provider. Accepts connection options, such as TLS options (see Requirements). |
cfgDbHost | string | — | Database host. |
cfgDbPort | integer | — | Database port. |
cfgDbUser | string | — | Database user. |
cfgDbPswd | string | — | Password or secret reference. |
cfgDbType | string | — | Database type, for example mysql. |
cfgDbOptions | string | — | Additional options appended to the database name. |
Log database
Details: Configuration › Log database.
| Parameter | Type | Default | Description |
|---|---|---|---|
logDbEnable | boolean | — | Enables writing logs to a database. |
logDbWindows | boolean | — | Uses the Windows log mechanism, where applicable. |
logDbType | string | — | Log database type. |
logDbHost | string | — | Log database host. |
logDbPort | integer | — | Log database port. |
logDbUser | string | — | Log database user. |
logDbPswd | string | — | Password or secret reference. |
logDbName | string | — | Log database name. |
Application and security
Details: Configuration › Application and security.
| Parameter | Type | Default | Description |
|---|---|---|---|
applLicense | string | required | License file path. The file must exist. |
applDir | string | required | Absolute installation directory. It must exist. |
applLockDir | string | — | Lock directory. It must exist and be writable by the service user. |
applPidFile | string | required | PID file path. |
applConfigPassPhrase | string | — | Passphrase used to protect configuration values. Accepts a secret reference. Must be the same in the other modules of the environment. See Password encryption key. |
applSecret | string | — | Secret used to protect links. Use a strong, stable and private value. |
applUser | string | stcp | Service user. Default: stcp. |
applGroup | string | stcp | Service group. Default: stcp. |
applDebug | integer | — | Debug level. |
applUmask | string | 0022 | Umask for created files. Default: 0022. |
applDebugPath | string | — | Debug files directory. The -debugPath command-line option takes precedence. |
license | string | — | Former name of applLicense, accepted for compatibility. Use applLicense. |
Telemetry
Details: Configuration › Telemetry.
| Parameter | Type | Default | Description |
|---|---|---|---|
enable_traces, enable_logs, enable_metrics | boolean | — | Enable the export of traces, logs and metrics. |
provider_type | string | — | Exporter type, for example otlphttp. |
provider_host | string | — | Collector host and port. |
provider_file_path | string | — | File used by file-based exporters. |
resource_mode | string | — | Resource creation strategy. |
service_namespace, service_env | string | — | Service namespace and environment (for example, prod). |
connect_timeout, export_timeout | integer | — | Connection and export timeouts. |
tls_enabled | boolean | — | Enables TLS for the exporter. |
tls_min_version, tls_max_version | string | — | TLS version limits. |
tls_public_key_cert_file, tls_private_key_file, tls_private_key_file_pswd | string | — | Client certificate, private key and password, when required. |
tls_ca_file | string | — | Trusted CA. |
tls_ciphers | string | — | Allowed ciphers. |
tls_verify_certs | boolean | — | Validates certificates. Keep it true in production. |
Service
Details: Configuration › Service.
| Parameter | Type | Default | Description |
|---|---|---|---|
serviceName | string | — | Internal name used by the service manager. |
serviceDescription | string | — | Service description. |
serviceDisplayedName | string | — | Service display name. |
Secrets provider (Kms)
Details: Configuration › KMS and secrets.
| Parameter | Type | Default | Description |
|---|---|---|---|
kmsEnable | boolean | — | Enables the secrets provider. |
kmsType | string | — | Provider type: aws:secretmanager, azure:keyvault, gcp:secretmanager or oci:keyvault. |
kmsName | string | — | Descriptive provider name. |
kmsRegion | string | — | Service region (AWS and OCI). |
kmsEndpoint | string | — | Vault address (Azure and OCI). |
kmsTenant | string | — | Tenant (Azure) or tenancy (OCI). |
kmsVaultId | string | — | Vault identifier (OCI). |
kmsClientId | string | — | Client or service account identifier. |
kmsClientSecret | string | — | Client secret, when workload identity is not used. |
kmsClientPrivateKey | string | — | Client private key (OCI). |
kmsClientPrivateKeyPswd | string | — | Client private key password (OCI). |
kmsClientFingerprint | string | — | Client key fingerprint (OCI). |
KmsClientAccessToken | string | — | Client access token (GCP). |
kmsConfigFile | string | — | Credentials file (GCP). |
Riversoft STCP DirectLink Portal
The parameters of the Riversoft STCP DirectLink Portal configuration file are in Configuration › Riversoft STCP DirectLink Portal.