Configuración

Visión general

Riversoft® STCP Gemini Rename usa un único archivo de configuración, /usr/local/stcpren/configs/config.json. Define la clave de cifrado, la licencia, dónde están la instancia y los enrutamientos y cómo se hace el control de ejecución. Puede indicarse otro archivo con -config.

Elija el modo antes de crear el archivo. Vea Modos de configuración.

Clave de cifrado de las contraseñas

Las contraseñas y los demás datos sensibles guardados en la base de configuración (por ejemplo, las contraseñas de los usuarios, de las bases de datos y de las credenciales de supervisión) están cifrados. Todos los módulos que leen o graban esos datos deben usar la misma clave. De lo contrario, un módulo no puede leer las contraseñas guardadas por otro.

Módulo	Archivo	Parámetro
Riversoft STCP Gemini Server	`/usr/local/stcp/configs/stcpserver.config.json`	`ApplConfigPassPhrase` (sección `STCPCore`)
Riversoft STCP DirectLink	`configs/config.json` de la instalación	`applConfigPassPhrase`
Riversoft STCP Gemini Rename	`/usr/local/stcpren/configs/config.json`	`applConfigPassPhrase` (sección `General`)
Riversoft STCP Gemini API	`/usr/local/stcpgemini-api/configs/config.json`	`api_secret` (sección `general`)

    flowchart LR
    K[Misma clave] --> G[Gemini Server]
    K --> D[DirectLink]
    K --> R[Gemini Rename]
    K --> A[Gemini API]
    G --> DB[(Base de configuración<br/>contraseñas cifradas)]
    D --> DB
    R --> DB
    A --> DB

Importante

Defina la clave antes del primer registro y use el mismo valor en todos los módulos del entorno. Para cambiarla después, los datos sensibles ya guardados deben cifrarse de nuevo con la nueva clave, mediante un procedimiento realizado con una aplicación propia. Contacte al soporte de Riversoft antes de cambiar la clave.

Use un valor fuerte y aleatorio, guardado fuera del código.
En Riversoft STCP DirectLink, el parámetro acepta referencia a secreto (env:, file: o kms:). Prefiera leer el valor de una variable de entorno, de un archivo protegido o de un almacén de secretos.
En Riversoft STCP Gemini API, el api_secret también firma los tokens de acceso.
Guarde la clave en el backup seguro del entorno: sin ella, las contraseñas de una base restaurada no se pueden leer.

Archivo de configuración

Cree el archivo a partir del modelo del modo elegido y ajuste los valores:

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

{
  "General": {
    "applDir": "/usr/local/stcpren",
    "applLockDir": "/usr/local/stcpren/control",
    "applPidFile": "",
    "applConfigPassPhrase": "<clave-de-cifrado>",
    "applUser": "stcp",
    "applGroup": "stcp",
    "applDebug": 0,
    "License": "/usr/local/stcpren/license/<archivo-de-licencia>"
  },
  "cfgProvider": {
    "cfgProviderType": "stcpgeminidb",
    "cfgInstanceName": "<instancia>",
    "cfgDbName": "GEMINI_DBConfig",
    "cfgDbHost": "db.ejemplo.com",
    "cfgDbPort": 3306,
    "cfgDbUser": "<usuario>",
    "cfgDbPswd": "<contraseña>",
    "cfgDbType": "mysql"
  },
  "lockProvider": {
    "lockEnable": true,
    "lockType": "filesystem"
  }
}

Los enrutamientos se leen de la base por el nombre informado en -rules, y los mensajes se graban en la base de log de la instancia.

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

{
  "General": {
    "applDir": "/usr/local/stcpren",
    "applLockDir": "/usr/local/stcpren/control",
    "applLogDir": "/usr/local/stcpren/log",
    "applPidFile": "",
    "applConfigPassPhrase": "<clave-de-cifrado>",
    "applUser": "stcp",
    "applGroup": "stcp",
    "applDebug": 0,
    "License": "/usr/local/stcpren/license/<archivo-de-licencia>"
  },
  "cfgProvider": {
    "cfgProviderType": "stcpgeminifile",
    "cfgInstanceName": "<instancia>"
  },
  "lockProvider": {
    "lockEnable": true,
    "lockType": "filesystem"
  },
  "cfgInstance": {
    "Entity": { "Version": 2, "Name": "<instancia>" },
    "Log": { "Verbose": 6, "Console": 6, "External": 0 },
    "Startup": {
      "SerialNumber": "<numero-de-serie>",
      "ExternalLockEnable": 1,
      "ExternalLockTimeout": 300000,
      "ExternalLockWait": 250,
      "ExternalLockRetries": 1
    }
  }
}

Los parámetros de la instancia quedan en cfgInstance. Cada enrutamiento es un archivo JSON, informado en -rules con la ruta del archivo. Los mensajes se graban en un archivo de texto en el directorio applLogDir.

Sección	Función
`General`	Directorios, usuario y grupo de ejecución, clave de cifrado, debug y licencia.
`cfgProvider`	Modo de configuración, instancia asociada y, en el modo base de datos, conexión con la base de configuración.
`lockProvider`	Control de ejecuciones simultáneas.
`cfgInstance`	Parámetros de la instancia, solo en el modo archivo local.

Todos los parámetros están en Referencia de parámetros.

Importante

cfgInstanceName debe ser igual al nombre de la instancia usada por Riversoft STCP Gemini Server (ApplName) o por Riversoft STCP DirectLink.

Cree el directorio de control informado en applLockDir, si todavía no existe:

mkdir -p /usr/local/stcpren/control
chown stcp:stcp /usr/local/stcpren/control

Enrutamientos

Modo base de datos: registre los enrutamientos en la instancia, en el Riversoft Console Portal. Para revisar un enrutamiento fuera del Portal, expórtelo a JSON con -export. Vea Operación.
Modo archivo local: cree el archivo JSON del enrutamiento a partir del modelo example-config_rules.json. Para reglas antiguas en formato INI, use la conversión con -ini. Vea Actualización y migración.

La estructura del enrutamiento está en Referencia de reglas.

Prueba de la configuración

Verifique que la configuración y el enrutamiento se leen correctamente, sin procesar archivos:

stcpren -db -rules <ENRUTAMIENTO> -test <archivo-de-ejemplo>

En el modo archivo local, cambie -db -rules <ENRUTAMIENTO> por -rules <ruta-del-enrutamiento.json>.

Seguridad del archivo

applConfigPassPhrase, cfgDbPswd y el archivo de licencia son datos sensibles. Restrinja el acceso al config.json al usuario y al grupo definidos en applUser y applGroup:

chown stcp:stcp /usr/local/stcpren/configs/config.json
chmod 640 /usr/local/stcpren/configs/config.json

Vea también Seguridad.

Actualización Seguridad