Server configuration

General

In 1.7+ there is an option to configure various settings through the GUI. You can find it under Administrator->System settings. Changing the configuration may require a server restart. You can do it with the "Restart application" button.

Most of the properties are located in the application.properties file inside the master image. This file always contains the default values and if you want to overwrite them you can do it via the application-prod.properties file which you can bind mount to the container or with environment variables in the docker-compose file. There are some properties that are only overwritable this way and few of them are required for the server to work properly. The best example is the database connection properties.

To be clear, there are 4 levels of configuration. Every higher level overwrites the lower ones.

  1. application.properties
    • located in the image
    • contains only default (or empty) values
    • not changeable
  2. environment variables in docker compose file
    • you can configure under the master container's environment in the docker compose file
    • environment variables used by application.properties
    • changes may cause server failure
    • changes require a recompose
  3. application-prod.properties
    • located in the host machine under ${VOLUMES_PATH}/master/config/
    • put the properties here which you want to overwrite
    • used for low level or required configuration
    • changes may cause server failure
    • changes require a server restart
  4. System settings menu
    • you can find it under Administrator->System settings
    • overwritten properties are stored in the database (config table)

If we installed your server, you can start the configuration on the 4d level.

Module configurations

Mail settings

Setting up SMTP on your server allows the system to send out email notifications.

Some functions that SMTP affects:

  • Collected interaction data from content can be sent out in an E-mail.
  • Alerting system.
  • System notifications like "User created/removed on server" are sent in an E-mail to the system admin's email address.
  • Forgot password request does not work without SMTP.
  • "Contact us" messages does not work without SMTP.
  • When creating a new user without the password input field filled you cannot send out a "Set new password" E-mail to the registered email address. If SMTP is disabled you cannot register the user without first creating a password.
  • The invoice function sends notifications in E-mail when a customer needs to be invoiced.

User management emails:

  • Forgot password and password reset emails
  • User created/removed
  • User restricted/un-restricted
  • User self-registered (through the public registration form, if it's enabled)

System emails:

  • Security warnings (e.g. someone has modified a system administrator's role or password)
  • Client expiration notifications
  • License requests (sent by clients from Settings->Licenses->License orders->Order more licenses)
  • Invoice notifications

Emails sent from the contents:

  • There is an option to send an email from the content. In this case, you can uniquely configure where and what you want to send. The API is secured and can only be used by validated Wallboard devices and contents.

Alerts:

  • In our system, there is an option to create alerts (e.g. device went offline). For the alerts, you can configure email notification channels, where you can define the exact recipients. See more about Alerts.

Client emails:

  • Feedback, Suggestion, Help
    • Recipient precedence (if one is not present, falls back to the next one): Support email, defined for the client explicitly > Support email defined in system settings > System admin address
  • Content request
    • Recipient precedence: Content designer email, defined for the client explicitly > System admin address

Configuration:

  • Enabled - Enable/disable email sending
  • SMTP server host (e.g. smtp.office365.com)
  • SMTP server port (usually 587)
  • Use SSL/TLS
  • Username/Password (of the SMTP user)
  • Sender email address (make sure that the SMTP user can send mails as the given address)
  • System admin email address (content request, customer expiration, license request, and security warning emails)
  • Invoicing email address (invoice notification emails)
  • Support email address (feedback emails)
  • Default localization (if the emails are translated to the given language it will use that translation, otherwise the fallback is English)
SMS and Twilio settings

Depending services:

  • SMS alerting.

Configuration:

  • SMS sending enabled - enable/disable SMS sending
  • Twilio - more information at https://www.twilio.com
    • Twilio authorization token
    • Twilio account-SID
    • Sender phone number
Google reCAPTCHA settings

Depending services:

  • reCAPTCHA on login screen - to avoid bots

Configuration:

  • Google reCAPTCHA enabled on the login page - enable/disable reCAPTCHA
  • Site key
  • Secret key

Our detailed guide: google-recapthca-configuration

Google Analytics settings

No depending on service.

Configuration:

  • Google Analytics ID

Our detailed guide: google-analytics-guide

Google API settings

If you want to use our configuration please contact us and we'll enable the server's URL. Otherwise, you can create your own google credentials. To do this here's our guide: how-to-create-google-credentials

Depending services:

  • "Create new Google spreadsheet" option under Settings(client)->Datasources
  • Google drive folder synchronization (guide)

Configuration:

  • Google API Oauth2 client-id
  • Google API Oauth2 client-secret
  • Google API key
Microsoft API settings

If you want to use our configuration please contact us and we'll enable the server's URL. Otherwise, you can create your own Microsoft credentials. To do this here's our guide: how-to-create-microsoft-api-credentials

Depending services:

  • Onedrive and SharePoint folder synchronization (guide)

Configuration:

  • Ms API Oauth2 client-id
  • Ms API Oauth2 client-secret
Customer settings
  • Edit default visible UI Elements
  • Upload file size limit
    • Only applies to a customer, the admin still can upload bigger files.
    • Cannot be bigger than the global application-level settings.
  • Minimum datasource refresh time
    • Only applies to customers, admin still can create datasource with smaller refresh time.
    • With the "Apply" button you can set this value on all existing datasources (only applies if its refresh time was smaller).
Site settings
  • Product name
  • Self-registration enabled - enable/disable customer registration on login page (requires valid device activation code)
  • System root URL - full domain name of the server (include protocol)
  • System default language
  • Tutorial video URL - video shown to a new client until creates at least one content
  • Template gallery URL
  • Frame element default URL value
  • Frame element touch actions enabled
  • Demo mode element touch actions enabled
  • Right to left writing direction enabled in the editor
  • Custom HP Loop template enabled
  • Show privacy policy page enabled
  • Default Google Docs URL
  • Default Calendar URL
System settings
  • Device application update base filename
  • DMS secret
  • HTTP user agent(used for datasource download)
  • Websocket heartbeat enabled
    • We strongly recommend enabling it.
    • Disable can cause slower online-offline state detection and anomalies.
  • Authorization server URL (OAuth2)
    • URL of the authorization server - the application server contains an authorization server (OAuth2)
    • example: https://yourDomain.com
  • Swagger destination host
    • same as config.domain without protocol
    • example: yourDomain.com
    • used by swagger to know where to send the API requests
    • if not set swagger won't work
  • Location by IP resolve enabled - enable/disable device location resolve
  • Grafana device monitoring enabled

Advanced - low-level settings

If we installed your server please contact us if you need any change. These properties are only overwritable through the application-prod.properties or docker-compose files. Check our installation guide for more information about the required properties.

Maximum file upload size
  • spring.http.multipart.max-file-size and spring.http.multipart.max-request-size
    • Defines the maximum uploadable file size.
    • The default value is 1024MB.
    • Always change both properties to the same value.
    • In docker-compose use the 'max-upload-file-size' variable to change both property
  • management.security.enabled
    • The default value is false.
    • Set it to true to disable the spring actuator. This means that application server monitoring won't be available.
    • In docker-compose use the 'actuator-security-enabled' variable to configure this property
  • storage.path
    • The path where the application files are stored. (e.g. contents)
    • This property is only overwritable through application-prod.properties file
    • Only change it if you are not using our docker image!
Sorry, your browser does not support inline SVG. article updatedarticle updated5/13/2022 9:55:30 AM (UTC)5/13/2022 9:55:30 AM (UTC)