OMLApp Component Installation Variables¶
In this section, we are going to list and explain each of the variables involved in a deployment of OMniLeads.
oml_infras_stage¶
It refers to the infrastructure provider involved. The idea is to take advantage of the APIs from cloud providers to determine resources like network parameters. If we are going to install onpremise or in a cloud-base platform not available in the list, assign onpremise as a value for the variable.
Posible values: onpremise, aws, digitalocean, vultr, linode.
oml_app_release¶
Here you should indicate which release to deploy
Posible values: master, develop, release-X.X.X.
oml_tenant_name¶
This variable should contain a reference name to assign to the deployment. Typically the name of the environment/client is used. It is designed for CCaaS (Contact Center as a Service) providers, environments where an instance of OMniLeads is executed for each subscriber of the service.
oml_callrec_device¶
Here we should indicate to the application, the location of the recordings of the calls.
Posibles valores: s3, s3-minio, s3-aws, nfs, local.
El valor local esta acotado al escenario en donde OMLApp y Asterisk (ACD) comparten el mismo Linux host e implica que las grabaciones y otra data persistente queden almacenadas en el disco local donde se ejecutan ambos componentes.
Por otro lado cuando los componentes ACD (Asterisk) y OMLApp (django/uwsgi) se ubican en instancias Linux independientes tenemos la obligación de utilizar un recurso compartido para almacenar grabaciones y data persistente.
Aquí podemos usar el concepto de bucket en object storage DB o NFS. Las opciones s3, s3-minio o s3-aws son para indicar se va a utilizar un bucket de AWS, tambien se puede indicar si se desea operar con un bucket S3 minio , o bien si se utiliza el parametro s3 la configuracion recae sobre un formato s3 generico.
Finalmente respecto al uso de un NFS para guardar las grabaciones, podemos utilizar cualquier herramienta que proporcione almacenamiento de red NFS y asi el valor de nuestro parametro sera nfs.
s3_access_key, s3_secret_key, s3_endpoint_url y s3_region¶
Éstas variables sólamente son necesarias cuando se utiliza el object storage S3. Allí se debe indicar las claves para autenticarse, junto al URL y nombre del bucket que va a contener las grabaciones.
De no utilizar s3, dichas variables deberan ser inicializadas como NULL.
nfs_host¶
Ésta variable es necesaria asignar sólamente cuando se utiliza NFS como recurso de almacenamiento de grabaciones. Y debe contener la direccion de red del host que provee NFS.
oml_nic¶
Here we should indicate the network interface on which TCP 443 port is set in order to process HTTPS requests.
Important
Ideally, an interface located on a private subnet should be provided and it is neccessary to use a load balancer component or proxy/firewall that connect to the public subnet, in case you need to enable access from users from the Internet.
oml_ami_user y oml_ami_password¶
These 2 variables are neccessary to define the username and password that will use OMLApp to connect to the Asterisk AMI API.
Important
If we are in a scenario where Asterisk and OMLApp run on Linux host independent, then here we should put the values used for Install the ACD (Asterisk) component.
oml_acd_host¶
Here we indicate the network address of the ACD component (Asterisk), in the case it runs on a Linux host other than OMLApp.
Important
In case of sharing OMLApp host and ACD (Asterisk), it should explicitly set to NULL.
oml_pgsql_host y oml_pgsql_port¶
The 2 variables refer to the network address and port where PostgreSQL component receives requests from OMLApp.
Important
In case of sharing OMLApp and PostgreSQL host, it should be set explicitly to NULL.
oml_pgsql_db, oml_pgsql_user y oml_pgsql_password¶
The 3 variables have to do with the name of the database where we will create all the necessary tables, together with the username and password thatwill be allowed to interact with them.
OMLApp will use these variables to interact with the PostgreSQL engine.
oml_pgsql_cloud¶
This variable is used to tell the OMLApp installer to install the PLPERL extension, so you just have to set it to “true” when the PostgreSQL-11 that we are going to use as the engine is provided as turnkey, that is to say, when (either in an onpremise environment or cloud) the component is installed WITHOUT using the RPM provided by OMniLeads.
Posible values: true, false.
oml_pgsql_ha & oml_pgsql_readonly_host¶
Este par de variables permiten que la App realice las transacciones SQL de escritura sobre el nodo principal del cluster Postgres (RW), mientras que las operaciones de solo lectura seran realizadas sobre el nodo de replica del cluster HA.
Por lo que solo se deberan utilizar en caso de que PostgreSQL este disponible como cluster de alta disponibilidad.
Posible values: true, false.
api_dialer_user y api_dialer_password¶
Here you define the parameters that OMLApp will use to authenticate with the WombatDialer API.
oml_dialer_host¶
In case of deploying WombatDialer on a dedicated Linux host, you should indicate the network address so that OMLApp can reach it.
Posible values: dirección_de_red, NULL.
oml_rtpengine_host, oml_kamailio_host, oml_redis_host, oml_websocket_host and oml_websocket_port¶
Ésta colección de variables hacen alusión al hecho de declarar la direccion de red de dichos componentes. Cada uno de éstos componentes que se hayan alojado en un Linux host exclusivo y aislado de OMLApp, deberán ser declarados con su dirección de red, y puerto (en caso de ser necesario).
Si los componentes conviven dentro del mismo host que OMLApp, entonces se deben declarar como NULL.
oml_redis_ha¶
En el caso de desplegar el componente REDIS en alta disponibilidad redis sentinel
oml_sentinel_host_01, oml_sentinel_host_02 & oml_sentinel_host_03¶
Estos tres parametros implican la direccion de red de cada uno de los nodos replica de redis. En la seccion de about_high_availability, se profundiza al respecto.
oml_extern_ip¶
In case of being in an environment where the ACD (Asterisk) and RTPEngine coexist with OMLApp, then here you should indicate the Public network address that is affecting the NAT level deployment.
Posible values: none, auto, X.X.X.X.
The value none implies that we are not going to use access from the Internet to the application; if it is configured as auto then the installation will try to detect the public IP in which NAT is being performed to reach packages that go out to the Internet; and finally it is also feasible to declare the explicit public network address (X.X.X.X).
oml_tz¶
Aquí se indica la zona horaria donde se ejecuta la instancia de OMniLeads.
oml_app_sca¶
The session time (in seconds) to apply to the user login by HTTPS.
oml_app_ecctl¶
The rotation time of the ephemeral credentials with which a user is authenticated at the SIP over websocket level against Kamailio.
oml_app_login_fail_limit¶
The number of failed HTTPS login attempts by users, until blocked by Django-Defender.
oml_high_load¶
Al ser inicializado en “on” se disparan una serie de optimizaciones a nivel configuracuon sobre Redis y Django/uwsgi. Para entornos de carga mayor a 200 usuarios concurrentes.
oml_google_maps_api_key¶
Se inicializa con “true”, en caso de utilizar la integracion con google maps para visualizar ubicaciones en el formulariom de atencion.
oml_google_maps_center¶
Se debe proporcionar los parametros de latitud y longitud correspondientes a su ubicacion. Ejemplo: oml_google_maps_center=’{ “lat”: -31.416668, “lng”: -64.183334 }’.
oml_smtp_relay¶
A partir del release-1.25 se puede configurar un SMTP relay para acudir al mismo a la hora de enviar correos. Al momento de crear usuarios o bien a la hora de generar algun reporte que deba ser adjuntado en un correo.
Si se ha habilitado el smtp relay, entonces se deben indicar los parametros sub-siguientes.
oml_email_host¶
Aqui se indica la direccion de red del servidor smtp.
oml_email_port¶
Aqui se indica el puerto de red TCP al que se debe apuntar.
oml_email_user¶
Username para autenticar contra el servidior SMTP.
oml_email_password¶
Password para autenticar contra el servidior SMTP.
oml_email_default_from¶
El from que va a figurar en los correos enviados.
oml_email_use_tls¶
Aqui se indica con “true” si se requiere utulizar TLS.
oml_email_use_ssl¶
Aqui se indica con “true” si se requiere utulizar SSL.