rsconnect: Deploy Docs, Apps, and APIs to 'Posit Connect', 'shinyapps.io', and 'RPubs'

Description

Programmatic deployment interface for 'RPubs', 'shinyapps.io', and 'Posit Connect'. Supported content types include R Markdown documents, Shiny applications, Plumber APIs, plots, and static web content.

Author(s)

Maintainer: Aron Atkins aron@posit.co

Authors:

• Toph Allen

• Hadley Wickham

• Jonathan McPherson

• JJ Allaire

Other contributors:

• Posit Software, PBC [copyright holder, funder]

See Also

Useful links:

• https://rstudio.github.io/rsconnect/

• https://github.com/rstudio/rsconnect

• Report bugs at https://github.com/rstudio/rsconnect/issues

Show Account Usage

Description

Show account usage

Supported servers: ShinyApps servers

Usage

accountUsage(
 account = NULL,
 server = NULL,
 usageType = "hours",
 from = NULL,
 until = NULL,
 interval = NULL
)

Arguments

Note

This function only works for ShinyApps servers.

Account Management Functions

Description

Functions to enumerate and remove accounts on the local system. Prior to deploying applications you need to register your account on the local system.

Supported servers: All servers

Usage

accounts(server = NULL)
accountInfo(name = NULL, server = NULL)
removeAccount(name = NULL, server = NULL)

Arguments

Details

You register an account using the setAccountInfo() function (for ShinyApps) or connectUser() function (for other servers). You can subsequently remove the account using the removeAccount function.

The accounts and accountInfo functions are provided for viewing previously registered accounts.

Value

accounts returns a data frame with the names of all accounts registered on the system and the servers on which they reside. accountInfo returns a list with account details.

See Also

Other Account functions: connectApiUser(), connectCloudUser(), setAccountInfo()

Add authorized user to application

Description

Add authorized user to application

Supported servers: ShinyApps servers

Usage

addAuthorizedUser(
 email,
 appDir = getwd(),
 appName = NULL,
 account = NULL,
 server = NULL,
 sendEmail = NULL,
 emailMessage = NULL
)

Arguments

Note

This function works only for ShinyApps servers.

See Also

removeAuthorizedUser() and showUsers()

Add a server

Description

This function does the same thing as addServer() so has been removed.

Usage

addConnectServer(url, name = NULL, certificate = NULL, quiet = FALSE)

Arguments

Add a Linter

Description

Add a linter, to be used in subsequent calls to lint() .

Supported servers: All servers

Add a linter, to be used in subsequent calls to lint() .

Usage

addLinter(name, linter)
addLinter(name, linter)

Arguments

Examples

addLinter("no.capitals", linter(
 ## Identify lines containing capital letters -- either by name or by index
 apply = function(content, ...) {
 grep("[A-Z]", content)
 },
 ## Only use this linter on R files (paths ending with .r or .R)
 takes = function(paths) {
 grep("[rR]$", paths)
 },
 # Use the default message constructor
 message = function(content, lines, ...) {
 makeLinterMessage("Capital letters found on the following lines", content, lines)
 },
 # Give a suggested prescription
 suggest = "Do not use capital letters in these documents."
))
addLinter("no.capitals", linter(
 ## Identify lines containing capital letters -- either by name or by index
 apply = function(content, ...) {
 grep("[A-Z]", content)
 },
 ## Only use this linter on R files (paths ending with .r or .R)
 takes = function(paths) {
 grep("[rR]$", paths)
 },
 # Use the default message constructor
 message = function(content, lines, ...) {
 makeLinterMessage("Capital letters found on the following lines", content, lines)
 },
 # Give a suggested prescription
 suggest = "Do not use capital letters in these documents."
))

Server management

Description

These functions manage the list of known servers:

• addServer() registers a Posit connect server. Once it has been registered, you can connect to an account on the server using connectUser() .

• removeServer() removes a server from the registry.

• addServerCertificate() adds a certificate to a server.

Supported servers: Posit Connect servers

Usage

addServer(
 url,
 name = NULL,
 certificate = NULL,
 validate = TRUE,
 snowflakeConnectionName = NULL,
 quiet = FALSE
)
removeServer(name = NULL)
addServerCertificate(name, certificate, quiet = FALSE)

Arguments

Examples

## Not run: 
# register a local server
addServer("http://myrsconnect/", "myserver")
# list servers
servers(local = TRUE)
# connect to an account on the server
connectUser(server = "myserver")
## End(Not run)

Detect application dependencies

Description

