This section describes common administrative tasks for RStudio Package Manager.
Online and Offline Modes#
See also Managing Cluster Nodes for information on managing the online/offline modes of multiple nodes in a cluster.
The RSPM service supports two modes:
Online- When running in online mode, the RSPM service is fully functional.
Offline- When running in offline mode, the RSPM service returns
503 (service unavailable)responses for all requests. In offline mode, only a few services are available:
- API methods that support switching to online mode and enumerating cluster nodes
- A database connection that listens for notifications to enter online or offline mode (PostgreSQL only)
When initiating offline mode, the service attempts to complete any in-progress work and finishes serving any outstanding HTTP requests before going offline.
When initiating online mode, the service reads the RSPM configuration file and
starts service with the new settings effective. The only exceptions are network-
related settings like the
HTTP.Listen port. When updating network settings,
please stop and start the RSPM service.
rspm offline and
rspm online CLI commands to initiate online and
Stopping and Starting#
In some cases, you may wish to take the RSPM service offline and back online instead of stopping and starting the service. See Online and Offline Modes for information.
Occasionally it is necessary to start and stop the RStudio Package Manager service.
Stopping and starting is handled by
systemd is a management and configuration platform for Linux.
After a restart, any scheduled syncs that were missed during downtime will automatically begin. See the CRAN Source section for details.
The RStudio Package Manager installer installs a
systemd service called
rstudio-pm, which causes the RStudio Package Manager to be started and
stopped automatically when the machine boots up and shuts down. The
rstudio-pm service is also automatically launched during installation.
Use the following commands to manually start and stop the server:
sudo systemctl start rstudio-pm sudo systemctl stop rstudio-pm
You can restart the server with:
sudo systemctl restart rstudio-pm
If you wish to keep the server running without interruption, but reload the
configuration, you can use the systemctl command to send a
sudo systemctl kill -s HUP --kill-who=main rstudio-pm
HUP signal causes the server to re-initialize but does not interrupt the current processes or any of the open connections to the server.
HUP signal when your configuration changes are limited to properties marked as reloadable. Perform a full restart of RStudio Package Manager when changing other properties.
HUP signal only reloads configuration settings that have explicitly changed.
Commenting out a setting will not affect the configuration when using the
signal. If you have commented out a setting instead of changing the setting
value, restart the RStudio Package Manager service instead of using the
Additionally, licensing changes support the
See the Appendix - Reloadable Properties section to learn which settings may be reloaded via HUP.
You can check the status of the
rstudio-pm service using:
sudo systemctl status rstudio-pm
And finally, you can use the
disable commands to control whether
RStudio Package Manager should be run automatically at boot time:
sudo systemctl enable rstudio-pm sudo systemctl disable rstudio-pm
RSPM provides a simple health-check endpoint
/__ping__, that can be used to test if the service is up/listening. The
endpoint returns an empty JSON response and an HTTP 200 status. For example, on our public site this looks like:
$ curl -I -X GET https://packagemanager.rstudio.com/__ping__ << HTTP/2 200 << content-type: application/json << ...
See Upgrading a Cluster for details on upgrading a highly- available cluster with minimal downtime.
Upgrading RStudio Package Manager requires limited downtime. During an upgrade users will not be able to install packages. We recommend upgrading during a period of downtime.
The latest version is available on the download page along with release notes. The current version is available by running:
- Download the latest
Run the install command:
sudo gdebi <rstudio-pm-version.deb>
sudo yum install <rstudio-pm-version.rpm>
sudo zypper install <rstudio-pm-version.rpm>
The new version of RStudio Package Manager will install on top of an earlier installation. Existing configuration settings are respected. During installation the RStudio Package Manager service is restarted.
Purging RStudio Package Manager#
You can fully remove RStudio Package Manager and all its data from your server using the following steps:
- Stop the RStudio Package Manager service. (See Stopping and Starting for details)
Uninstall the RStudio Package Manager package from your system:
sudo apt-get purge rstudio-pm
sudo yum remove rstudio-pm
sudo zypper remove rstudio-pm
/opt/rstudio-pmif it still exists.
- Remove logs from
- Purge the databases
- When using SQLite, remove the
SQLite.Dirdirectory. This has a default location of
- When using PostgreSQL, drop the databases used by RStudio Package Manager. You may also wish to remove the PostgreSQL user associated with RStudio Package Manager.
- When using SQLite, remove the
- Remove the
Server.DataDirdirectory. By default, this is
- Remove configuration files from
/etc/rstudio-pmif they still exist.
- Remove any variable data directories outside the
Server.DataDirdirectory that are defined by
FileStorageconfiguration sections. See the Variable Data Classes section for more information.
- Remove any data stored on S3. See the Storage Class Destinations section.
We recommend including the RStudio Package Manager configuration file in
/etc/rstudio-pm as well as the variable data directory which defaults
/var/lib/rstudio-pm in your system backups. If you have configured
the databases to be stored outside the data directory, ensure that it is also
included in the backup. If you have customized the storage locations for
any variable data classes (see the Variable Data Classes section), each
customized directory should also be included in the backup.
If you use S3 to store variable data, consider whether you need additional backups for your S3 data. See the Storage Class Destinations section for more information about storing variable data on S3.
A running RStudio Package Manager server may be writing into the data directory. You should stop the RStudio Package Manager server before taking a backup.
sudo stop rstudio-pm # Run appropriate backup steps here. sudo start rstudio-pm
Your platform may need alternate commands to restart RStudio Package Manager. Please see the Stopping and Starting section for instructions specific to your operating system version.
See the Server Migrations section for information on migrating your RStudio Package Manager installation to another environment.
RStudio Package Manager listens on HTTP port 4242 by default. When you modify
HTTPS.Listen configuration properties to use a privileged
port under 1024, the service will fail to start, and you will see an error like
the following in
2017/11/28 13:41:59 Error: Could not initialize the HTTP listener: listen tcp :80: bind: permission denied
If you wish to listen with HTTP or HTTPS on a privileged port (< 1024), you can grant the RStudio Package Manager binary permission to do so by issuing the following command as root:
sudo setcap 'cap_net_bind_service=+ep' /opt/rstudio-pm/bin/rstudio-pm
After issuing the above command, restart the service (see the Stopping and Starting section).
Improving Performance for Local Sources#
When RStudio Package Manager adds packages to local sources, it stores the packages in tar archives using gzip compression. If you are installing large packages in local sources, you may be able to improve performance by adjusting these settings:
- Gzip Compression Level - A lower value will result in higher storage requirements, but increases performance. Valid values range from 1 to 9.
- Write Buffer Size - Use a buffer size that is appropriate for the packages storage target. See the Variable Data Classes section for information on where packages are stored.
; /etc/rstudio-pm/rstudio-pm.gcfg [Server] PackageRewriteCompressionLevel = 6 PackageRewriteBufferSize = 32KB
; /etc/rstudio-pm/rstudio-pm.gcfg [Server] ; Decreasing the compression level increases the storage requirements, but ; greatly increases the speed of writing packages for local sources. PackageRewriteCompressionLevel = 1 ; Set a buffer size that is appropriate for the storage system that contains ; packages. PackageRewriteBufferSize = 2MB