1% Generated by roxygen2: do not edit by hand 2% Please edit documentation in R/deployApp.R 3\name{deployApp} 4\alias{deployApp} 5\title{Deploy an Application} 6\usage{ 7deployApp(appDir = getwd(), appFiles = NULL, appFileManifest = NULL, 8 appPrimaryDoc = NULL, appSourceDoc = NULL, appName = NULL, 9 appTitle = NULL, appId = NULL, contentCategory = NULL, account = NULL, 10 server = NULL, upload = TRUE, 11 launch.browser = getOption("rsconnect.launch.browser", interactive()), 12 logLevel = c("normal", "quiet", "verbose"), lint = TRUE, 13 metadata = list()) 14} 15\arguments{ 16\item{appDir}{Directory containing application. Defaults to current working 17directory.} 18 19\item{appFiles}{The files and directories to bundle and deploy (only if 20\code{upload = TRUE}). Can be \code{NULL}, in which case all the files in 21the directory containing the application are bundled. Takes precedence over 22\code{appFileManifest} if both are supplied.} 23 24\item{appFileManifest}{An alternate way to specify the files to be deployed; 25a file containing the names of the files, one per line, relative to the 26\code{appDir}.} 27 28\item{appPrimaryDoc}{If the application contains more than one document, this 29parameter indicates the primary one, as a path relative to \code{appDir}. 30Can be \code{NULL}, in which case the primary document is inferred from the 31contents being deployed.} 32 33\item{appSourceDoc}{If the application is composed of static files (e.g 34HTML), this parameter indicates the source document, if any, as a fully 35qualified path. Deployment information returned by 36\code{\link{deployments}} is associated with the source document.} 37 38\item{appName}{Name of application (names must be unique within an 39account). Defaults to the base name of the specified \code{appDir}.} 40 41\item{appTitle}{Free-form descriptive title of application. Optional; if 42supplied, will often be displayed in favor of the name. When deploying a 43new application, you may supply only the \code{appTitle} to receive an 44auto-generated \code{appName}.} 45 46\item{appId}{If updating an application, the ID of the application being 47updated. Optional unless updating an app owned by another user.} 48 49\item{contentCategory}{Optional; the kind of content being deployed (e.g. 50\code{"plot"}, \code{"document"}, or \code{"application"}).} 51 52\item{account}{Account to deploy application to. This 53parameter is only required for the initial deployment of an application 54when there are multiple accounts configured on the system (see 55\link{accounts}).} 56 57\item{server}{Server name. Required only if you use the same account name on 58multiple servers.} 59 60\item{upload}{If \code{TRUE} (the default) then the application is uploaded 61from the local system prior to deployment. If \code{FALSE} then it is 62re-deployed using the last version that was uploaded.} 63 64\item{launch.browser}{If true, the system's default web browser will be 65launched automatically after the app is started. Defaults to \code{TRUE} in 66interactive sessions only.} 67 68\item{logLevel}{One of \code{"quiet"}, \code{"normal"} or \code{"verbose"}; 69indicates how much logging to the console is to be performed. At 70\code{"quiet"} reports no information; at \code{"verbose"}, a full 71diagnostic log is captured.} 72 73\item{lint}{Lint the project before initiating deployment, to identify 74potentially problematic code?} 75 76\item{metadata}{Additional metadata fields to save with the deployment 77record. These fields will be returned on subsequent calls to 78\code{\link{deployments}}.} 79} 80\description{ 81Deploy a \link[shiny:shiny-package]{shiny} application, an R Markdown 82document, a plumber API, or HTML content to a server. 83} 84\examples{ 85\dontrun{ 86 87# deploy the application in the current working dir 88deployApp() 89 90# deploy an application in another directory 91deployApp("~/projects/shiny/app1") 92 93# deploy using an alternative application name and title 94deployApp("~/projects/shiny/app1", appName = "myapp", 95 appTitle = "My Application") 96 97# deploy specifying an explicit account name, then 98# redeploy with no arguments (will automatically use 99# the previously specified account) 100deployApp(account = "jsmith") 101deployApp() 102 103# deploy but don't launch a browser when completed 104deployApp(launch.browser = FALSE) 105} 106} 107\seealso{ 108\code{\link{applications}}, \code{\link{terminateApp}}, and 109 \code{\link{restartApp}} 110} 111