appDependencies() recursively detects all R package dependencies for an application by parsing all .R and .Rmd files and looking for calls to library(), require(), requireNamespace(), ::, and so on. It then adds implicit dependencies (i.e. an .Rmd requires Rmarkdown) and adds all recursive dependencies to create a complete manifest of package packages need to be installed to run the app.

Supported servers: All servers

Usage

appDependencies(
 appDir = getwd(),
 appFiles = NULL,
 appFileManifest = NULL,
 appMode = NULL
)

Arguments

Value

A data frame with one row for each dependency (direct, indirect, and inferred), and 4 columns:

• Package: package name.

• Version: local version.

• Source: a short string describing the source of the package install, as described above.

• Repository: for CRAN and CRAN-like repositories, the URL to the repository. This will be ignored by the server if it has been configured with its own repository name -> repository URL mapping.

Dependency discovery

rsconnect use one of three mechanisms to find which packages your application uses:

1. If renv.lock is present, it will use the versions and sources defined in that file. If you're using the lockfile for some other purpose and don't want it to affect deployment, add renv.lock to .rscignore.

2. Otherwise, rsconnect will call renv::snapshot() to find all packages used by your code. If you'd instead prefer to only use the packages declared in a DESCRIPTION file, run renv::settings$snapshot.type("explicit") to activate renv's "explicit" mode.

3. Dependency resolution using renv is a new feature in rsconnect 1.0.0, and while we have done our best to test it, it still might fail for your app. If this happens, please file an issue then set options(rsconnect.packrat = TRUE) to revert to the old dependency discovery mechanism.

Remote installation

When deployed, the app must first install all of these packages, and rsconnect ensures the versions used on the server will match the versions you used locally. It knows how to install packages from the following sources:

• CRAN and BioConductor (Source: CRAN or Source: Bioconductor). The remote server will ignore the specific CRAN or Bioconductor mirror that you use locally, always using the CRAN/BioC mirror that has been configured on the server.

• Other CRAN like and CRAN-like repositories. These packages will have a Source determined by the value of getOptions("repos"). For example, if you've set the following options:

  options(
   repos = c(
   CRAN = "https://cran.rstudio.com/",
   CORPORATE = "https://corporate-packages.development.company.com"
   )
  )
  

  Then packages installed from your corporate package repository will have source CORPORATE. Posit Connect can be configured to override their repository url so that (e.g.) you can use different packages versions on staging and production servers.

• Packages installed from GitHub, GitLab, or BitBucket, have Source github, gitlab, and bitbucket respectively. When deployed, the bundle contains the additional metadata needed to precisely recreated the installed version.

It's not possible to recreate the packages that you have built and installed from a directory on your local computer. This will have Source: NA and will cause the deployment to error. To resolve this issue, you'll need to install from one of the known sources described above.

Suggested packages

The Suggests field is not included when determining recursive dependencies, so it's possible that not every package required to run your application will be detected.

For example, ggplot2's geom_hex() requires the hexbin package to be installed, but it is only suggested by ggplot2. So if your app uses geom_hex() it will fail, reporting that the hexbin package is not installed.

You can overcome this problem with (e.g.) requireNamespace(hexbin). This will tell rsconnect that your app needs the hexbin package, without otherwise affecting your code.

See Also

rsconnectPackages(Using Packages with rsconnect)

Examples

## Not run: 
# dependencies for the app in the current working dir
appDependencies()
# dependencies for an app in another directory
appDependencies("~/projects/shiny/app1")
## End(Not run)

Application Configuration Directory

Description

Returns the root path used to store per user configuration data. Does not check old locations or create the path; use rsconnectConfigDir for most cases.

Usage

applicationConfigDir()

Value

A string containing the path of the configuration folder.

List Deployed Applications

Description

List all applications currently deployed for a given account.

Supported servers: All servers

Usage

applications(account = NULL, server = NULL)

Arguments

Value

Returns a data frame with the following columns:

Note

To register an account you call the setAccountInfo() function.

See Also

deployApp() , terminateApp()

Other Deployment functions: deployAPI(), deployApp(), deployDoc(), deploySite(), deployTFModel()

Examples

## Not run: 
# list all applications for the default account
applications()
# list all applications for a specific account
applications("myaccount")
# view the list of applications in the data viewer
View(applications())
## End(Not run)

(Deprecated) List authorized users for an application

Description

(Deprecated) List authorized users for an application

Usage

authorizedUsers(appDir = getwd())

Arguments

Configure an Application

Description

Configure an application running on a remote server.

Supported servers: ShinyApps servers

Usage

