launcher.conf
The following is a list of available options that can be specified in the launcher.conf configuration file, which controls behavior of the rstudio-launcher process, and its clusters.
Launcher Settings
address
IPv4 or IPv6 address, or path to Unix domain socket.
Type: string
Default: locahost
port
The port number to listen on in the range of (0-65535). This is required when using an IPv4 or IPv6 address.
Type: string
Default: 5559
enable-ssl
Toggle usage of SSL encryption for connections.
Type: bool
Default: 0
certificate-file
Certificate chain file of public certificates to present to incoming connections. It must be readable by the server-user user. This is required when SSL is enabled.
Type: string
Default: <empty string>
certificate-key-file
Certificate private key file used for encryption. It must be readable by the server-user user. This is required when SSL is enabled.
Type: string
Default: <empty string>
server-user
The user account of the Launcher Server process. The Launcher should be started as root and lowers its privilege to this user for normal execution.
Type: string
Default: rstudio-server
admin-group
Specifies the group name of users that are able to see/control all jobs in the system, including jobs belonging to other users. If using with Posit Workbench, this must match the rserver.conf’s server-user’s group value.
Type: string
Default: <empty string>
thread-pool-size
Size of the thread pools used by the launcher.
Type: int
Default: <number of CPUs * 2>
request-timeout-seconds
Number of seconds a plugin has to process a request before it is considered timed out.
Type: int
Default: 120
bootstrap-timeout-seconds
Number of seconds a plugin has to bootstrap before it is considered a failure.
Type: int
Default: 120
max-message-size
Maximum allowed size (in bytes) of messages sent by plugins. It is strongly recommended you do not change this, but it may be increased if you exceed the limit.
Type: int
Default: 5242880
enable-debug-logging
Enables/disables verbose debug logging. Can be 1 (enabled) or 0 (disabled).
Type: bool
Default: 0
scratch-path
Scratch directory where the launcher and its plugins write temporary state.
Type: string
Default: /var/lib/rstudio-launcher
logging-dir
Specifies the path where debug logs are written.
Type: string
Default: /var/log/rstudio/launcher
Cluster Settings
name
Friendly name of the cluster.
Type: string
Default: <empty string>
type
Type of the cluster, this is for human consumption, for display purposes, and is also used to infer some settings. Can be one of Local, Kubernetes, or Slurm.
Type: string
Default: <empty string>
exe
Path to the plugin executable for this cluster. If using a plugin provided by Posit like Local, Kubernetes, or Slurm, this will be inferred from the value of type. If using a custom plugin, you must provide the executable path by configuring this option.
Type: string
Default: <inferred path> or <empty string>
config-file
Path to the configuration file for the plugin. Each plugin will have its own default config location, the three plugins shipped by Posit, Local, Kubernetes, and Slurm default to using /etc/rstudio/launcher.local.conf, etc/rstudio/launcher.kubernetes.conf, and /etc/rstudio/launcher.slurm.conf respectively. Custom plugins will be required to specify their configuration file.
Type: string
Default: /etc/rstudio/launcher.<plugin-type>.conf
allowed-groups
Comma-separated list of user groups that may access this cluster. An empty string indicates that all groups may access this cluster.
Type: string
Default: <empty string>