Advanced Config

In the /integrations subfolder of the server configuration you find an example file structure that can be used to manage advanced settings.

# Change OTP Maximum Uses and Login Attempts


You can make the following additional config to any apps configured in the mfa section (note that this example refers to an app which has been named global for which you should already have specified the client ID and client secret in the core.yaml file):

    max_uses: 1
    max_attempts: 3

Note that otp_endpoint should always be

max_uses controls the number of times an issued OTP can be used before it expires.

max_attempts controls the number of incorrect attempts a user can make before they are blocked. The maximum recommended value for this is 5.

# Change Log Level


  level: INFO

The level can be set to “ERROR”, “WARN”, “INFO” or “DEBUG”.

Note that it should not be set to DEBUG in a production environment.

# Stats for System Performance


The program uses StatsD to collect usage metrics which can then be used with a StatsD-compatible client such as Graphite to visually render key system performance information such as session starts, logins, communicating with the authentication server, spikes in 404 statuses etc.

An example config would be:

  prefix: miracl-radius
  network: udp
  address: :8125

Note that prefix defines the prefix that is given to each bucket of stats. Address can be in the format of ‘url:port’ or just ‘port’.

The above example would be suitable for a Graphite installation, as Graphite listens on port 8125 by default. A useful Docker image for Graphite can be found at

# Session Settings

By default the MIRACL Trust RADIUS server uses internal memory to store its collected logged in sessions. Below is the default config.


    cleanup_interval: 60

You can specify Redis as external storage. This enables multiple instances of the server to share storage. Redis can be used locally or installed on a separate machine. In a production environment, AWS ElastiCache may be used. You can enable it by including its configuration path in the main service configuration (/etc/miracl-radius/config.yaml):


    network: tcp
    address: :6379
    password: <PASSWORD>

# Return Attributes

There are cases when you would want to send predefined attributes from the RADIUS server to the RADIUS client. This could be achieved by the host.return_attributes section.

    name: docker
    - - ldap: ldap_profile
    mfa: global
    secret: <SECRET>
      Reply-Message: Hello, from MIRACL
      Acct-Interim-Interval: 600
          Fortinet-Group-Name: MiraclGroup

The key of the returned attribute should be a valid RADIUS attribute name and its value should be valid type per its specification. Note that it supports vendor-specific attributes as here is the required structure:

      Vendor-Type1: Value
      - Value1
      - Value2

Currently MIRACL RADIUS server supports only MS and Fortinet Vendor-IDs.