configureApp(
 appName,
 appDir = getwd(),
 account = NULL,
 server = NULL,
 redeploy = TRUE,
 size = NULL,
 instances = NULL,
 logLevel = c("normal", "quiet", "verbose")
)

Arguments

Note

This function works only for ShinyApps servers.

See Also

applications() , deployApp()

Examples

## Not run: 
# set instance size for an application
configureApp("myapp", size="xlarge")
## End(Not run)

Register account on Posit Connect

Description

connectUser() and connectApiUser() connect your Posit Connect account to the rsconnect package so that it can deploy and manage applications on your behalf.

connectUser() is the easiest place to start because it allows you to authenticate in-browser to your Posit Connect server. connectApiUser() is appropriate for non-interactive settings; you'll need to copy-and-paste the API key from your account settings.

Supported servers: Posit Connect servers

Usage

connectApiUser(account = NULL, server = NULL, apiKey, quiet = FALSE)
connectUser(
 account = NULL,
 server = NULL,
 quiet = FALSE,
 launch.browser = getOption("rsconnect.launch.browser", interactive())
)

Arguments

See Also

Other Account functions: accounts(), connectCloudUser(), setAccountInfo()

Register account on Posit Connect Cloud

Description

connectCloudUser() connects your Posit Connect Cloud account to the rsconnect package so that it can deploy and manage applications on your behalf. It will open a browser window to authenticate, then prompt you to create an account or select an account to use if you have multiple.

Supported servers: Posit Connect Cloud servers

Usage

connectCloudUser(launch.browser = TRUE)

Arguments

See Also

Other Account functions: accounts(), connectApiUser(), setAccountInfo()

Register account on Posit Connect in Snowpark Container Services

Description

connectSPCSUser() connects your Posit Connect account to the rsconnect package so it can deploy and manage applications on your behalf. Configure a connections.toml file in the appropriate location.

SPCS deployments require both Snowflake authentication (via the connection name) and a Posit Connect API key. The Snowflake token provides proxied authentication to reach the Connect server, while the API key identifies the user to Connect itself.

Supported servers: Posit Connect servers

Usage

connectSPCSUser(
 account = NULL,
 server = NULL,
 apiKey,
 snowflakeConnectionName,
 quiet = FALSE
)

Arguments

Deploy a Plumber API

Description

Deploys an application consisting of plumber API routes. The given directory must contain a script returning a plumb object or a plumber API definition.

Supported servers: Posit Connect and ShinyApps servers

Usage

deployAPI(api, ...)

Arguments

Details

Deploy a plumber API definition by either supplying a directory containing plumber.R (an API definition) or entrypoint.R that returns a plumb object created by plumber::plumb(). See the plumber documentation for more information. Alternatively, deploy a plumber2 API by supplying a directory containing ⁠_server.yml⁠.

See Also

Other Deployment functions: applications(), deployApp(), deployDoc(), deploySite(), deployTFModel()

Deploy an Application

Description

Deploy a shiny application, an RMarkdown document, a plumber API, or HTML content to a server.

Supported servers: All servers

Usage

deployApp(
 appDir = getwd(),
 appFiles = NULL,
 appFileManifest = NULL,
 appPrimaryDoc = NULL,
 appSourceDoc = NULL,
 appName = NULL,
 appTitle = NULL,
 envVars = NULL,
 appId = NULL,
 appMode = NULL,
 contentCategory = NULL,
 account = NULL,
 server = NULL,
 upload = TRUE,
 recordDir = NULL,
 launch.browser = getOption("rsconnect.launch.browser", is_interactive()),
 on.failure = NULL,
 logLevel = c("normal", "quiet", "verbose"),
 lint = TRUE,
 metadata = list(),
 forceUpdate = NULL,
 python = NULL,
 forceGeneratePythonEnvironment = FALSE,
 quarto = NA,
 appVisibility = NULL,
 image = NULL,
 envManagement = NULL,
 envManagementR = NULL,
 envManagementPy = NULL
)

Arguments

Details

Deployment records

When deploying an app, deployApp() will save a deployment record that makes it easy to update the app on server from your local source code. This generally means that you need to only need to supply important arguments (e.g. appName, appTitle, server/account) on the first deploy, and rsconnect will reuse the same settings on subsequent deploys.

The metadata needs to make this work is stored in ⁠{appDir}/rsconnect/⁠. You should generally check these files into version control to ensure that future you and other collaborators will publish to the same location.

If you have lost this directory, all is not lost, as deployApp() will attempt to rediscover existing deployments. This is easiest if you are updating an app that you created, as you can just supply the appName (and server/account if you have multiple accounts) and deployApp() will find the existing application account. If you need to update an app that was created by someone else (that you have write permission) for, you'll instead need to supply the appId.

