Setup Tool Installation

The Posit Connect Setup Tool is the best way to install and get started with Connect. The Setup Tool provides a user-friendly UI to install, initially configure, test, and deploy Connect to your environment. The Setup Tool uses a script that works across all supported Linux distributions, validates the cryptographic signature of the downloaded package, and includes support for offline use.

Note

The Setup Tool is only available for first-time installations and cannot be used for making updates to your configuration. If you are upgrading from an older version to a newer one, please refer to the Upgrade section.

The Setup Tool installs Connect and helps you set up basic configuration options, including:

The full list of supported features that can be configured using the Setup Tool is provided in the Post-Setup Tool Procedures section. Features that are not available for configuration with the Setup Tool can be configured at any time by editing the configuration file.

Prerequisites

Before proceeding with the installation, you must:

  • Meet the Requirements for Connect
  • Review the below checklist and verify that you have the required information

The following information needs to be provided for the Setup Tool:

  • A license key (unless running an evaluation)
  • Version(s) of R users need on the the sever
  • Version(s) of Python users need on the server
  • Authentication integration details
  • Git credentials (optional)
  • The public server or hostname of the Connect server
  • SSL/TLS certificates (recommended):
    • Public certificate file
    • Private key file
  • SMTP mail server integration details:
    • The hostname or IP address of the SMTP server used for email delivery
    • Email address used by Connect to send outbound email
  • PostgreSQL database details (if you plan on configuring load balancing)
Note

Multiple members of your organization might need to provide information. Organizing required information before starting the Setup Tool is best practice and saves you time.

Step 1: Download and run the installation script

Important

This page includes instructions for downloading Posit professional products. Download and/or use of these products is governed under the terms of the Posit End User License Agreement. By downloading you agree to the terms posted there.

The installation script works across all supported Linux distributions, validates the GPG key of the downloaded package, and includes support for offline use. The installation script must be run by a privileged user or a user with sudo privileges.

To install Connect version 2023.09.0, download and run the installation script:

curl -Lo rsc-installer.sh https://cdn.rstudio.com/connect/installer/installer-latest-release.sh
sudo -E bash ./rsc-installer.sh 2023.09.0

The script:

  1. Downloads missing required dependencies
  2. Downloads the Connect package
  3. Installs Connect

After the installation is complete, you are given the choice to:

Troubleshooting Information

If you are not able to successfully install Connect using the installation script, then please review and complete the troubleshooting steps provided in the installation script’s output. If you still require additional help, please refer to this article on Troubleshooting the Setup Tool.

Connect install files

  • If you don’t have an .rpm or .deb file containing Connect and all of its dependencies (other than R), use one of the following to download and install Connect:
curl -O https://cdn.rstudio.com/connect/{{ vars.connect.rsc.short_version }}/rstudio-connect-{{ vars.connect.rsc.full_version }}.el9.x86_64.rpm
sudo yum install rstudio-connect-{{ vars.connect.rsc.full_version }}.el9.x86_64.rpm
curl -O https://cdn.rstudio.com/connect/{{ vars.connect.rsc.short_version }}/rstudio-connect-{{ vars.connect.rsc.full_version }}.el8.x86_64.rpm
sudo yum install rstudio-connect-{{ vars.connect.rsc.full_version }}.el8.x86_64.rpm
curl -O https://cdn.rstudio.com/connect/{{ vars.connect.rsc.short_version }}/rstudio-connect-{{ vars.connect.rsc.full_version }}.el7.x86_64.rpm
sudo yum install rstudio-connect-{{ vars.connect.rsc.full_version }}.el7.x86_64.rpm
curl -O https://cdn.rstudio.com/connect/{{ vars.connect.rsc.short_version }}/rstudio-connect-{{ vars.connect.rsc.full_version }}.amazonlinux2.x86_64.rpm
sudo yum install rstudio-connect-{{ vars.connect.rsc.full_version }}.amazonlinux2.x86_64.rpm

## Ubuntu 22.04

