Execute Scripts

Some features, e.g. welcome execute an external script. This is configured with the execute settings. Currently only a single script execution at a time is supported.

Supported script execution drivers are:

Name	Description
unix	Connect to UNIX socket.
tcp	Connect to TCP socket.
fork	Fork and execute the script directly.

UNIX Sockets

Execute the script via a script service listening on a UNIX socket. The service must execute the script binary to provide the proper communication API.

Example:

execute test-script {
  #driver = unix # default
  args = hello %{user}
}
service test-script-service {
  execute = script /usr/local/bin/test-script.sh one
  unix_listener test-script {
    path = 0666
  }
}

The test-script.sh is executed with parameters one hello <username>.

TCP sockets

Execute the script via a script service listening on a TCP socket. The service must execute the script binary to provide the proper communication API.

Example:

execute localhost:12345 {
  driver = tcp # default
  args = hello %{user}
}
service test-script-service {
  execute = script /usr/local/bin/test-script.sh one
  inet_listener {
    port = 12345
  }
}

The test-script.sh is executed with parameters one hello <username>.

Fork and Execute

Fork the process and execute the script directly.

Example:

execute /usr/local/bin/test-script.sh {
  driver = fork
  args = hello %{user}
}

The test-script.sh is executed with parameters hello <username>.

Execute Settings

execute

Default	[None]
Value	Named List Filter
See Also	Execute Scripts

Configure external execution script. Used by various different features, such as welcome. Currently only a single execute block (per feature) is allowed.

execute_args

Default	[None]
Value	string

External execution script arguments. The parameters are split by space characters. Currently escape characters are not supported.

execute_driver

Default	[None]
Value	string
Allowed Values	unixforktcp
See Also	Execute Scripts

How to execute the external script:

unix

Use UNIX socket connection to a script service listening in execute_unix_socket_path.

fork

Fork and execute the execute_fork_path binary directly.

tcp

Use TCP connection to a script service listening in execute_tcp_host:execute_tcp_port.

execute_fork_path

Default	execute_name
Value	string

Path to the binary that is executed with execute_driver = fork.

execute_name

Default	[None]
Value	string

Name of the execution script. This is the execute named filter name. It is also used to provide a default driver-specific settings:

unix

Used as the default for execute_unix_socket_path.

fork

Used as the default for execute_fork_path.

tcp

Used as the default for execute_tcp_host:execute_tcp_port.

execute_tcp_host

Default	execute_name = host:
Value	string

TCP host where to connect to with execute_driver = tcp.

execute_tcp_port

Default	execute_name = :port
Value	string

TCP port where to connect to with execute_driver = tcp.

execute_unix_socket_path

Default	execute_name
Value	string

UNIX socket path where to connect to with execute_driver = unix.