See Also

applications() , terminateApp() , and restartApp()

Other Deployment functions: applications(), deployAPI(), deployDoc(), deploySite(), deployTFModel()

Examples

## Not run: 
# deploy the application in the current working dir
deployApp()
# deploy an application in another directory
deployApp("~/projects/shiny/app1")
# deploy using an alternative application name and title
deployApp("~/projects/shiny/app1", appName = "myapp",
 appTitle = "My Application")
# deploy specifying an explicit account name, then
# redeploy with no arguments (will automatically use
# the previously specified account)
deployApp(account = "jsmith")
deployApp()
# deploy but don't launch a browser when completed
deployApp(launch.browser = FALSE)
# deploy a Quarto website, using the quarto package to
# find the Quarto binary
deployApp("~/projects/quarto/site1")
# deploy application with environment variables
# (e.g., `SECRET_PASSWORD=XYZ` is set via an ~/.Renviron file)
rsconnect::deployApp(envVars = c("SECRET_PASSWORD"))
## End(Not run)

Deploy a single document

Description

Deploys a single R Markdown, Quarto document, or other file (e.g. .html or .pdf).

When deploying an .Rmd, .Qmd, or .html, deployDoc() will attempt to automatically discover dependencies using rmarkdown::find_external_resources() , and include an .Rprofile if present. If you find that the document is missing dependencies, either specify the dependencies explicitly in the document (see rmarkdown::find_external_resources() for details), or call deployApp() directly and specify your own file list in appFiles.

Supported servers: All servers

Usage

deployDoc(doc, ..., logLevel = c("normal", "quiet", "verbose"))

Arguments

See Also

Other Deployment functions: applications(), deployAPI(), deployApp(), deploySite(), deployTFModel()

Examples

## Not run: 
deployDoc("my-report.Rmd")
deployDoc("static-file.html")
## End(Not run)

Deploy a website

Description

Deploy an R Markdown or quarto website to a server.

Supported servers: Posit Connect, Posit Connect Cloud and ShinyApps servers

Usage

deploySite(
 siteDir = getwd(),
 siteName = NULL,
 siteTitle = NULL,
 account = NULL,
 server = NULL,
 render = c("none", "local", "server"),
 launch.browser = getOption("rsconnect.launch.browser", interactive()),
 logLevel = c("normal", "quiet", "verbose"),
 lint = FALSE,
 metadata = list(),
 python = NULL,
 recordDir = NULL,
 ...
)

Arguments

See Also

Other Deployment functions: applications(), deployAPI(), deployApp(), deployDoc(), deployTFModel()

Deploy a TensorFlow saved model

Description

Deploys a directory containing a TensorFlow saved model.

Supported servers: Posit Connect and ShinyApps servers

Usage

deployTFModel(...)

Arguments

See Also

Other Deployment functions: applications(), deployAPI(), deployApp(), deployDoc(), deploySite()

List Application Deployments

Description

List deployment records for a given application.

Supported servers: All servers

Usage

deployments(
 appPath = ".",
 nameFilter = NULL,
 accountFilter = NULL,
 serverFilter = NULL,
 excludeOrphaned = TRUE
)

Arguments

Value

Returns a data frame with at least following columns:

If additional metadata has been saved with the deployment record using the metadata argument to deployApp() , the frame will include additional columns.

See Also

applications() to get a list of deployments from the server, and deployApp() to create a new deployment.

Examples

## Not run: 
# Return all deployments of the ~/r/myapp directory made with the 'abc'
# account
deployments("~/r/myapp", accountFilter="abc")
## End(Not run)

Discover servers automatically

Description

This function has never worked usefully, so has been removed.

Usage

discoverServers(quiet = FALSE)

Forget Application Deployment

Description

Forgets about an application deployment. This is useful if the application has been deleted on the server, or the local deployment information needs to be reset.

Supported servers: All servers

Usage

forgetDeployment(
 appPath = getwd(),
 name = NULL,
 account = NULL,
 server = NULL,
 dryRun = FALSE,
 force = !interactive()
)

Arguments

Details

This method removes from disk the file containing deployment metadata. If "name", "account", and "server" are all NULL, then all of the deployments for the application are forgotten; otherwise, only the specified deployment is forgotten.

Value

NULL, invisibly.

Generate Application Name

Description

Generate a short name (identifier) for an application given an application title.

Usage

generateAppName(appTitle, appPath = NULL, account = NULL, unique = TRUE)

Arguments

Details

