Learn R Programming

rsconnect

rsconnect makes it easy to publish your Shiny apps, RMarkdown and Quarto documents, and Plumber APIs to Posit Connect, ShinyApps.io, and Posit Cloud from R.

(If you’re looking for the Python equivalent, try rsconnect-python.)

Installation

You can install the released version of rsconnect from CRAN with:

install.packages("rsconnect")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("rstudio/rsconnect")

Setup

To use rsconnect, you first need to teach it about the server you want to publish to. If you use the RStudio IDE, the easiest way to get set up is to use the publishing dialog, which you can find by clicking the “Tools” menu, then selecting “Global options”, then clicking “Publishing”. Click “Connect” to add new servers.

You can also connect from any R session by running a little code:

  • For shinyapps.io, go to your tokens page and click “Add Token”, then follow the instructions to copy and paste the appropriate call to setAccountInfo(). Learn more in the Getting Started Guide.

  • For Posit Connect, first use addServer() to register your server with rsconnect, then call either connectUser() or connectApiUser(). connectUser() is a bit simpler if you’re in an interactive session; connectApiUser() works anywhere but requires a you to copy and paste an API key from your user profile.

  • For Posit Cloud, login, then click your name in the top-right corner, click “Account”, then click “Tokens” in the navbar at the top of the page. Click “New Token”, then “Copy” next to the token you just created, and then follow the instructions to copy and paste the appropriate call to setAccountInfo().

Now that you’re setup you can use deployApp(), deployDoc(), and friends to publish your apps, documentations, APIs and more.

Copy Link

Version

Install

install.packages('rsconnect')

Monthly Downloads

49,688

Version

1.3.0

License

GPL-2

Issues

Pull Requests

Stars

Forks

Maintainer

Last Published

May 24th, 2024

Functions in rsconnect (1.3.0)

generateAppName

Generate Application Name
applications

List Deployed Applications
connectApiUser

Register account on Posit Connect
restartApp

Restart an Application
setProperty

Set Application property
showInvited

List invited users for an application
setAccountInfo

Register account on shinyapps.io or posit.cloud
taskLog

Show task log
tasks

List Tasks
servers

Server metadata
listDeploymentFiles

Gather files to be bundled with an app
listBundleFiles

List Files to be Bundled
terminateApp

Terminate an Application
unsetProperty

Unset Application property
rpubsUpload

Upload a file to RPubs
lint

Lint a Project
rsconnectProxies

HTTP Proxy Configuration
showLogs

Show Application Logs
showMetrics

Show Application Metrics
rsconnectPackages

Using Packages with rsconnect
addAuthorizedUser

Add authorized user to application
addConnectServer

Add a server
authorizedUsers

(Deprecated) List authorized users for an application
makeLinterMessage

Construct a Linter Message
oldApplicationConfigDir

Old Application Config Directory
showUsers

List authorized users for an application
linter

Create a Linter
rsconnect-package

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

Deploy a TensorFlow saved model
deployments

List Application Deployments
rsconnectConfigDir

rsconnect Configuration Directory
writeManifest

Create a manifest.json
removeAuthorizedUser

Remove authorized user from an application
listAccountEnvVars

Maintain environment variables across multiple applications
showUsage

Show Application Usage
showProperties

Show Application property
resendInvitation

Resend invitation for invited users of an application
syncAppMetadata

Update deployment records
accounts

Account Management Functions
addLinter

Add a Linter
accountUsage

Show Account Usage
addServer

Server management
appDependencies

Detect application dependencies
applicationConfigDir

Application Configuration Directory
deployAPI

Deploy a Plumber API
deployDoc

Deploy a single document
deploySite

Deploy a website
configureApp

Configure an Application
forgetDeployment

Forget Application Deployment
discoverServers

Discover servers automatically
deployApp

Deploy an Application
rsconnectOptions

Package Options
purgeApp

Purge an Application