Installation#
Posit End User License Agreement
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.
These instructions describe how to install Posit Package Manager on a single Linux server. For alternative installation instructions, see our Install Posit Professional Products overview. Depending on your environment, additional steps may be required to install Package Manager.
Multi-server installation
If you would like to install Package Manager on multiple Linux servers, use these instructions to install Package Manager on each server and then continue to the Multi-Server Installation procedures.
If you've already installed Package Manager, we recommend reviewing our Quick Start documentation to help administrators configure Package Manager for your organization's specific use cases.
Prerequisites#
Please review and complete the following before proceeding:
- System Requirements
- Internet Access Requirements
- Root Requirements
- R and Python Installation - Git Sources
For air-gapped or offline installations, review these additional requirements:
Advanced
Step 1. Download and install#
Download and install the server application version 2024.11.0-7 (see the Signed Build section below to verify the signature of the package):
Note
These commands install the product into /opt/rstudio-pm
. See the Manual Installation for Minimal Root Use section to install into a non-default location or to perform a non-root install.
Signed Build#
The Package Manager installer is signed with a key belonging to Posit. If you'd like to know more about the benefits of using signed builds, see the Posit Signed Builds page.
For product builds released after 7/25/23 (including new and patched builds), use the "Post 7/25/2023" key. For builds released prior to 7/25/23, use the "Pre 7/25/2023" key.
Obtain the key:
We have two ways to obtain the key:
- Obtain the public key from our website and save it into a file (e.g.,
posit.key
). -
Obtain the key from a GnuPG keyserver using the following commands:
Once you have obtained the key, you need to import it into the set of keys RPM uses to validate package signatures, after which you can validate the package signature using the rpm
command:
Validate the Package Manager installer executing the following commands:
Step 2. Initial Configuration#
By default, Package Manager settings are controlled by a configuration file located at /etc/rstudio-pm/rstudio-pm.gcfg
.
If Package Manager is served from a subdirectory like /packagemanager/
, you must configure the Server.Address
setting for some features to work, such as PyPI package serving and the Server API documentation.
Server.Address
should be the public URL for this server in the format of http(s)://[HOST:PORT]
. If Package Manager is deployed behind an HTTP proxy, provide the URL as seen by users through the proxy.
Otherwise, Server.Address
is optional and may be left unset.
; /etc/rstudio-pm/rstudio-pm.gcfg
[Server]
Address = https://packagemanager.example.com/
; Or if served at a subdirectory like /packagemanager/
;Address = http://example.com:4242/packagemanager/
There are many other options you may want to configure now or in the future, such as:
- The on-disk location where data will be stored, default:
/var/lib/rstudio-pm
. - The database where essential metadata should be stored, default: built-in SQLite.
- Important security settings such as HTTPS certificates and ports; the default is HTTP on port 4242.
- High Availability and Load Balancing options.
Example configuration file
An example configuration file that includes all the available configuration settings along with their defaults is installed at /etc/rstudio-pm/rstudio-pm.gcfg.defaults
.
Step 3. Activate license#
To verify the status of your license:
If you have a license file, then activate the license by transferring the license file to the server hosting Posit Package Manager, ensure ownership and read permissions for the PPM service user, and activate it with the commands:
$ sudo chown rstudio-pm <license-file>.lic
$ sudo chmod 0600 <license-file>.lic
$ sudo cp -a <license-file>.lic /var/lib/rstudio-pm/
$ sudo systemctl restart rstudio-pm
RunAs User
The default Package Manager RunAs user is rstudio-pm
. If you've configured a different RunAs user, ensure that user has file ownership.
For full details and information about license key activation, see the Licensing page.
Step 4. Restart Package Manager#
After updating the configuration file and activating the license, you must restart the Package Manager service:
Tip
Most configuration setting changes can also be updated by taking the Package Manager service offline and bringing it back online. For more information, see the Online and Offline Modes page.
To restart the Package Manager service, run the following commands:
Package Manager supports the HUP
signal when:
- Making licensing changes.
- Activating a new license.
Step 5. Verify installation#
There are two ways to verify a successful Package Manager installation:
- View the Package Manager Web UI.
- The Admin Command-line interface.
View the Package Manager Web UI#
As a user, you can view Package Manager in a web browser, which provides a user-friendly interface for viewing information about packages, package READMEs, metrics, etc. See the User Guide for additional information.
To view Package Manager in a web browser:
- Open a web browser.
- Navigate to Package Manager by following
http(s)://packagemanager.example.com:<port>
(the default port is 4242).
Once you navigate to the Package Manager URL, the Package Manager Welcome page displays. For any administrative changes, use the CLI.
The Admin Command-line Interface#
Package Manager is administered through a command-line interface (CLI) which administrators can use to:
- Create repositories and sources.
- Setup sync schedules for CRAN sources.
To invoke the Admin CLI, run: /opt/rstudio-pm/bin/rspm list
If you aren't able to access the Admin CLI, then verify that your user is a member of the rstudio-pm
group by doing the following:
-
Run the following to add
USER
to therstudio-pm
group (replace<USER>
with your username): -
Close the terminal or SSH session.
- Start a new session and run the
groups
command. This enumerates the groups that the current user is a member of. - Confirm that
rstudio-pm
is listed. -
Run the command:
Note
You can select a different group to grant access to the Admin CLI. For more information, see the Changing RunAs User page.
Optional downloads#
There are two additional executables that are optional depending on the intended installation:
- Standalone CLI: Used to remotely manage the server with actions like adding packages or uploading binaries.
- Offline Downloader: Used to download remote assets to initialize or upgrade air-gapped servers.
Download and install the standalone CLI#
The standalone rspm
CLI can be used to remotely manage the server, with actions such as adding packages or uploading binaries remotely. For more information, see the Quick Start page.
- Download https://cdn.posit.co/package-manager/windows/amd64/rspm-cli-windows-2024.11.0-7.exe
- Rename it to rspm.exe
RSPM_SERVER_VERSION
Ensure compatibility by setting the RSPM_SERVER_VERSION
environment variable to the server version. The server version can be found by running the following command on a running Package Manager server:
Download and install offline downloader#
Advanced
The rspm-offline-downloader
utility is required for air-gapped installations of Package Manager to function correctly (see the Air-Gapped Package Manager section):
- Download https://cdn.posit.co/package-manager/windows/amd64/rspm-offline-downloader-windows-2024.11.0-7.exe
- Rename it to rspm-offline-downloader.exe
For a list of changes, see the Package Manager: Offline Downloader release notes.