Variables de Entorno
Se describen las variables requeridas para la instalación:
Configuración de APIs
API Config
| Variable | Descripción | Valor por defecto |
|---|---|---|
ARAI_DOCS_URL | URL en la cual queda instalada la API de Araí-Documentos. | http://localhost/documentos |
ARAI_DOCS_USER | Api User para poder autenticarse y consultar de servicios. | - |
ARAI_DOCS_PASS | Password para poder autenticarse y consultar de servicios (en Swarm se obtiene mediante ARAI_DOCS_PASS_FILE). | - |
API Documentos Digitales
| Variable | Descripción | Valor por defecto |
|---|---|---|
ARAI_DOCS_TOKEN_LIFETIME | Tiempo en milisegundos de vigencia de un token de firma. Es decir desde que se dispara un Proceso de Firma es el tiempo que tiene el Usuario para firmar el Documento con ese token. | 1500 |
ARAI_DOCS_VALIDAR_FIRMA | Realiza validación de cantidad de firmas del documento anterior. Es una verificación mínima en caso de que muchos Usuarios deban firmar un mismo documento. | 1 |
API Archivos Binarios
| Variable | Descripción | Valor por defecto |
|---|---|---|
ARCHIVOS_VIGENCIA | Días que el archivo existirá y podrá ser recuperado en completitud desde la API. | 730 |
ARCHIVOS_RETENCION_POST_EXPIRACION | Días que se mantendrá el archivo luego de que se haya cumplido su tiempo de vigencia. | 30 |
ARCHIVOS_MAX_SIZE | Tamaño máximo del archivo a subir en bytes. | 10485760 |
Configuraciones Generales
Logs
| Variable | Descripción | Valor por defecto |
|---|---|---|
ARAI_DOCS_LOG_LEVEL | Nivel de detalle del log. | INFO, ERROR, DEBUG |
Organismo
| Variable | Descripción | Valor por defecto |
|---|---|---|
ORGANISMO_TIPO | Tipo de identificador del organismo (valores posibles: CUIT y CUIL). | CUIL |
ORGANISMO_IDENTIFICADOR | Identificador del Organismo, puede ser un CUIL o CUIT. Ver detalles en documentación anexada. | XXXXXXXX |
INSTITUCION_NOMBRE | Identificador de la Institución, puede ser una sigla o su nombre. | XXXXXXXX |
Sellos
| Variable | Descripción | Valor por defecto |
|---|---|---|
STAMPER_ACTIVO | Activa el Servicio de Estampado. | 1 (por defecto desde v1.4.0) |
STAMPER_SELLOS_ACTIVO | Indica si se soporta Estampado con Sellos Dinámicos. | - |
STAMPER_SELLOS_CREACION | Especifica el formato por defecto de Sello Dinámico al cargar un documento. | - |
STAMPER_SELLOS_AUTORIZACION | Especifica el formato por defecto de Sello Dinámico al autorizar un documento. | - |
Servicios conectados
DB Config
| Variable | Descripción | Valor por defecto |
|---|---|---|
ARAI_DOCS_DB_HOST | Dirección del host de base de datos. | - |
ARAI_DOCS_DB_PORT | Puerto de base de datos. | - |
ARAI_DOCS_DB_DBNAME | Nombre de la base de datos. | arai_documentos |
ARAI_DOCS_DB_USERNAME | Nombre de usuario de base de datos. | - |
ARAI_DOCS_DB_PASSWORD_FILE | Password para conexión con base de datos (en Swarm se utiliza ARAI_DOCS_DB_PASSWORD_FILE). | - |
ARAI_DOCS_DB_SCHEMA | Esquema de la base de datos a utilizar. | public |
ARAI_DOCS_DB_ENCODING | Codificación a utilizar. | UTF8 |
Redis
| Variable | Descripción | Valor por defecto |
|---|---|---|
REDIS_HOST | Host del servicio de redis donde se encolan los lotes de objetos a mover. | - |
REDIS_PORT | Puerto de redis. | - |
Servicio de Usuarios (Araí-Usuarios)
| Variable | Descripción | Valor por defecto |
|---|---|---|
USUARIOS_CLASS | Clase que implementa UserProviderInterface, comúnmente es Arai-Usuarios. En caso de implementar otra clase debe indicarse aquí. | \SIU\DocsApi\Security\UserProviderArai |
USUARIOS_PARAMS | Parámetros para conectarse al sistema de usuarios. | "{base_uri:'http://usuarios/usuarios/rest/usuarios', method:'basic', user:'documentos', password:'documentos'}" |
USUARIOS_CACHE_TIME | Permite configurar el tiempo que se considerará para actualizar la información de los usuarios (Campo integer en horas). | - |
Servicio de Personas (Araí-Personas)
| Variable | Descripción | Valor por defecto |
|---|---|---|
PERSONAS_CLASS | Clase que implementa PersonasProviderInterface. En caso de implementar otra clase debe indicarse aquí. | \SIU\DocsApi\Personas\PersonasProviderArai |
PERSONAS_PARAMS | Parámetros para conectarse a la api de personas. | {base_uri:'http://personas-api/api/v1'', method:'basic', user:'documentos', password:'documentos'} |
Servicio de Expedientes (Sudocu)
| Variable | Descripción | Valor por defecto |
|---|---|---|
TRAMITES_CLASS | Clase que implemente TramitesProviderInterface, comúnmente es Sudocu. | \SIU\DocsApi\Tramites\TramitesProviderSudocu |
TRAMITES_PARAMS | Parámetros para conectarse al sistema de trámites. | "{base_uri:'http://api-server:8080/api/', method:'basic', user:'integracion', password:'integracion'}" |
Servicio de Firma Digital (FirmAR)
| Variable | Descripción | Valor por defecto |
|---|---|---|
SERVICIO_FIRMADOR_CLASS | Implementación del servicio firmador. | \SIU\DocsApi\Firmador\FirmARService |
SERVICIO_FIRMADOR_PARAMS | Datos de conexión con FirmAR. | "{base_uri:'https://tst.firmar.gob.ar/', method:'basic', user:'f8c9ea3a-6719-4c2f-a7b7-3ba37d65c404', password:''}" |
Workers y Procesos Asincrónicos
Notificaciones asincrónicas
| Variable | Descripción | Valor por defecto |
|---|---|---|
ARAI_DOCS_RESTHOOK_ACTIVO | Se activa para funciones asincrónicas. | 1 |
ARAI_DOCS_RESTHOOK_MAXRETRIES | Números de reintentos cuando falla una comunicación asincrónica. | 5 |
RH_BACKOFF_BASE | Base numérica que determina la espera exponencial para un reintento, trabaja en conjunto con ARAI_DOCS_RESTHOOK_MAXRETRIES. | 4 |
Movimiento de objetos
| Variable | Descripción | Valor por defecto |
|---|---|---|
LOTES_CANTIDAD_OBJETOS | Cantidad de objetos a mover por Lote. | 100 (por defecto desde v2.0.0) |
LOTES_CANTIDAD_REINTENTOS | Cantidad de reintentos en caso de fallo al mover un objeto. | 5 (por defecto desde v2.0.0) |
LOTES_TIEMPO_REINTENTOS | Delay en milisegundos para volver a procesar un objeto fallido. | 6000 (por defecto desde v2.0.0) |
Servicios de Almacenamiento de Objetos
Nuxeo
| Variable | Descripción | Valor por defecto |
|---|---|---|
STORAGE_TYPE | El tipo de repositorio. | RDI |
STORAGE_HOST | Dirección a la API CMIS de Nuxeo. | http://nuxeo-host:8080/nuxeo/atom/cmis/ |
STORAGE_USUARIO | API User para Nuxeo. | Administrator |
STORAGE_CLAVE | Clave de Nuxeo (En Swarm se configura mediante ARAI_DOCS_NUXEO_CLAVE_FILE). | Administrator |
S3
| Variable | Descripción | Valor por defecto |
|---|---|---|
STORAGE_TYPE | Tipo de repositorio para indicar backend S3. | S3 |
STORAGE_ENDPOINT | Configuración del endpoint donde se encuentran los buckets. Debe incluir http o https. | http://s3.amazonaws.com/siu / https://<bucket-name>.mycloud.com |
STORAGE_KEY | Key para autenticar contra el bucket. | - |
STORAGE_SECRET | Secret para autenticar contra el bucket. | - |
STORAGE_REGION | Región donde se encuentra el bucket. | us-west-2 |
STORAGE_BUCKET | Nombre del bucket. | bucket_test |
STORAGE_VERSION | Versión del servicio web utilizado (se recomienda bloquear el número de versión YYYY-mm-dd). | 2006-03-01 o latest |
Filesystem
| Variable | Descripción | Valor por defecto |
|---|---|---|
STORAGE_TYPE | El tipo de repositorio. | Filesystem |
STORAGE_FILESYSTEM_DIR | Ruta base donde se almacenarán los documentos. | /mnt/documentos |