Lua

Loads dynamic users by running a local Lua script.

The following variables are defined when the script is executed:

• __file__

  Absolute path of the script file

  Added in version 1.11.0.

The script returns the complete dynamic-user dataset as a JSON string.

When Lua is used as the source, the group cache is written in JSON format.

Note

The environment variables LUA_PATH and LUA_CPATH can be used to include additional Lua modules. Any ;; sequence in LUA_PATH is replaced by the default search path.

When configured as a map, the following keys are supported:

• fetch_script

  required, type: file path

  Path to the Lua script used to fetch dynamic users.

  The content of this script file should be like:

  -- TODO fetch users
  local result = "[]"
  -- return the JSON-encoded string
  return result
  

  alias: script

• fetch_timeout

  optional, type: humanize duration

  Timeout for running the fetch script.

  It is not recommended to set this value greater than refresh_interval in group config.

  default: 30s, alias: timeout

• report_script

  optional, type: file path

  Path to the Lua script used to report the parsing result for fetched dynamic users.

  Two global functions should be defined in this script, like this:

  function reportOk ()
    -- takes no argument
  end
  
  function reportErr (errMsg)
    -- takes one argument: the error-message string
  end
  

• report_timeout

  optional, type: humanize duration

  Timeout for running the report script.

  It is not recommended to set this value greater than refresh_interval in group config.

  default: 15s

Example

source:
  type: lua
  script: fetch_users.lua
  fetch_timeout: 10s
  report_script: report_users.lua
  report_timeout: 5s