This function modifies the title until it forms a suitable application name. Suitable application names are 3 - 64 characters long and contain only alphanumeric characters.

The function is intended to be used to find a name for a new application. If appPath and account are both specified, then the returned name will also be unique among locally known deployments of the directory (note that it is not guaranteed to be unique on the server). This behavior can be disabled by setting unique = FALSE.

Value

Returns a valid short name for the application.

Examples

## Not run: 
# Generate a short name for a sample application
generateAppName("My Father's Country", "~/fathers-country", "myacct")
## End(Not run)

Lint a Project

Description

Takes the set of active linters (see addLinter() ), and applies them to all files within a project.

Supported servers: All servers

Usage

lint(project, files = NULL, appPrimaryDoc = NULL)

Arguments

Create a Linter

Description

Generate a linter, which can identify errors or problematic regions in a project.

Supported servers: All servers

Generate a linter, which can identify errors or problematic regions in a project.

Usage

linter(apply, takes, message, suggestion)
linter(apply, takes, message, suggestion)

Arguments

Examples

addLinter("no.capitals", linter(
 ## Identify lines containing capital letters -- either by name or by index
 apply = function(content, ...) {
 grep("[A-Z]", content)
 },
 ## Only use this linter on R files (paths ending with .r or .R)
 takes = function(paths) {
 grep("[rR]$", paths)
 },
 # Use the default message constructor
 message = function(content, lines, ...) {
 makeLinterMessage("Capital letters found on the following lines", content, lines)
 },
 # Give a suggested prescription
 suggest = "Do not use capital letters in these documents."
))
addLinter("no.capitals", linter(
 ## Identify lines containing capital letters -- either by name or by index
 apply = function(content, ...) {
 grep("[A-Z]", content)
 },
 ## Only use this linter on R files (paths ending with .r or .R)
 takes = function(paths) {
 grep("[rR]$", paths)
 },
 # Use the default message constructor
 message = function(content, lines, ...) {
 makeLinterMessage("Capital letters found on the following lines", content, lines)
 },
 # Give a suggested prescription
 suggest = "Do not use capital letters in these documents."
))

Maintain environment variables across multiple applications

Description

• listAccountEnvVars() lists the environment variables used by every application published to the specified account.

• updateAccountEnvVars() updates the specified environment variables with their current values for every app that uses them.

Secure environment variable are currently only supported by Posit Connect so other server types will generate an error.

Supported servers: Posit Connect servers

Usage

listAccountEnvVars(server = NULL, account = NULL)
updateAccountEnvVars(envVars, server = NULL, account = NULL)

Arguments

Value

listAccountEnvVars() returns a data frame with one row for each data frame. It has variables id, guid, name, and envVars. envVars is a list-column.

List Files to be Bundled

Description

listBundleFiles() has been superseded in favour of listDeploymentFiles() .

Given a directory containing an application, returns the names of the files that by default will be bundled in the application. It works similarly to a recursive directory listing from list.files() but enforces bundle sizes as described in listDeploymentFiles()

Usage

listBundleFiles(appDir)

Arguments

Value

Returns a list containing the following elements:

• totalFiles: Total number of files.

• totalSize: Total size of the files (in bytes).

• contents: Paths to bundle, relative to appDir.

Gather files to be bundled with an app

Description

Given an app directory, and optional appFiles and appFileManifest arguments, returns vector of paths to bundle in the app. (Note that documents follow a different strategy; see deployDoc() for details.)

When neither appFiles nor appFileManifest is supplied, listDeploymentFiles() will include all files under appDir, apart from the following:

• Certain files and folders that don't need to be bundled, such as version control directories, internal config files, and RStudio state, are automatically excluded.

• You can exclude additional files by listing them in in a .rscignore file. This file must have one file or directory per line (with path relative to the current directory). It doesn't support wildcards, or ignoring files in subdirectories.

listDeploymentFiles() will throw an error if the total file size exceeds the maximum bundle size (as controlled by option rsconnect.max.bundle.size), or the number of files exceeds the maximum file limit (as controlled by option rsconnect.max.bundle.files). This prevents you from accidentally bundling a very large direcfory (i.e. you home directory).

Supported servers: All servers

Usage

listDeploymentFiles(
 appDir,
 appFiles = NULL,
 appFileManifest = NULL,
 error_call = caller_env()
)

Arguments

Value

Character of paths to bundle, relative to appDir.

Construct a Linter Message

Description

Pretty-prints a linter message. Primarily used as a helper for constructing linter messages with linter() .

Supported servers: All servers

Usage

makeLinterMessage(header, content, lines)

