Lua

Fetch users through local lua script.

The following vars will be defined when running the script:

• __file__

  This will be the absolute path of the script file

  Added in version 1.11.0.

The return value of the script should be the json encoded string of all dynamic users.

Note

Environment variable LUA_PATH and LUA_CPATH can be set to include more lua module files. Any “;;” in the value of the LUA_PATH environment variable will be replaced by the default path.

The keys used in map format are:

• fetch_script

  required, type: file path

  The path of the lua script 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

  Set the timeout value for the execution of the fetch script.

  It’s not recommended to set the timeout value greater the refresh_interval in group config.

  default: 30s, alias: timeout

• report_script

  optional, type: file path

  The path of the lua script to report the parse result of the 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, which the error message string
  end
  

• report_timeout

  optional, type: humanize duration

  Set the timeout value for the execution of the report script.

  It’s not recommended to set the timeout value greater the refresh_interval in group config.

  default: 15s, alias: timeout