command-line options:
automation:
--run-automation [=arg(=1)] (=0) Run RStudio's built-in automation
tests. Requires a Google Chrome
installation.
--automation-filter arg A regular expression (ERE), indicating
which automation test file(s) should be
run.
--automation-markers arg One or more test markers, indicating
which tests should be run. Markers can
be separated by spaces.
verify:
--verify-installation arg (=0) Runs verification mode to verify the
current installation.
server:
--server-working-dir arg (=/) The default working directory of the
rserver process.
--server-user arg (=rstudio-server) The user account of the rserver
process.
--server-daemonize arg (=0) Indicates whether or not the rserver
process should run as a daemon.
--server-pid-file arg (=/var/run/rstudio-server.pid)
The path to a file where the rserver
daemon's pid is written.
--server-app-armor-enabled arg (=0) Indicates whether or not to enable
AppArmor profiles for the rserver
process.
--server-set-umask arg (=1) If enabled, sets the rserver process
umask to `022` on startup, which causes
new files to have `rw-r--r--`
permissions.
--secure-cookie-key-file arg If set, overrides the default path of
the secure-cookie-key file used for
encrypting cookies.
--server-data-dir arg (=/var/run/rstudio-server)
Path to the data directory where
RStudio Server will write run-time
state.
--server-add-header arg Adds a header to all responses from
RStudio Server. This option can be
specified multiple times to add
multiple headers.
www:
--www-address arg (=0.0.0.0) The network address that RStudio Server
will listen on for incoming
connections.
--www-port arg The port that RStudio Server will bind
to while listening for incoming
connections. If left empty, the port
will be automatically determined based
on your SSL settings (443 for SSL, 80
for no SSL).
--www-socket arg The socket that RStudio Server will
bind to while listening for incoming
connections. If left empty, a port will
be used.
--www-root-path arg (=/) The path prefix added by a proxy to the
incoming RStudio URL. This setting is
used so RStudio Server knows what path
it is being served from. If running
RStudio Server behind a path-modifying
proxy, this should be changed to match
the base RStudio Server URL.
--www-local-path arg (=www) The relative path from the RStudio
installation directory, or absolute
path where web assets are stored.
--www-symbol-maps-path arg (=www-symbolmaps)
The relative path from the RStudio
installation directory, or absolute
path, where symbol maps are stored.
--www-use-emulated-stack arg (=0) Indicates whether or not to use GWT's
emulated stack.
--www-thread-pool-size arg (=6) The size of the threadpool from which
requests will be serviced. This needs
to have enough threads to avoid
bottlenecks due to certain requests
that block the request thread (e.g. a
login fail might run into a delay
caused by the pam configuration). For
systems with lots of users a larger
value is recommended. For systems with
only one or two users, a value of 2
will be slightly more efficient.
--www-proxy-localhost arg (=1) Indicates whether or not to proxy
requests to localhost ports over the
main server port. This should generally
be enabled, and is used to proxy HTTP
traffic within a session that belongs
to code running within the session
(e.g. Shiny or Plumber APIs)
--www-verify-user-agent arg (=1) Indicates whether or not to verify
connecting browser user agents to
ensure they are compatible with RStudio
Server.
--www-same-site arg The value of the 'SameSite' attribute
on the cookies issued by RStudio
Server. Accepted values are 'none' or
'lax'. The value 'none' should be used
only when RStudio is hosted into an
iframe. For compatibility with some
browsers (i.e. Safari 12), duplicate
cookies will be issued by RStudio
Server when 'none' is used.
--www-frame-origin arg (=none) Specifies the allowed origin for the
iframe hosting RStudio if iframe
embedding is enabled.
--www-enable-origin-check arg (=0) If enabled, cause RStudio to enforce
that incoming request origins are from
the host domain. This can be added for
additional security. See
https://cheatsheetseries.owasp.org/chea
tsheets/Cross-Site_Request_Forgery_Prev
ention_Cheat_Sheet.html#verifying-origi
n-with-standard-headers
--www-allow-origin arg Specifies an additional origin that
requests are allowed from, even if it
does not match the host domain. Used if
origin checking is enabled. May be
specified multiple times for multiple
origins.
--session-use-file-storage arg (=1) Whether to use the file system to store
metadata about the session storage or
the internal database. Setting this to
false may require special network
configuration. See [Session
Storage](../server_management/session_s
torage.html) for more information.
--www-stats-monitor-seconds arg (=0) The time interval in seconds to log
info/debug messages with stats on
server performance. Set to 0 to
disable.
rsession:
--rsession-which-r arg The path to the main R program (e.g.
/usr/bin/R). This should be set if no
versions are specified in
/etc/rstudio/r-versions and the default
R installation is not available on the
system path.
--rsession-path arg (=rsession) The relative path from the RStudio
installation directory, or absolute
path to the rsession executable.
--rldpath-path arg (=r-ldpath) The path to the r-ldpath script which
specifies extra library paths for R
versions.
--rsession-ld-library-path arg Specifies additional LD_LIBRARY_PATHs
to use for R sessions.
--rsession-config-file arg If set, overrides the path to the
/etc/rstudio/rsession.conf
configuration file. The specified path
may be a relative path from the RStudio
installation directory, or an absolute
path.
--rsession-proxy-max-wait-secs arg (=30)
The maximum time to wait in seconds for
a successful response when proxying
requests to rsession.
--rsession-memory-limit-mb arg (=0) The limit in MB that an rsession
process may consume.
--rsession-stack-limit-mb arg (=0) The limit in MB that an rsession
process may consume for its stack.
--rsession-process-limit arg (=0) The maximum number of allowable
rsession processes.
database:
--database-config-file arg If set, overrides the path to the
/etc/rstudio/database.conf
configuration file.
--db-command arg Executes the shell command specified
injecting the current database
configuration in the command.
--db-connection-timeout arg (=15) Specifies the number of seconds to wait
for making a new db connection
auth:
--auth-none arg (=1) If set, disables multi-user
authentication. Workbench/Pro features
may not work in this mode.
--auth-validate-users arg (=0) Indicates whether or not to validate
that authenticated users exist on the
target system. Disabling this option
may cause issues to start or to run a
session.
--auth-stay-signed-in-days arg (=30) The number of days to keep a user
signed in when using the "Stay Signed
In" option. Will only take affect when
auth-timeout-minutes is 0 (disabled).
--auth-timeout-minutes arg (=60) The number of minutes a user will stay
logged in while idle before required to
sign in again. Set this to 0 (disabled)
to enable legacy timeout
auth-stay-signed-in-days.
--auth-encrypt-password arg (=1) Indicates whether or not to encrypt the
password sent from the login form. For
security purposes, we strongly
recommend you leave this enabled.
--auth-login-page-html arg (=/etc/rstudio/login.html)
The path to a file containing
additional HTML customization for the
login page.
--auth-rdp-login-page-html arg (=/etc/rstudio/rdplogin.html)
The path to a file containing
additional HTML customization for the
login page, as seen by RDP users.
--auth-required-user-group arg Specifies a group that users must be in
to be able to use RStudio.
--auth-minimum-user-id arg (=auto) Specifies a minimum user id value.
Users with a uid lower than this value
may not use RStudio.
--auth-pam-helper-path arg (=rserver-pam)
The relative path from the RStudio
installation directory, or absolute
path where the PAM helper binary
resides.
--auth-pam-require-password-prompt arg (=1)
Indicates whether or not to require the
"Password: " prompt before sending the
password via PAM. In most cases, this
should be enabled. If using a custom
PAM password prompt, you may need to
disable this setting if PAM logins do
not work correctly.
--auth-pam-requires-priv arg (=1) Deprecated - will always be true.
--auth-sign-in-throttle-seconds arg (=5)
The minimum amount of time a user must
wait before attempting to sign in again
after signing out.
--auth-revocation-list-dir arg If set, overrides the path to the
directory which contains the revocation
list to be used for storing expired
tokens. As of RStudio Server 1.4, this
has been moved to database storage, and
so this setting is deprecated, but will
be used to port over any existing
file-based expired tokens.
--auth-cookies-force-secure arg (=0) Indicates whether or not auth cookies
should be forcefully marked as secure.
This should be enabled if running an
SSL terminator in front of RStudio
Server. Otherwise, cookies will be
marked secure if SSL is configured.
monitor:
--monitor-interval-seconds arg (=60) The interval in seconds at which the
monitor is probed for new data.
databricks:
userProvisioning:
snowflake:
general:
--help print help message
--test-config test to ensure the config file is valid
--config-file arg configuration file
Options (51)
| Option | Description | Source |
|---|---|---|
--run-automation arg(=1) | Run RStudio's built-in automation tests. | help |
--automation-filter arg | A regular expression (ERE), indicating which automation test file(s) should be run. | help |
--automation-markers arg | One or more test markers, indicating which tests should be run. | help |
--verify-installation arg | Runs verification mode to verify the current installation. | help |
--server-working-dir arg | The default working directory of the rserver process. | help |
--server-user arg | The user account of the rserver process. | help |
--server-daemonize arg | Indicates whether or not the rserver process should run as a daemon. | help |
--server-app-armor-enabled arg | Indicates whether or not to enable AppArmor profiles for the rserver process. | help |
--server-set-umask arg | If enabled, sets the rserver process umask to `022` on startup, which causes new files to have `rw-r--r--` permissions. | help |
--secure-cookie-key-file arg | If set, overrides the default path of the secure-cookie-key file used for encrypting cookies. | help |
--server-add-header arg | Adds a header to all responses from RStudio Server. | help |
--www-address arg | The network address that RStudio Server will listen on for incoming connections. | help |
--www-port arg | The port that RStudio Server will bind to while listening for incoming connections. | help |
--www-socket arg | The socket that RStudio Server will bind to while listening for incoming connections. | help |
--www-root-path arg | The path prefix added by a proxy to the incoming RStudio URL. | help |
--www-local-path arg | The relative path from the RStudio installation directory, or absolute path where web assets are stored. | help |
--www-use-emulated-stack arg | Indicates whether or not to use GWT's emulated stack. | help |
--www-thread-pool-size arg | The size of the threadpool from which requests will be serviced. | help |
--www-proxy-localhost arg | Indicates whether or not to proxy requests to localhost ports over the main server port. | help |
--www-verify-user-agent arg | Indicates whether or not to verify connecting browser user agents to ensure they are compatible with RStudio Server. | help |
--www-same-site arg | The value of the 'SameSite' attribute on the cookies issued by RStudio Server. | help |
--www-frame-origin arg | Specifies the allowed origin for the iframe hosting RStudio if iframe embedding is enabled. | help |
--www-enable-origin-check arg | If enabled, cause RStudio to enforce that incoming request origins are from the host domain. | help |
--www-allow-origin arg | Specifies an additional origin that requests are allowed from, even if it does not match the host domain. | help |
--session-use-file-storage arg | Whether to use the file system to store metadata about the session storage or the internal database. | help |
--www-stats-monitor-seconds arg | The time interval in seconds to log info/debug messages with stats on server performance. | help |
--rsession-which-r arg | The path to the main R program (e.g. /usr/bin/R). | help |
--rsession-path arg | The relative path from the RStudio installation directory, or absolute path to the rsession executable. | help |
--rldpath-path arg | The path to the r-ldpath script which specifies extra library paths for R versions. | help |
--rsession-ld-library-path arg | Specifies additional LD_LIBRARY_PATHs to use for R sessions. | help |
--rsession-config-file arg | If set, overrides the path to the /etc/rstudio/rsession.conf configuration file. | help |
--rsession-memory-limit-mb arg | The limit in MB that an rsession process may consume. | help |
--rsession-stack-limit-mb arg | The limit in MB that an rsession process may consume for its stack. | help |
--rsession-process-limit arg | The maximum number of allowable rsession processes. | help |
--database-config-file arg | If set, overrides the path to the /etc/rstudio/database.conf configuration file. | help |
--db-command arg | Executes the shell command specified injecting the current database configuration in the command. | help |
--db-connection-timeout arg | Specifies the number of seconds to wait for making a new db connection | help |
--auth-none arg | If set, disables multi-user authentication. | help |
--auth-validate-users arg | Indicates whether or not to validate that authenticated users exist on the target system. | help |
--auth-stay-signed-in-days arg | The number of days to keep a user signed in when using the "Stay Signed In" option. | help |
--auth-timeout-minutes arg | The number of minutes a user will stay logged in while idle before required to sign in again. | help |
--auth-encrypt-password arg | Indicates whether or not to encrypt the password sent from the login form. | help |
--auth-required-user-group arg | Specifies a group that users must be in to be able to use RStudio. | help |
--auth-minimum-user-id arg | Specifies a minimum user id value. | help |
--auth-pam-requires-priv arg | Deprecated - will always be true. | help |
--auth-revocation-list-dir arg | If set, overrides the path to the directory which contains the revocation list to be used for storing expired tokens. | help |
--auth-cookies-force-secure arg | Indicates whether or not auth cookies should be forcefully marked as secure. | help |
--monitor-interval-seconds arg | The interval in seconds at which the monitor is probed for new data. | help |
--help | print help message | help |
--test-config | test to ensure the config file is valid | help |
--config-file arg | configuration file | help |