Arguments

Old Application Config Directory

Description

Returns the old application configuration directory used by rsconnect 0.8.24 and prior. These versions wrote configuration data to XDG compliant locations, but CRAN policy has since further restricted the disk locations that are permitted. See:

Usage

oldApplicationConfigDir(appName)

Arguments

Details

https://cran.r-project.org/web/packages/policies.html

Value

The old application configuration directory.

Purge an Application

Description

Purge a currently archived ShinyApps application.

Supported servers: ShinyApps servers

Usage

purgeApp(appName, account = NULL, server = NULL, quiet = FALSE)

Arguments

Note

This function only works for ShinyApps servers.

See Also

applications() , deployApp() , and restartApp()

Examples

## Not run: 
# purge an application
purgeApp("myapp")
## End(Not run)

Remove authorized user from an application

Description

Remove authorized user from an application

Supported servers: ShinyApps servers

Usage

removeAuthorizedUser(
 user,
 appDir = getwd(),
 appName = NULL,
 account = NULL,
 server = NULL
)

Arguments

Note

This function works only for ShinyApps servers.

See Also

addAuthorizedUser() and showUsers()

Resend invitation for invited users of an application

Description

Resend invitation for invited users of an application

Supported servers: ShinyApps servers

Usage

resendInvitation(
 invite,
 regenerate = FALSE,
 appDir = getwd(),
 appName = NULL,
 account = NULL,
 server = NULL
)

Arguments

Note

This function works only for ShinyApps servers.

See Also

showInvited()

Restart an Application

Description

Restart an application currently running on a remote server.

Supported servers: ShinyApps servers

Usage

restartApp(appName, account = NULL, server = NULL, quiet = FALSE)

Arguments

Note

This function works only for ShinyApps servers.

See Also

applications() , deployApp() , and terminateApp()

Examples

## Not run: 
# restart an application
restartApp("myapp")
## End(Not run)

Upload a file to RPubs

Description

This function publishes a file to rpubs.com. If the upload succeeds a list that includes an id and continueUrl is returned. A browser should be opened to the continueUrl to complete publishing of the document. If an error occurs then a diagnostic message is returned in the error element of the list.

Supported servers: RPubs servers

Usage

rpubsUpload(title, contentFile, originalDoc, id = NULL, properties = list())

Arguments

Value

A named list. If the upload was successful then the list contains a id element that can be used to subsequently update the document as well as a continueUrl element that provides a URL that a browser should be opened to in order to complete publishing of the document. If the upload fails then the list contains an error element which contains an explanation of the error that occurred.

Examples

## Not run: 
# upload a document
result <- rpubsUpload("My document title", "Document.html")
if (!is.null(result$continueUrl))
 browseURL(result$continueUrl)
else
 stop(result$error)
# update the same document with a new title
updateResult <- rpubsUpload("My updated title", "Document.html",
 id = result$id)
## End(Not run)

rsconnect Configuration Directory

Description

Forms the path to a location on disk where user-level configuration data for the package is stored.

Usage

rsconnectConfigDir(subDir = NULL)

Arguments

Value

The path to the configuration directory.

Package Options

Description

The rsconnect package supports several options that control the method used for http communications, the printing of diagnostic information for http requests, and the launching of an external browser after deployment.

Details

Supported global options include:

rsconnect.ca.bundle

Path to a custom bundle of Certificate Authority root certificates to use when connecting to servers via SSL. This option can also be specied in the environment variable RSCONNECT_CA_BUNDLE. Leave undefined to use your system's default certificate store.

rsconnect.check.certificate

Whether to check the SSL certificate when connecting to a remote host; defaults to TRUE. Setting to FALSE is insecure, but will allow you to connect to hosts using invalid certificates as a last resort.

rsconnect.http

Http implementation used for connections to the back-end service:

libcurl Secure https using the curl R package

rcurl Secure https using the Rcurl R package (deprecated)

curl Secure https using the curl system utility

internal Insecure http using raw sockets

If no option is specified then libcurl is used by default.

rsconnect.http.trace

When TRUE, trace http calls (prints the method, path, and total milliseconds for each http request)

rsconnect.http.trace.json

When TRUE, trace JSON content (shows JSON payloads sent to and received from the server))

rsconnect.http.verbose

When TRUE, print verbose output for http connections (useful only for debugging SSL certificate or http connection problems)

rsconnect.tar

By default, rsconnect uses R's internal tar implementation to compress content bundles. This may cause invalid bundles in some environments. In those cases, use this option to specify a path to an alternate tar executable. This option can also be specified in the environment variable RSCONNECT_TAR. Leave undefined to use the default tar implementation.

