diff --git a/R/dash.R b/R/dash.R index c9d32aec..9c86c5a0 100644 --- a/R/dash.R +++ b/R/dash.R @@ -114,12 +114,12 @@ #' present a warning and return `NULL` if the Dash app was not loaded via `source()` #' if the `DASH_APP_PATH` environment variable is undefined. #' } -#' \item{`run_server(host = Sys.getenv('DASH_HOST', "127.0.0.1"), -#' port = Sys.getenv('DASH_PORT', 8050), block = TRUE, showcase = FALSE, ...)`}{ +#' \item{`run_server(host = Sys.getenv('HOST', "127.0.0.1"), +#' port = Sys.getenv('PORT', 8050), block = TRUE, showcase = FALSE, ...)`}{ #' The `run_server` method has 13 formal arguments, several of which are optional: #' \describe{ -#' \item{host}{Character. A string specifying a valid IPv4 address for the Fiery server, or `0.0.0.0` to listen on all addresses. Default is `127.0.0.1` Environment variable: `DASH_HOST`.} -#' \item{port}{Integer. Specifies the port number on which the server should listen (default is `8050`). Environment variable: `DASH_PORT`.} +#' \item{host}{Character. A string specifying a valid IPv4 address for the Fiery server, or `0.0.0.0` to listen on all addresses. Default is `127.0.0.1` Environment variable: `HOST`.} +#' \item{port}{Integer. Specifies the port number on which the server should listen (default is `8050`). Environment variable: `PORT`.} #' \item{block}{Logical. Start the server while blocking console input? Default is `TRUE`.} #' \item{showcase}{Logical. Load the Dash application into the default web browser when server starts? Default is `FALSE`.} #' \item{use_viewer}{Logical. Load the Dash application into RStudio's viewer pane? Requires that `host` is either `127.0.0.1` or `localhost`, and that Dash application is started within RStudio; if `use_viewer = TRUE` and these conditions are not satsified, the user is warned and the app opens in the default browser instead. Default is `FALSE`.} @@ -766,8 +766,8 @@ Dash <- R6::R6Class( # ------------------------------------------------------------------------ # convenient fiery wrappers # ------------------------------------------------------------------------ - run_server = function(host = Sys.getenv('DASH_HOST', "127.0.0.1"), - port = Sys.getenv('DASH_PORT', 8050), + run_server = function(host = Sys.getenv('HOST', "127.0.0.1"), + port = Sys.getenv('PORT', 8050), block = TRUE, showcase = FALSE, use_viewer = FALSE, diff --git a/man/Dash.Rd b/man/Dash.Rd index a93a5191..0e2e9a00 100644 --- a/man/Dash.Rd +++ b/man/Dash.Rd @@ -128,11 +128,11 @@ but this is configurable via the \code{prefix} parameter. Note: this method will present a warning and return \code{NULL} if the Dash app was not loaded via \code{source()} if the \code{DASH_APP_PATH} environment variable is undefined. } -\item{\code{run_server(host = Sys.getenv('DASH_HOST', "127.0.0.1"), port = Sys.getenv('DASH_PORT', 8050), block = TRUE, showcase = FALSE, ...)}}{ +\item{\code{run_server(host = Sys.getenv('HOST', "127.0.0.1"), port = Sys.getenv('PORT', 8050), block = TRUE, showcase = FALSE, ...)}}{ The \code{run_server} method has 13 formal arguments, several of which are optional: \describe{ -\item{host}{Character. A string specifying a valid IPv4 address for the Fiery server, or \code{0.0.0.0} to listen on all addresses. Default is \code{127.0.0.1} Environment variable: \code{DASH_HOST}.} -\item{port}{Integer. Specifies the port number on which the server should listen (default is \code{8050}). Environment variable: \code{DASH_PORT}.} +\item{host}{Character. A string specifying a valid IPv4 address for the Fiery server, or \code{0.0.0.0} to listen on all addresses. Default is \code{127.0.0.1} Environment variable: \code{HOST}.} +\item{port}{Integer. Specifies the port number on which the server should listen (default is \code{8050}). Environment variable: \code{PORT}.} \item{block}{Logical. Start the server while blocking console input? Default is \code{TRUE}.} \item{showcase}{Logical. Load the Dash application into the default web browser when server starts? Default is \code{FALSE}.} \item{use_viewer}{Logical. Load the Dash application into RStudio's viewer pane? Requires that \code{host} is either \code{127.0.0.1} or \code{localhost}, and that Dash application is started within RStudio; if \code{use_viewer = TRUE} and these conditions are not satsified, the user is warned and the app opens in the default browser instead. Default is \code{FALSE}.}