Configuration#

Configuration is separated into 3 different places:

• /etc/smasch/smasch.py config file - this contains all required parameters to run smasch properly, changes require smasch restart
• General configuration in the UI - contains global smasch configuration that does not require restart of smasch
• Study configuration in the UI - contains study related configuration options

System configuration in /etc/smasch/smasch.py#

• SECRET_KEY - long random string used for cryptographic signing, and should be set to a unique, unpredictable value.

SECRET_KEY = 'L,C2Vgp7kn4\]adyV6R:?.,K/!D&X$}N'

• SERVE_STATIC - True/False value defining if smasch should server static files. In heavy used production machines it’s recommended that static files are served directly via nginx/apache

SERVE_STATIC = True

• STATIC_ROOT - folder where static files (js, css, etc) are stored, example:

STATIC_ROOT = '/usr/lib/smasch/data/static'

• MEDIA_ROOT - folder where uploaded media files are stored (like language images)

MEDIA_ROOT = '/usr/lib/smasch/data/media'

• UPLOAD_ROOT - folder where patient specific files are stored

UPLOAD_ROOT = '/usr/lib/smasch/data/upload'

• ETL_ROOT - folder where automatic ETL files should be stored. Automatic ETL would allow for daily import/export to csv format.

ETL_ROOT = '/usr/lib/smasch/data/etl'

• LOGGING - definition of loggers used by smasch

LOGGING = {
  'version': 1,
  'disable_existing_loggers': False,
  'handlers': {
    'file': {
      'level': 'INFO',
      'class': 'logging.FileHandler',
      'filename': '/var/log/smasch/smasch.log',
      'formatter': 'verbose'
    },
    'console': {
      'class': 'logging.StreamHandler',
      'level': 'DEBUG',
      'formatter': 'simple'
    },
  },
  'formatters': {
    'verbose': {
      'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
    },
    'simple': {
      'format': '%(levelname)s %(message)s'
    },
  },
  'loggers': {
    'django': {
      'handlers': ['file'],
      'level': 'INFO',
    },
    'web': {
      'handlers': ['file'],
      'level': 'DEBUG',
    },
  },
}

• TWO_FACTOR_SMS_GATEWAY - engine used for Two-Factor Authentication. Currently, the only supported engine is NEXMO (web.nexmo_gateway.Nexmo).

TWO_FACTOR_SMS_GATEWAY = "web.nexmo_gateway.Nexmo"

• FORCE_2FA - True/False defining if Two-Factor Authentication is obligatory.

FORCE_2FA = True

• NPM_ROOT_PATH - absolute root path of smasch

NPM_ROOT_PATH = '/usr/lib/smasch/'

• MESSAGE_STORAGE - defines how messages to the UI are sent. By default, messages are sent using cookies ('django.contrib.messages.storage.cookie.CookieStorage'). However, if there is a problem with cookies you can change it to session.

MESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'

• DEBUG - True/False defines if debug information should be provided. It should be used only in development/debugging process (provided information might be confidential).

DEBUG = False

• ALLOWED_HOSTS - list of allowed host. If your smasch instance is going to be accessed by https://example.com/ url you need to add example.com here.

ALLOWED_HOSTS = ['127.0.0.1', 'localhost', 'example.com']

• EMAIL_HOST - SMTP server.

EMAIL_HOST = 'smtp.gmail.com'

• EMAIL_HOST_USER - SMTP user.

EMAIL_HOST_USER = 'your_account@gmail.com'

• EMAIL_HOST_PASSWORD - SMTP user password

EMAIL_HOST_PASSWORD = 'your account’s password'

• EMAIL_PORT - SMTP port

EMAIL_PORT = 587

• EMAIL_USE_TLS - use TLS when connecting to SMTP server

EMAIL_USE_TLS = True

• EMAIL_USE_SSL - use SSL when connecting to SMTP server

EMAIL_USE_SSL = True

• EMAIL_BACKEND - specifies the backend that will work with the host email server. For SMTP server it should be set to django.core.mail.backends.smtp.EmailBackend

EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'

Back to top

General configuration in the UI#

Go to left panel subcategory General in Configuration. Change the Value field and click corresponding Save button for each change you made.

{:style=“display:block;margin-top:10px;”}

The table below contains explanation of the configurable parameters. The descriptions are grouped as per feature - not following the order displayed in the list at Configuration general page.

Note: Passwords/API tokens are not visible - you can only write the value, but cannot read it.

Back to top

Two-Factor Authentication#

Smasch supports Two-Factor Authentication without any configuration. Users can enable it by clicking Security in the user profile:

{:style=“display:block;width:200px”}

This allows to use Token generator as a 2FA provider.

Additionally, there is possibility to use NEXMO for sending text messages. To enable it you must provide NEXMO API KEY and API SECRET in the global configuration. You can also specify phone number or name that will appear in the sent messages.

To make 2FA obligatory you need to set FORCE_2FA = True in /etc/smasch/smasch.py file.

Back to top