rsconnect.rcurl.options

A named list of additional cURL options to use when using the RCurl HTTP implementation in R. Run RCurl::curlOptions() to see available options.

rsconnect.libcurl.options

A named list of additional cURL options to use when using the curl HTTP implementation in R. Run curl::curl_options() to see available options.

rsconnect.error.trace

When TRUE, print detailed stack traces for errors occurring during deployment.

rsconnect.launch.browser

When TRUE, automatically launch a browser to view applications after they are deployed

rsconnect.locale.cache

When FALSE, disable the detected locale cache (Windows only).

rsconnect.locale

Override the detected locale.

rsconnect.max.bundle.size

The maximum size, in bytes, for deployed content. If not set, defaults to 3 GB.

rsconnect.max.bundle.files

The maximum number of files to deploy. If not set, defaults to 10,000.

rsconnect.force.update.apps

When TRUE, bypasses the prompt to confirm whether you wish to update previously-deployed content

rsconnect.pre.deploy

A function to run prior to deploying content; it receives as an argument the directory containing the content about to be deployed.

rsconnect.post.deploy

A function to run after successfully deploying content; it receives as an argument the directory containing the content about to be deployed.

rsconnect.python.enabled

When TRUE, use the python executable specified by the RETICULATE_PYTHON environment variable and add a python section to the deployment manifest. By default, python is enabled when deploying to Posit Connect and disabled when deploying to shinyapps.io.

When deploying content from the RStudio IDE, the rsconnect package's deployment methods are executed in a vanilla R session that doesn't execute startup scripts. This can make it challenging to ensure options are set properly prior to push-button deployment, so the rsconnect package has a parallel set of “startup” scripts it runs prior to deploying. The follow are run in order, if they exist, prior to deployment:

$R_HOME/etc/rsconnect.site

Like Rprofile.site; for site-wide pre-flight and options.

~/.rsconnect_profile

Like .Rprofile; for user-specific content.

$PROJECT/.rsconnect_profile

Like .Rprofile for projects; $PROJECT here refers to the root directory of the content being deployed.

Note that, unlike .Rprofile, these files don't replace each other; all three will be run if they exist.

Examples

## Not run: 
# use curl for http connections
options(rsconnect.http = "curl")
# trace http requests
options(rsconnect.http.trace = TRUE)
# print verbose output for http requests
options(rsconnect.http.verbose = TRUE)
# print JSON content
options(rsconnect.http.trace.json = TRUE)
# don't automatically launch a browser after deployment
options(rsconnect.launch.browser = FALSE)
## End(Not run)

Using Packages with rsconnect

Description

See ?appDependencies()

HTTP Proxy Configuration

Description

Please see vignette("custom-http").

Server metadata

Description

servers() lists all known servers; serverInfo() gets metadata about a specific server. Cloud server shinyapps.io is always automatically registered and available.

Supported servers: All servers

Usage

servers(local = FALSE)
serverInfo(name = NULL)

Arguments

Value

servers() returns a data frame with registered server names and URLs. serverInfo() returns a list with details for a particular server.

Examples

# List all registered servers
servers()
# Get information about a server
serverInfo("shinyapps.io")

Register account on shinyapps.io

Description

Configure a ShinyApps account for publishing from this system.

Supported servers: ShinyApps servers

Usage

setAccountInfo(name, token, secret, server = "shinyapps.io")

Arguments

See Also

Other Account functions: accounts(), connectApiUser(), connectCloudUser()

Examples

## Not run: 
# register an account
setAccountInfo("user", "token", "secret")
# remove the same account
removeAccount("user")
## End(Not run)

Set Application property

Description

Set a property on currently deployed ShinyApps application.

Supported servers: ShinyApps servers

Usage

setProperty(
 propertyName,
 propertyValue,
 appPath = getwd(),
 appName = NULL,
 account = NULL,
 server = NULL,
 force = FALSE
)

Arguments

Note

This function only works for ShinyApps servers.

Examples

## Not run: 
# set instance size for an application
setProperty("application.instances.count", 1)
# disable application package cache
setProperty("application.package.cache", FALSE)
## End(Not run)

List invited users for an application

Description

List invited users for an application

Supported servers: ShinyApps servers

Usage

showInvited(appDir = getwd(), appName = NULL, account = NULL, server = NULL)

Arguments

Note

This function works only for ShinyApps servers.

See Also

addAuthorizedUser() and showUsers()

Application Logs

Description

These functions provide access to the logs for deployed ShinyApps applications:

