NirvaShare Config Properties
NirvaShare properties can be overridden in config.properties file. Below are the list of properties that can be used during the production deployment and all are optional.
- In the SSH to Linux terminal where NirvaShare is installed, create a file with the below path and file name. Make sure that you login as a root user.
/var/nirvashare/config.propertiesThe property names are mentioned below along with the description.
No | Property Name | Description |
|---|---|---|
1 | ns_db_jdbc_url | Provide the JDBC url for external database. |
2 | ns_db_username | External database username having rights to create table and Read/Write data. |
3 | ns_db_password | External database password. |
4 | ns_reset_db_lock | Rarely database may get locked during service startup leading the wait for to come up. Set the value to true and restart the service to overcome. Make sure to remove this property after comes up. |
5 | ns_override_admin_password | If the password for the admin user is forgotten, this property can be set to allow temporary access with a desired password for the user "admin". Requires admin console restart. After login, please change the admin console password from UI and remove this property from the configuration. |
6 | ns_email_host | Email server hostname or IP address. Same can be configured in Admin Console UI under settings. |
7 | ns_email_port | Email server port example 465 / 587. Same can be configured in Admin Console UI under settings. |
8 | ns_email_from_address | Email server FROM address. Same can be configured in Admin Console UI under settings. |
9 | ns_email_username | Email server username. Same can be configured in Admin Console UI under settings. |
10 | ns_email_password | Email server password. Same can be configured in Admin Console UI under settings. |
11 | ns_email_reply_address | REPLY email address. Same can be configured in Admin Console UI under settings. |
12 | ns_email_enable_ssl | Enable SSL for email server . Same can be configured in Admin Console UI under settings. Valid values are true or false. |
13 | ns_email_trust_all_hosts | Enable to true in case of email server using self signed certificate . Same can be configured in Admin Console UI under settings. Valid values are true or false. |
14 | ns_email_enable_start_tls | Enable TLS for email server . Same can be configured in Admin Console UI under settings. Valid values are true or false. |
15 | ns_log_sql_trace | For enabling SQL logs. Valid values are true and false |
16 | ns_log_trace_level | For enabling application logs for the Admin Console, User applications, and Search service. Valid values are INFO, DEBUG, and ERROR. require a service restart after changing the configuration. |
17 | ns_admin_ip_range | The Admin Console's access can be restricted to a single IP address or a range of IP addresses. Example 104.207.151.83 or 104.207.151.0-104.207.151.100 |
18 | ns_external_idp | Used for enabling SSO with an external identity provider for the admin console. Valid values are true or false. |
19 | ns_auto_create_user | Admin Console SSO users have to be mapped to a corresponding user in the Admin Console. Set the value to true if users have to be automatically created and the default role is set in the Admin Console. |
20 | ns_saml2_sp_x509cert | Override X509 certificate to use in SAML assertion, otherwise default inbuilt certificate is used. |
21 | ns_saml2_sp_privatekey | Override X509 certificate's private key to use in SAML assertion, otherwise default inbuilt private key is used. |
22 | ns_saml2_sp_domain_url | Used for Admin Console SSO with external Identity Provider. Mention the Admin Console domain name in the format https://admin,yourdomain.com |
23 | ns_saml2_sp_company_name | Used for Admin Console SSO with external Identity Provider. Mention the company name, this is used during SAML assertion. |
24 | ns_saml2_sp_email | Used for Admin Console SSO with external Identity Provider. Mention the email address, this is used during SAML assertion. |
25 | ns_saml2_sp_auth_context | Used for Admin Console SSO with external Identity Provider. Mention the optional auth context to override used for MFA, this is used during SAML assertion. |