Table of Contents
Graphlytic's configuration is stored in the "conf/graphlytic.conf" file.
After any change in the graphlytic.conf file an application restart is needed in order for the changes to take effect.
The configuration contains the mandatory configuration and also some optional configurations which are in most cases used as default values and can be modified directly in the application.
1. Environment Variables
Every configuration in the graphlytic.conf file can be overridden with environment variables of the OS (environment variables have higher priority than the graphlytic.conf values).
The environment variable names have to be written in uppercase with underscore "_" as separators (instead of the dot "." in the graphlytic.conf file), e.g. "MAIN_LOGDIR".
Environment variables can be used only when Graphlytic is run as a console application. They do not work when Graphlytic is run as a system service.
Variables, that are not configurable in graphlytic.conf but only with environment variables:
Port used for unencrypted application access.
Port used for encrypted application access.
Maximum memory allocation pool for Graphlytic. Example value: 1g
Initial memory allocation pool for Graphlytic. Example value: 256m
2. Mandatory Configuration
# where Graphlytic stores its data
# where Graphlytic stores log files
# where Graphlytic stores external widgets
# where Graphlytic stores external icons
# where Graphlytic stores email templates
# OPTIONAL (default is the main.dataDir value) - where Graphlytic stores the license key
Location of the directory where Graphlytic stores its internal database.
Location of the directory with application logs.
Location of the directory with custom widgets installed in the application.
Location of the directory with custom icons available in the application to be used to style the graph visualizations.
Location of the directory with email templates.
Location of the directory where Graphlytic stores the license key. This is an optional parameter. If not defined, the main.dataDir value is used.
3. Optional Configurations
3.1. Default Graph Connection
Different graph connections (together with a custom certificate upload) can be managed directly in the application. For more info see: Graph Connections
Neo4j connection defined in the graphlytic.conf file is used as a default configuration.
Default Graph Connection
# Default Neo4j Bolt connection
#encryption of the connection to DB. Neo4j 4 requires ssl to be explicitly enabled and configured. It does not accept default self-signed Neo4j 3 certificates.
Graph Database type. Values: NEO4J_5, NEO4J_5_ENTERPRISE, NEO4J_4, NEO4J_4_ENTERPRISE, NEO4J_35, MEMGRAPH
Graph Database Bolt protocol URL
Graph connection username
Graph connection password
Graph connection encryption. If a trusted certificate is used on the Graph Database side then just set this to true. If it's an untrusted certificate please use the UI to load the certificate into Graphlytics's Keystore. For more info see: Graph Connections
3.2. Default SMTP Configuration
SMTP connection can be managed also directly in the app. For more info please refer to SMTP Email Server Connection.
To override the default SMTP configuration during app startup, add these options to the graphlytic.conf file and change the values to your desired configuration.
# SMTP connection
Value data type
SMTP connection configuration - enable/disable configuration
SMTP connection configuration - hostname of the email server
SMTP connection configuration - port number of the email server
SMTP connection configuration - email server's user used to send emails
SMTP connection configuration - user's password
SMTP connection configuration - enable/disable (true/false) authentication for the email server
SMTP connection configuration - enable/disable (true/false) TLS communication
Email address string
Email address used in sending emails as the "from" address
SMTP connection is tested during Graphlytic startup. If the connection was successful an info message is in the log.
- SMTP connection successful
- SMTP server is unreachable
3.3. Default Password Reset Configuration
Password Reset configuration can be managed also directly in the app. For more info please refer to Email Invitations and Password Reset.
To override the default Password Reset configuration during app startup, add these options to the graphlytic.conf file and change the values to your desired configuration.
# Email Templates
email.template.password.reset.subject=Testing password reset
email.template.password.create.subject=Testing password create
email.template.password.change.subject=Testing password change
# Email links validity durations (Java duration format)
Value data type
Base path used to generate an URL link in emails. The Graphlytic's instance base URL should be used here.
Relative or absolute path to the folder with the email templates.
The subject of the email sent after the login's page forgot password form submit
File name string
The filename of the email template used to generate the email sent after the login's page forgot password form submit
The subject of the email sent after a new user is created with an invitation email
File name string
The filename of the email template used to generate the email sent after a new user is created with an invitation email
The subject of the email sent after the user's password is force-reset by the admin
File name string
The filename of the email template used to generate the email after the user's password is force-reset by the admin
Java duration string
Validity duration for password change links generated on the login's page forgot password form. Format: ISO 8601 duration.
Java duration string
Validity duration for password change links generated by the admin on the User management page. Format: ISO 8601 duration.
Java duration string
Validity duration for invitation links generated when a new user is created. Format: ISO 8601 duration.
3.4. Default Single Sign-On Configuration
Single Sign-On configuration can be managed also directly in the app. For more info please refer to Single sign-on.
To override the default Single Sign-On configuration during app startup, add these options to the graphlytic.conf file and change the values to your desired configuration.
# SAML2 IdP connection
saml2.idpid.loginButtonLabel=Sign in with SSO
# Group mapping
If set to true the user is automatically redirected to the SSO login from the Login page. For accessing the Login page please use URL with the logout parameter, e.g. "https://yourdomain.com/login?logout=true"
SAML2 IdP connection
Sign in with SSO
Title of the Login page button. If missing, saml2.idpid.name, will be used instead.
Name of this configuration. Will be also used in assertion consumer url
Path to the IdP certificate for IdP signing verification. This certificate is used to verify that the response is correct and that it was sent from the contacted IdP.
Path to the IdP certificate for encryption. Can be empty for no encryption. If defined, this certificate is used to decrypt messages from IdP.
The IdP entity identifier (Asserting Party Entity Id).
The local application (Graphlytic) ID for IdP communication. Has to be created in the IdP configuration.
Login redirect URL. The user will be redirected to this location during the login workflow.
Assertion URL where the successfully logged-in user is redirected back from the IdP. If not defined a default value is used (this value is sent in the IdP request and some IdPs are automatically reading and using this value).
The claim name in the returned XML where the user group mappings are returned.
Name of a Graphlytic user group that will be used if no mapping was successful. If the defaultGroup is not configured or the group doesn't exist in Graphlytic then such user (with no user groups) is not created in Graphlytic (to minimize license consumption).
Group mapping "SomeActiveDirGroup" >> "gl-administrators"
Group mapping "OtherActiveDirGroup" >> "custom-gl-group"
3.5. Branding Options
This option is as of version 4.1 obsolete. Use in-app Site Branding to customize branding.
When migrating to version 4.1, your old branding settings are automatically moved to the in-app configuration.
Graphlytic supports basic branding options like changing the logo, header background color, or application title shown on the Login page.
# Branding - custom logo & header background
Application title shown on the Login page.
Logo shown on every page in the left top corner.
Color of the header panel shown on every page. Can be any CSS color value, e.g. #1d8ece, #000, rgb(50, 50, 50) or rgba(100, 100, 100, 0.5).
3.6. HSQL Schema Name
The name of the database schema used in Graphlytic's internal database can be configured in the graphlytic.conf file. The default value is GRAPHLYTIC and in most cases, there's no need to change the value. This configuration can be used to store the configuration of multiple Graphlytic instances in one HSQL database, but this is a very rare situation and generally, we discourage doing so.
#HSQLDB schema name