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,136

Version

1.3.4

License

GPL-2

Issues

Pull Requests

Stars

Forks

Maintainer

Aron Atkins

Last Published

January 22nd, 2025

Functions in rsconnect (1.3.4)

forgetDeployment

Forget Application Deployment
configureApp

Configure an Application
deploySite

Deploy a website
deployTFModel

Deploy a TensorFlow saved model
connectApiUser

Register account on Posit Connect
listBundleFiles

List Files to be Bundled
makeLinterMessage

Construct a Linter Message
oldApplicationConfigDir

Old Application Config Directory
rpubsUpload

Upload a file to RPubs
rsconnectOptions

Package Options
restartApp

Restart an Application
purgeApp

Purge an Application
deployApp

Deploy an Application
lint

Lint a Project
removeAuthorizedUser

Remove authorized user from an application
rsconnect-package

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

Show Application Metrics
resendInvitation

Resend invitation for invited users of an application
listDeploymentFiles

Gather files to be bundled with an app
showLogs

Show Application Logs
showUsers

List authorized users for an application
rsconnectConfigDir

rsconnect Configuration Directory
generateAppName

Generate Application Name
syncAppMetadata

Update deployment records
listAccountEnvVars

Maintain environment variables across multiple applications
linter

Create a Linter
rsconnectProxies

HTTP Proxy Configuration
rsconnectPackages

Using Packages with rsconnect
showProperties

Show Application property
showUsage

Show Application Usage
setProperty

Set Application property
writeManifest

Create a manifest.json
showInvited

List invited users for an application
unsetProperty

Unset Application property
terminateApp

Terminate an Application
setAccountInfo

Register account on shinyapps.io or posit.cloud
tasks

List Tasks
taskLog

Show task log
servers

Server metadata
applicationConfigDir

Application Configuration Directory
appDependencies

Detect application dependencies
addAuthorizedUser

Add authorized user to application
addLinter

Add a Linter
addServer

Server management
authorizedUsers

(Deprecated) List authorized users for an application
applications

List Deployed Applications
deployDoc

Deploy a single document
deployAPI

Deploy a Plumber API
accountUsage

Show Account Usage
accounts

Account Management Functions
addConnectServer

Add a server
discoverServers

Discover servers automatically
deployments

List Application Deployments