sudo apt-get install gdebi-core
curl -O https://cdn.rstudio.com/connect/{{ vars.connect.rsc.short_version }}/rstudio-connect_{{ vars.connect.rsc.full_version }}~ubuntu22_amd64.deb
sudo gdebi rstudio-connect_{{ vars.connect.rsc.full_version }}~ubuntu22_amd64.deb
sudo apt-get install gdebi-core
curl -O https://cdn.rstudio.com/connect/{{ vars.connect.rsc.short_version }}/rstudio-connect_{{ vars.connect.rsc.full_version }}~ubuntu20_amd64.deb
sudo gdebi rstudio-connect_{{ vars.connect.rsc.full_version }}~ubuntu20_amd64.deb
sudo apt-get install gdebi-core
curl -O https://cdn.rstudio.com/connect/{{ vars.connect.rsc.short_version }}/rstudio-connect_{{ vars.connect.rsc.full_version }}~ubuntu18_amd64.deb
sudo gdebi rstudio-connect_{{ vars.connect.rsc.full_version }}~ubuntu18_amd64.deb
curl -O https://cdn.rstudio.com/connect/{{ vars.connect.rsc.short_version }}/rstudio-connect-{{ vars.connect.rsc.full_version }}.sles15.x86_64.rpm
sudo zypper install rstudio-connect-{{ vars.connect.rsc.full_version }}.sles15.x86_64.rpm

Please see the Manual Installation documentation for more information.

Step 2: Configure Connect using the Setup Tool

The Setup Tool is designed to step through several initial configuration options, with a primary focus on validating your licensing and authentication settings.

If you need to pause the configuration process:

  • You can close your browser.
  • Return to the configuration process later with the saved state.

Setup Tool CLI Flags

The Setup Tool supports the following flags:

Option Function
-h Print help
-x Launches the Setup Tool (requires Connect installation)

To use one of the flags listed above, execute the following command:

Terminal
sudo -E bash ./rsc-installer.sh <flag>

For example, if you want to launch the Setup Tool after manually installing Connect, run:

Terminal
sudo -E bash ./rsc-installer.sh -x

Step 3: Additional integration and validation tasks

Upon completion, you are redirected back to this site for a review of additional recommended integration and validation tasks. These recommended integration and validation tasks are available in the Setup Tool - Post Installation Procedures documentation.

Note

The Setup Tool does not currently support floating license server configurations. Refer to the Licensing table, shown below, for more information about supported Setup Tool features.

Setup Tool configuration options

The following features can be initially configured with the Setup Tool:

Licensing

Setup Tool Feature Support Included Recommended Instructions
Online Evaluation Yes
Offline Evaluation Yes
Online License Key Yes
Offline License Key Yes
Floating License For this option, please use the Manual Installation and reference the Floating Licenses documentation.

Authentication

Setup Tool Feature Support Included Recommended Instructions
SAML Yes
LDAP Yes
PAM Yes
OAuth (OIDC) Yes
Password Built-in Yes

Environments

Setup Tool Feature Support Included Recommended Instructions
R Installations Yes
Python Installations Yes
Recommended System Packages Yes

Web Server

Setup Tool Feature Support Included Recommended Instructions
HTTPS Yes This is recommended.
HTTP Yes
Proxy Server Can be configured post-setup. See the Proxy section.

Mail Server

Setup Tool Feature Support Included Recommended Instructions
SMTP Yes
Sendmail Not the recommended option, but if necessary, please use the Manual Installation option and reference the Email Setup documentation.
Disable Mail Yes Not the recommended option. If email is disabled, then several Connect features will not function.

Databases

Setup Tool Feature Support Included Recommended Instructions
SQLite Yes Additional SQLite Information
PostgreSQL Yes Additional PostgreSQL Information

Additional Configuration Options

Setup Tool Feature Support Included Recommended Instructions
Version Control Yes
Data Sources Can be configured post-setup. See the Data Sources section.
Load Balancing Can be configured post-setup. See the Load Balancing section.
Service, Audit, and Access Logging Yes Additional Structured Logging Information.

Setup Tool post-installation procedures

Following the initial installation of Connect using the Setup Tool, we recommend completing several integration steps and verification tasks, documented in the Post-Setup Tool Procedures.