Diferencia entre revisiones de «Pirapire/version3.0.0/instalacion actualizacion/instalador env vars»
(→Configuración para uso de la API de AFIP) |
(→Configuración para uso de API REST) |
||
Línea 208: | Línea 208: | ||
{| class="wikitable" | {| class="wikitable" | ||
− | !width=" | + | !width="40%"| Variable de entorno |
− | !width=" | + | !width="60%"| Descripción |
|- | |- | ||
| REST_CLIENTE_USUARIO | | REST_CLIENTE_USUARIO |
Revisión del 17:45 6 jul 2022
Sumario
- 1 Variables de entorno para la instalación
- 1.1 Configuración del instalador
- 1.2 Configuración interna de Toba
- 1.3 Configuración de la base de datos de negocio
- 1.4 Configuración de la base de datos de Toba
- 1.5 Configuración para uso de Redis
- 1.6 Configuración para uso de SSO vía IDP
- 1.7 Configuración para uso de API REST
- 1.8 Configuración para uso de la API de AFIP
- 1.9 Configuración para uso de Workers
Variables de entorno para la instalación
A continuación, se describen las variables de entorno que son utilizadas para realizar la instalación. Éstas están en el archivo [[../instalador.env.dist|instalador.env.dist]].
Los parámetros comentados con #
son parámetros opcionales, la configuración de la base de datos de negocio es obligatoria y es opcional definir una configuración separada para la base de datos de Toba, por defecto ambas bases de datos están en una misma base en distintos schemas.
También opcionalmente se puede personalizar las rutas de TOBA_PROYECTO_DIR
y TOBA_INSTALACION_DIR
, esto es útil para casos especiales.
Opcionalmente podemos definir si el entorno es de producción ENTORNO_PRODUCCION="1"
o desarrollo ENTORNO_PRODUCCION="0"
por defecto asume que el ambiente es producción.
Configuración del instalador
Variable de entorno | Descripción |
---|---|
INSTALADOR_TIMEOUT | tiempo de ejecución de los comandos internos que tiene el instalador. Por defecto 1200 segundos |
ENTORNO_PRODUCCION | indica si la instalación es un entorno de producción. El valor 1 es producción, 0 solo en casos de ambientes de desarrollo
|
Configuración interna de Toba
Variable de entorno | Descripción | Valor por defecto |
---|---|---|
TOBA_URL_BASE | La url base pública de acceso al sistema, sin alias del proyecto. Ej: https://pirapire.institucion.edu.ar
|
http://localhost
|
TOBA_USUARIO | El usuario administrador del proyecto, en caso de actualización dejar valor por defecto | toba
|
TOBA_PASSWORD | El password del usuario administrador, en caso de actualización dejar valor por defecto | toba123*-a
|
TOBA_INSTALACION_DIR | Opcional, el directorio donde va a quedar los archivos de la instalacion del proyecto toba. | pirapire/instalacion
|
TOBA_PROYECTO_DIR | Opcional, el directorio donde está el proyecto toba | |
TOBA_ALIAS_PROYECTO | El alias Apache para el acceso al proyecto | /pirapire
|
TOBA_ALIAS_NUCLEO | Opcional, el alias Apache para acceso al núcleo de Toba | /toba_pirapire
|
TOBA_ALIAS_TOBA_USUARIOS | Opcional, el alias Apache para el acceso al proyecto Toba-usuarios
|
/toba_usuarios
|
TOBA_ALIAS_TOBA_EDITOR | Opcional, el alias Apache para el acceso al proyecto Toba-editor
|
/toba_editor
|
TOBA_ALIAS_TOBA_REFERENCIA | Opcional, el alias Apache para el acceso al proyecto Toba-referencia
|
/toba_referencia
|
TOBA_ID_DESARROLLADOR | Opcional, el id desarrollador toba. | 0
|
TOBA_SESSION_NAME | Opcional, el nombre de cookie donde se almacena las sesiones en el navegador. Si se tiene multiples instalaciones en el mimso dominio, deben ser distintas | TOBA_PILAGA
|
TOBA_FORZAR_HTTPS | Opcional, si se desea utilizar https, o un proxy reverso y forzar que la aplicación opere con HTTPS. Puede ser off u on
|
Off
|
TOBA_SALT | Opcional, la semilla o sal para ser utilizada en los algoritmos de encriptación internos de SIU-Toba | Caracteres aleatorios |
Configuración de la base de datos de negocio
Variable de entorno | Descripción | Valor por defecto |
---|---|---|
PROYECTO_DB_HOST | el host/ip del equipo donde corre la base de datos | localhost
|
PROYECTO_DB_PORT | el puerto donde corre la base de datos | 5432
|
PROYECTO_DB_DBNAME | el nombre de la base de datos de negocio | db_proyecto
|
PROYECTO_DB_USERNAME | el usuario para la conectarse a la base de datos | postgres
|
PROYECTO_DB_PASSWORD | la clave del usuario para conectarse a la base de datos | postgres
|
PROYECTO_DB_SCHEMA | el nombre del esquema dentro de la base de datos | public
|
PROYECTO_DB_ENCODING | la codificación de caracteres de la base de datos | LATIN1
|
Configuración de la base de datos de Toba
Variable de entorno | Descripción |
---|---|
TOBA_DB_HOST | el host o dirección ip del equipo donde corre la base de datos |
TOBA_DB_PORT | el puerto donde corre la base de datos |
TOBA_DB_DBNAME | el nombre de la base de datos |
TOBA_DB_USERNAME | el usuario para la conectarse a la base de datos |
TOBA_DB_PASSWORD | la clave del usuario para conectarse a la base de datos |
TOBA_DB_SCHEMA | el nombre del esquema dentro de la base de datos |
TOBA_DB_ENCODING | la codificación de caracteres de la base de datos. Debe ser LATIN1
|
Esta configuración es opcional, solo requerida para separar la db de negocios de la del proyecto Toba.
Configuración para uso de Redis
Variable de entorno | Descripción |
---|---|
REDIS_HOST | Host del servicio Redis |
REDIS_PORT | Puerto del servicio Redis |
Se utiliza para validar conexión al servidor redis y configurar en el sistema para el envío de peticiones asincronas a SQ Núcleo.
Configuración para uso de SSO vía IDP
Variable de entorno | Descripción |
---|---|
SSO_SP_IDP_METADATA_URL | URL del IDP donde estén accesibles los metadatos |
SSO_SP_IDP_URL_SERVICE | URL del IDP donde esté accesible el servicio |
SSO_SP_IDP_SINGLE_LOGOUT_URL_SERVICE | URL para cerrar sesión en el IDP |
SSO_SP_IDP_PUBLIC_KEY_FILE | Ruta al archivo donde está el certificado usado para contactar al IDP |
SSO_SP_ATRIBUTO_USUARIO | El atributo del IDP que contiene el identificador de usuario |
SSO_SP_PERMITE_LOGIN_TOBA | Si se activa el login interno del proyecto vía Toba. Posibles valores 0 y 1
|
SSO_SP_AUTH_SOURCE | El auth source del SP, por defecto suele ser default-sp
|
SSO_SP_COOKIE_NAME | Nombre de la cookie manejada por OneLogin, por ej. TOBA_SESSID
|
SSO_SP_IDP_NAME | Nombre del IDP |
Esta configuración es opcional, se utiliza para configurar en el sistema el uso de autenticación centralizada vía un IDP.
Configuración para uso de API REST
Variable de entorno | Descripción |
---|---|
REST_CLIENTE_USUARIO | El usuario con el cual autenticar como cliente a una api REST. |
REST_CLIENTE_CLAVE | La clave del usuario |
REST_CLIENTE_AUTH | El tipo de autenticación del cliente REST basic o digest
|
REST_SERVIDOR_AUTH | El tipo de autenticación del servidor REST basic o digest
|
REST_ARAI_SYNC_KEY_FILE | Opcional, ruta al archivo donde está el certificado usado para sincronizar apis REST con Araí arai-sync.key
|
Esta configuración es opcional, se utiliza para configurar en el sistema el acceso de apis tipo REST.
Configuración para uso de la API de AFIP
Variable de entorno | Descripción |
---|---|
AFIP_WS_CUIT | CUIT con el que se ha generado los certificados para acceder a los servicios de AFIP. |
AFIP_WS_CERT | Ruta absoluta donde se encuentra almacenado el certificado. |
AFIP_WS_KEY | Ruta absoluta donde se encuentra almacenado el archivo de clave. |
AFIP_WS_TOKEN_DIR | Ruta absoluta donde la librería generará el token (requiere permisos de escritura). |
Esta configuración es opcional, se utiliza para configurar en el sistema el acceso a la api de AFIP.
Configuración para uso de Workers
Variable de entorno | Descripción | Valor por defecto |
---|---|---|
WORKER_TRANSPORT | Mecanismo por el cual se utiliza para encolar las peticiones de los workers. | redis
|
WORKER_REINTENTOS | Cantidad de reintentos en el caso que el envio de una petición falle. | 5
|
WORKER_RETRASO | Tiempo en milisegundos de retraso entre peticiones en una cola. | 2000
|
WORKER_EXPIRACION | Opcional, tiempo de expiración de una petición dentro de una cola. | |
WORKER_PRIORIDAD | Opcional, prioridad de un mensaje en la cola. |