• showLogs() displays the logs.

• getLogs() returns the logged lines.

Supported servers: ShinyApps servers

Usage

showLogs(
 appPath = getwd(),
 appFile = NULL,
 appName = NULL,
 account = NULL,
 server = NULL,
 entries = 50,
 streaming = FALSE
)
getLogs(
 appPath = getwd(),
 appFile = NULL,
 appName = NULL,
 account = NULL,
 server = NULL,
 entries = 50
)

Arguments

Value

getLogs() returns a data frame containing the logged lines.

Note

These functions only use the libcurl transport, and only work for applications deployed to ShinyApps.io.

Show Application Metrics

Description

Show application metrics of a currently deployed application.

Supported servers: ShinyApps servers

Usage

showMetrics(
 metricSeries,
 metricNames,
 appDir = getwd(),
 appName = NULL,
 account = NULL,
 server = "shinyapps.io",
 from = NULL,
 until = NULL,
 interval = NULL
)

Arguments

Show Application property

Description

Show properties of an application deployed to ShinyApps.

Supported servers: ShinyApps servers

Usage

showProperties(
 appPath = getwd(),
 appName = NULL,
 account = NULL,
 server = NULL
)

Arguments

Note

This function works only for ShinyApps servers.

Show Application Usage

Description

Show application usage of a currently deployed application

Supported servers: ShinyApps servers

Usage

showUsage(
 appDir = getwd(),
 appName = NULL,
 account = NULL,
 server = NULL,
 usageType = "hours",
 from = NULL,
 until = NULL,
 interval = NULL
)

Arguments

Note

This function only works for ShinyApps servers.

List authorized users for an application

Description

List authorized users for an application

Supported servers: ShinyApps servers

Usage

showUsers(appDir = getwd(), appName = NULL, account = NULL, server = NULL)

Arguments

Note

This function works only for ShinyApps servers.

See Also

addAuthorizedUser() and showInvited()

Update deployment records

Description

Update the deployment records for applications published to Posit Connect. This updates application title and URL, and deletes records for deployments where the application has been deleted on the server.

Supported servers: Posit Connect servers

Usage

syncAppMetadata(appPath = ".")

Arguments

Show task log

Description

Writes the task log for the given task

Supported servers: ShinyApps servers

Usage

taskLog(taskId, account = NULL, server = NULL, output = NULL)

Arguments

Note

This function works only with shinyapps.io.

See Also

tasks()

Examples

## Not run: 
# write task log to stdout
taskLog(12345)
# write task log to stderr
taskLog(12345, output="stderr")
## End(Not run)

List Tasks

Description

List Tasks

Supported servers: ShinyApps servers

Usage

tasks(account = NULL, server = NULL)

Arguments

Value

Returns a data frame with the following columns:

Note

This function works only with shinyapps.io.

See Also

taskLog()

Examples

## Not run: 
# list tasks for the default account
tasks()
## End(Not run)

Terminate an Application

Description

Terminate and archive a currently deployed ShinyApps application.

Supported servers: ShinyApps servers

Usage

terminateApp(appName, account = NULL, server = NULL, quiet = FALSE)

Arguments

Note

This function only works for ShinyApps servers.

See Also

applications() , deployApp() , and restartApp()

Examples

## Not run: 
# terminate an application
terminateApp("myapp")
## End(Not run)

Unset Application property

Description

Unset a property on currently deployed ShinyApps application (restoring to its default value)

Supported servers: ShinyApps servers

Usage

unsetProperty(
 propertyName,
 appPath = getwd(),
 appName = NULL,
 account = NULL,
 server = NULL,
 force = FALSE
)

Arguments

Note

This function only works for ShinyApps servers.

Examples

## Not run: 
# unset application package cache property to revert to default
unsetProperty("application.package.cache")
## End(Not run)

Create a manifest.json

Description

Use writeManifest() to generate a manifest.json. Among other things, you can commit this file to git to activate Git-Backed content for Posit Connect.

manifest.json contains a list of all files in the app along with their dependencies, so you will need to re-run writeManifest() when either of these change.

Supported servers: All servers

Usage

writeManifest(
 appDir = getwd(),
 appFiles = NULL,
 appFileManifest = NULL,
 appPrimaryDoc = NULL,
 appMode = NULL,
 contentCategory = NULL,
 python = NULL,
 forceGeneratePythonEnvironment = FALSE,
 quarto = NA,
 image = NULL,
 envManagement = NULL,
 envManagementR = NULL,
 envManagementPy = NULL,
 verbose = FALSE,
 quiet = FALSE
)

Arguments