Configuration#

This appendix documents the RStudio Package Manager configuration file format and enumerates the user-configurable options.

Configuration Basics#

The RStudio Package Manager configuration file is located at /etc/rstudio-pm/rstudio-pm.gcfg. This configuration is read at startup and controls the operation of the service.

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.

File Format#

The RStudio Package Manager configuration file uses the gcfg (Go Config) format, which is derived from the Git Config format.

Here is an example of that format showing the different property types:

; Comment
[BooleanExamples]
property1 = true
property2 = off
property3 = 1

[IntegerExamples]
Property1 = 42
Property2 = -123

[DecimalExamples]
Property1 = 3.14
Property2 = 7.
Property3 = 2
Property4 = .217

[StringExamples]
Property1 = simple
Property2 = "quoted string"
Property3 = "escaped \"quote\" string"

[MultiStringExamples]
ListProperty = black
ListProperty = blue
ListProperty = green

[DurationExamples]
Property1 = 1000000000
Property2 = 500ms
Property3 = 1m15s  ; comment with a property

Comments always start with a semi-colon (;) or hash (#) and continue to the end of the line. Comments can be on lines by themselves or on a line with a property or section definition.

Configuration sections always begin with the name of the section bounded by square brackets. A section may appear multiple times and are additive with the last value for any property being retained. The following two configuration examples are equivalent.

[Example]
A = aligator
B = 2

[Example]
A = aardvark
C = shining

[Example]
A = aardvark
B = 2
C = shining

Each configuration property must be included in its appropriate section. Property and section names are interpreted case-insensitively.

Property definitions always have the form:

Name = value

Multi-value Properties#

If a property happens to to be given more than once, only the last value is retained. The "multi" properties are an exception to this rule; multiple entries are aggregated into a list.

[MultiExample]
Color = black
Color = blue

[NonMulti]
Animal = cat
Animal = dog

If Color is a multi-string property, both the "black" and "blue" values are used. If Animal is a normal string property, only the value "dog" is retained.

Property Types#

Configuration properties all have one of the following types:

string

A sequence of characters. The value is taken as all characters from the first non-whitespace character after equal sign to the last non-whitespace character before the end-of-line or start of a comment. Double-quotes (") are supported, but usually unnecessary. A literal double-quote MUST be escaped and quoted itself like QuotedValue = "J.R. \"Bob\" Dobbs". Strings containing the comment characters ; and # also need to be quoted.

Some parameters with type string may require a valid crontab string. For more information see the appendix section on the crontab format.

encrypted-string

A potentially encrypted sequence of characters. The rules on how the value is taken from the file are the same as for the regular string type. But to generate an encrypted string one needs to enter the plain text value as-is (no quotes or escaping) in the command rspm encrypt which will output the encrypted version of the entered value. Encrypted values are tied to the RStudio Package Manager installation that generated them in most cases. For convenience and backwards compatibility, plain text values are accepted. However, in this case RStudio Package Manager will log a message on startup saying that the value should have been encrypted. See the Configuration Encryption page for more information.

multi-string

A property that takes multiple string values. The property name is listed with each individual input value. For example, providing Color = black and Color = blue results in two separate values. Defaults for multi-string configuration properties are not overridden when additional values are configured.

boolean

A truth value. The values true, yes, on, and 1 are interpreted as true. The values false, no, off, and 0 are interpreted as false.

integer

An integral value.

bytesize

A value specifying the data size. When provided as a raw number, the value is interpreted as bytes. Data size values can also be specified as a sequence of decimal numbers, each with optional fraction and unit suffix such as "10MB" for 10 megabytes, "2000" for 2000 bytes, or "1GB" for 1 gigabytes.

Valid data size units are B (bytes), KB (kilobyte), MB (megabyte), GB (gigabyte), and TB (TB).

decimal

A numeric value with an optional fractional component. Values with and without a decimal point are allowed.

duration

A value specifying a length of time. When provided as a raw number, the value is interpreted as nanoseconds. Duration values can also be specified as a sequence of decimal numbers, each with optional fraction and unit suffix, such as 300ms, 1.5h, or 1m30s.

Valid time units are ns (nanoseconds), us (microseconds), ms (milliseconds), s (seconds), m (minutes), h (hours), and d (days).

version

A string representing a version. A version may have one to four numeric components, separated by periods or hyphens. Examples include 2, 2.5, 2.5.6, 2.5.6.1, and 2.5-6-11.

Each configuration property documented in this appendix includes its description, data type, and default value.

Reloadable Properties#

Some properties are marked as "reloadable". Sending a HUP signal to the RSPM process causes the on-disk configuration to be reread. The server is reconfigured with the latest values of these reloadable properties. See the Stopping and Starting RSPM section for details about sending a HUP signal to your RSPM process.

Server#

The Server section contains configuration properties which apply across the whole of RStudio Package Manager and are not appropriate for the other sections, which are generally narrower.

The properties which follow all must appear after [Server] in the configuration file.

Server Settings#

DataDir#

The directory where RStudio Package Manager will store its variable data.

Type: string
Default: /var/lib/rstudio-pm

TempDir#

The directory that will contain all temporary directories needed by R processes. May not be a child path of Server.DataDir. If TMPDIR environment variable is not defined then /tmp.

Type: string
Default: $TMPDIR

CacheTimeout#

The amount of time we wait for files to appear in the cache directory after the database reports they are available. The default of 65 seconds should accommodate the NFS default directory caching limit of 60 seconds

Type: duration
Default: 65s

LauncherDir#

The directory where the RStudio Job Launcher maintains configuration and log files. For cluster environments, this should be a directory not shared with other RStudio Package Manager servers. Must be readable and writeable by the configured Launcher.ServerUser and Launcher.AdminGroup. For best performance, use a local, non-network filesystem.

Type: string
Default: <empty-string>

RVersion#

Path to an R installation root.

Type: multi-string
Default: unspecified

Address#

A public URL for this RStudio Package Manager server.

Type: string
Default: <empty-string>

ServerName#

By default, Package Manager sets the Server HTTP header to something like RStudio Package Manager v1.2.3. This setting allows you to override that value.

Type: string
Default: <empty-string>

ReadTimeout#

The read timeout for the RSPM HTTP(s) web server. Note that this is also used as the idle timeout.

Type: duration
Default: 1m

CustomHeader#

Custom HTTP header that should be added to responses from Package Manager in the format of key: value. The left side of the first colon in the string will become the header name; everything after the first colon will be the header value. Both will be trimmed of leading/trailing whitespace. This will always add a new header with the specified value; it will never override a header that Package Manager would otherwise have set. Multiple definitions can be used to provide multiple custom headers.

Type: multi-string
Default: unspecified

HideVersion#

When true, the /version API returns a blank string and the product version is not displayed in the UI.

Type: boolean
Default: false
Reloadable: true

ContentTypeSniffing#

If disabled, sets the X-Content-Type-Options HTTP header to nosniff. When enabled, removes that header, allowing browsers to mime-sniff responses.

Type: boolean
Default: false

AccessLog#

Path to the file that RStudio Package Manager will use for its access logs. Disabled when empty.

Type: string
Default: /var/log/rstudio/rstudio-pm/rstudio-pm.access.log

AccessLogFormat#

Switch the access log format. Accepted values are combined for the Apache Combined Log Format and common for the Apache Common Log Format.

Type: string
Default: combined

ServiceLog#

Path to the file that RStudio Package Manager will use for its service logs. Disabled when empty.

Type: string
Default: <empty-string>

FrameOptionsUI#

The value for the X-Frame-Options HTTP header for the Package Manager UI and all other Package Manager pages. If empty, no header will be added.

Type: string
Default: DENY

SockFileDir#

RStudio Package Manager will use this directory to create a socket file for admin connections.

Type: string
Default: /var/run/rstudio-pm

UsageDataEnabled#

If true, will enable tracking of package downloads.

Type: boolean
Default: true

UsageDataRetention#

The number of days for which usage data will be retained. If 0, data will be preserved forever.

Type: integer
Default: 365

UsageDataSchedule#

The schedule for usage data aggregation. Must be a valid crontab string.

Type: string
Default: 0 0 * * *
Reloadable: true

EncryptionKeyPath#

The filepath of the encryption key used to store sensitive data at rest. Must be 512 bits (64 bytes) and file mode must be 0600. For cluster environments every server must have a copy of the same key file.

Type: string
Default: {Server.DataDir}/rstudio-pm.key

PackageCacheSize#

The approximate number of package requests to cache in memory for faster package serving. Must be greater than 1500.

Type: integer
Default: 2000

PackageCacheLife#

The amount of time to serve package sources and binaries based on cached information.

Type: duration
Default: 5m

MemoryCacheSize#

The amount of memory allocated for in-memory caching. Disabled when zero.

Type: bytesize
Default: 100MB

MemoryCacheLife#

The amount of time to cache assets in memory. If zero, lifetime is unbounded.

Type: duration
Default: 0

EvictedStorageClasses#

The storage class(es) for which the eviction is enabled. Use a comma-separated list, including any of the following: binaries,bioconductor,cache,cran,metrics,pypi

Type: string
Default: binaries,bioconductor,cache,cran,pypi

EvictionInterval#

The interval at which stale items are evicted from persistent storage

Type: duration
Default: 60m

EvictionSweepSchedule#

The schedule for evicting any unrecorded items in persistent storage. Must be a valid crontab string. Use a blank value to disable.

Type: string
Default: 0 0 * * *

PackagesEvictionSchedule#

The schedule for evicting any orphaned packages in persistent storage. Must be a valid crontab string. Use a blank value to disable.

Type: string
Default: 30 0 * * *

ChunkLimit#

The maximum size for downloaded source and binary packages. Downloads that exceed this size will be stored in chunks.

Type: bytesize
Default: 10MB

ChunkSize#

The chunk size for downloaded source and binary packages that are stored in chunks.

Type: bytesize
Default: 1MB

PackageRewriteCompressionLevel#

The gzip compression level (1-9) to use when rewriting local packages. Lower values will result in better performance, but will require more disk space.

Type: integer
Default: 6

PackageRewriteBufferSize#

The size for the write buffer used when rewriting local packages.

Type: bytesize
Default: 32KB

API#

The API section contains configuration properties which apply to the RStudio Package Manager API.

The properties which follow all must appear after [API] in the configuration file.

API Settings#

MaxApiResults#

Limits the maximum number of results that can be returned from API endpoints that support a _limit parameter. When zero, there is no limit. Please consider performance implications before raising this limit.

Type: integer
Default: 1000

DefaultApiResultsLimit#

The default limit on the number of results returned from API endpoints that support a _limit parameter. When zero, there is no limit.

Type: integer
Default: 100

HTTP#

The HTTP section contains configuration properties which control the ability of RStudio Package Manager to listen for HTTP requests. RStudio Package Manager must be configured to listen for either HTTP or HTTPS requests (allowing both is acceptable).

These properties must appear after [HTTP] in the configuration file.

HTTP Settings#

Listen#

RStudio Package Manager will listen on this network address for HTTP connections. The network address can be of the form :80 or 192.168.0.1:80. Either HTTP.Listen or HTTPS.Listen is required.

Type: string
Default: <empty-string>

NoWarning#

Disables warnings about insecure (HTTP) connections.

Type: boolean
Default: false

ForceSecure#

RStudio Package Manager will mark cookies secure on its unsecured connection. This option should be used when RStudio Package Manager is behind a secure proxy.

Type: boolean
Default: false

HTTPS#

The HTTPS section contains configuration properties which control the ability of RStudio Package Manager to listen for HTTPS requests. RStudio Package Manager must be configured to listen for either HTTP or HTTPS requests (allowing both is acceptable).

These properties must appear after [HTTPS] in the configuration file.

HTTPS Settings#

Listen#

RStudio Package Manager will listen on this network address for HTTPS connections. The network address can be of the form :443 or 192.168.0.1:443. Either HTTP.Listen or HTTPS.Listen is required.

Type: string
Default: <empty-string>

Key#

Path to a private key file corresponding to the certificate specified with HTTPS.Certificate. Required when HTTPS.Certificate is specified.

Type: string
Default: <empty-string>

Certificate#

Path to a TLS certificate file. If the certificate is signed by a certificate authority, the certificate file should be the concatenation of the server's certificate followed by the CA's certificate. Must be paired with HTTPS.Key.

Type: string
Default: <empty-string>

Permanent#

Advertises to all visitors that this server should only ever be hosted securely via HTTPS. WARNING: if this is set to true -- even temporarily -- visitors may be permanently denied access to your server over an unsecured (non-HTTPS) protocol. This sets the secure flag on all session cookies and adds a Strict-Transport-Security HTTP header with a value of 30 days.

Type: boolean
Default: false

MinimumTLS#

Minimum permitted TLS version. Valid values are 1.0, 1.1, and 1.2. Allowed values are 1.0, 1.1, 1.2 or 1.3.

Type: string
Default: 1.1

HttpRedirect#

The HttpRedirect section contains configuration properties which control the ability of RStudio Package Manager to listen for HTTP requests and then redirect all traffic to some alternate location. This is useful when paired with an HTTPS.Listen configuration.

These properties must appear after [HttpRedirect] in the configuration file.

HttpRedirect Settings#

Listen#

RStudio Package Manager will listen on this network address for HTTP connection and redirect to either the HttpRedirect.Target or Server.Address target location. The network address can be of the form :8080 or 192.168.0.1:8080. Useful when you wish all requests to be served over HTTPS and send users to that location should they accidentally visit via an HTTP URL. Must be paired with either HttpRedirect.Target or Server.Address.

Type: string
Default: <empty-string>

Target#

The target for redirects when users visit the HttpRedirect.Listen HTTP service. Server.Address is used as a redirect target if this property is not specified.

Type: string
Default: <empty-string>

Git#

The Git section contains configuration properties which RStudio Package Manager uses to build R packages from Git repositories.

These properties must appear after [Git] in the configuration file.

Git Settings#

BuilderDir#

The directory where RStudio Package Manager will store git repos.

Type: string
Default: {Server.DataDir}/git
Reloadable: true

PollInterval#

The amount of time to wait between polling git repos to look for package changes.

Type: duration
Default: 5m
Reloadable: true

TagMatching#

The regular expression used to determine whether a git tag is a valid version.

Type: string
Default: {regular expression suppressed}

BuildConcurrency#

The maximum number of packages to build at one time.

Type: integer
Default: 25

BuildRetries#

The maximum number of times to attempt building a git package when the build fails.

Type: integer
Default: 3

ForceDescriptionVersion#

By default, branch builds will append .0.0.0.[timestamp] to the package version to ensure uniqueness. Set this to true to use the version in the DESCRIPTION file and replace any existing packages with the same version.

Type: boolean
Default: false

AllowUnsandboxedGitBuilds#

When the Linux user namespace is unavailable, allow unsafe Git package builds without a sandbox.

Type: boolean
Default: false

Launcher#

The Launcher section contains configuration properties which control the RStudio Job Launcher. The RStudio Job Launcher provides the capability to launch executables, allowing RStudio Package Manager to launch R processes for tasks like building R packages.

These properties must appear after [Launcher] in the configuration file.

Launcher Settings#

Disabled#

Disables the job launcher

Type: boolean
Default: false

Port#

Port number (0-65535)

Type: integer
Default: 5561

ServerUser#

User that runs the job launcher executable.

Type: string
Default: rstudio-pm

AdminGroup#

Name of the admin group of users that are able to see/control all jobs in the system of other users.

Type: string
Default: rstudio-pm

DebugLogging#

Enables verbose debug logging for the job launcher.

Type: boolean
Default: false

RequestTimeoutSeconds#

Number of seconds a plugin has to process a request before it is considered timed out.

Type: integer
Default: 120

TransportTimeoutMinutes#

Number of minutes an HTTP request to the launcher has to process before it is considered timed out.

Type: integer
Default: 180

Metrics#

The Metrics section contains configuration properties which control how RStudio Package Manager exposes metrics.

These properties must appear after [Metrics] in the configuration file.

Metrics Settings#

Enabled#

Specifies whether or not the metrics service will be started.

Type: boolean
Default: false

Listen#

The address on which to listen for metrics requests.

Type: string
Default: :2112

ReadTimeout#

The read timeout for the RSPM HTTP(s) metrics server. Note that this is also used as the idle timeout.

Type: duration
Default: 1m

WriteTimeout#

The write timeout for the RSPM HTTP(s) metrics server.

Type: duration
Default: 5m

Licensing#

The Licensing section contains configuration properties which control how RStudio Package Manager interacts with its licensing system.

These properties must appear after [Licensing] in the configuration file.

Licensing Settings#

LicenseType#

Enable remote or local validation. local is traditional activation, whereas remote uses floating licensing.

Type: string
Default: local
Reloadable: true

RemoteRetryFrequency#

When Package Manager loses its lease, it will begin automatically attempting to acquire a lease by RemoteRetryFrequency. Use a value of 0 to disable retries.

Type: duration
Default: 10s
Reloadable: true

CRAN#

The CRAN section contains configuration properties related to the CRAN source in RStudio Package Manager.

CRAN Settings#

RetainFetchedPackages#

Retain CRAN source and binary packages in persistent storage. If set to auto, packages will be retained when using file-based storage in a non-air-gapped environment. Valid values include auto, yes, and no.

Type: string
Default: auto

ManifestURL#

The URL to the CRAN manifest service. Do not use this setting unless you want to get CRAN data from your own server.

Type: string
Default: https://rspm-sync.rstudio.com

SyncSchedule#

The schedule for CRAN synchronization. Must be a valid crontab string. Use a blank value for manual syncing only.

Type: string
Default: 0 0 * * *
Reloadable: true

CRANTimeout#

The timeout for downloading snapshots or changes (JSON) from the CRAN manifest

Type: duration
Default: 30m

FetchTimeout#

The timeout for downloading a CRAN package tarball.

Type: duration
Default: 10m

Binaries#

The distributions for which to enable binary package support. Use all to enable all distributions or a comma-separated list: e.g. xenial, bionic, focal, centos7, centos8, opensuse42, opensuse15, opensuse152, windows.

Type: string
Default: all

Bioconductor#

The Bioconductor section contains configuration properties related to the Bioconductor source in RStudio Package Manager.

Bioconductor Settings#

RetainFetchedPackages#

Retain Bioconductor source packages in persistent storage. If set to auto, packages will be retained when using file-based storage in a non-air-gapped environment. Valid values include auto, yes, and no.

Type: string
Default: auto

ManifestURL#

The URL to the Bioconductor manifest service. Do not use this setting unless you want to get Bioconductor data from your own server.

Type: string
Default: https://rspm-sync.rstudio.com/bioc

SyncSchedule#

The schedule for Bioconductor synchronization. Must be a valid crontab string. Use a blank value for manual syncing only.

Type: string
Default: 0 0 * * *
Reloadable: true

EnabledVersions#

Bioconductor versions that are created automatically when syncing. When unset, all supported Bioconductor versions are created automatically when syncing if a Bioconductor repo exists.

Type: multi-string
Default: unspecified

Timeout#

The timeout for downloading snapshots or changes (JSON) from the Bioconductor manifest

Type: duration
Default: 30m

FetchTimeout#

The timeout for downloading a Bioconductor package tarball.

Type: duration
Default: 10m

PyPI#

The PyPI section contains configuration properties related to the PyPI source in RStudio Package Manager.

PyPI Settings#

ManifestURL#

The URL to the PyPI manifest service. Do not use this setting unless you want to get PyPI data from your own server.

Type: string
Default: https://rspm-sync.rstudio.com/pypi/manifest

Timeout#

The timeout for downloading snapshots or changes (JSON) from the PyPI manifest

Type: duration
Default: 30m

RetainFetchedPackages#

Retain PyPI packages in persistent storage. If set to auto, packages will be retained when using file-based storage in a non-air-gapped environment. Valid values include auto, yes, and no.

Type: string
Default: auto

SyncSchedule#

The schedule for PyPI manifest synchronization. Must be a valid crontab string. Use a blank value for manual syncing only.

Type: string
Default: 0 1 * * *
Reloadable: true

DownloadConcurrency#

Maximum number of goroutines downloading PyPI JSON from the manifest URL. Must be between 1 and 150.

Type: integer
Default: 50

DownloadRetryLimit#

Maximum number of times to try downloading PyPI JSON from the manifest URL. Must be between 1 and 50.

Type: integer
Default: 15

FetchTimeout#

The timeout for downloading a PyPI package.

Type: duration
Default: 10m

Database#

The Database section contains configuration properties which control the location of and how RStudio Package Manager interacts with its databases.

These properties must appear after [Database] in the configuration file.

Database Settings#

Provider#

The type of database to use

Type: string
Default: sqlite3

MaxIdleConnections#

The maximum number of database connections that should be retained after they become idle. If this value is less-than or equal-to zero, no idle connections are retained.

Type: integer
Default: 5

MaxOpenConnections#

The maximum number of open connections to the database. If this value is less-than or equal-to zero, then there is no limit to the number of open connections.

Type: integer
Default: 10

ConnectionMaxLifetime#

The maximum amount of time a connection to the database may be reused. If this value is less-than or equal-to zero, then connections are reused forever.

Type: duration
Default: 60s

ConnectionTimeout#

The maximum amount of time to wait for a response while connecting to the database. If this value is less-than or equal-to zero, then connections can hang forever.

Type: duration
Default: 60s

SQLite#

The SQLite section contains configuration properties which control the location of and how RStudio Package Manager interacts with the SQLite database.

These properties must appear after [SQLite] in the configuration file.

Sqlite Settings#

Dir#

The directory containing the RStudio Package Manager database. Must reference a directory on the local filesystem and not on a networked volume like NFS.

Type: string
Default: {Server.DataDir}/db

PostgreSQL#

The Postgres section contains configuration properties which control the location of and how RStudio Package Manager interacts with a PostgreSQL database.

These properties must appear after [Postgres] in the configuration file.

Postgres Settings#

URL#

The fully qualified URL to connect to a Postgres database

Type: string
Default: <empty-string>

UsageDataURL#

The fully qualified URL to connect to a Postgres database where usage information will be written.

Type: string
Default: <empty-string>

Password#

The encrypted password to be used for the URL setting.

Type: encrypted-string
Default: <empty-string>

UsageDataPassword#

The encrypted password to be used for the UsageDataURL setting.

Type: encrypted-string
Default: <empty-string>

OfflineOnUpgrade#

When true, starts up in offline mode after an upgrade or initial installation

Type: boolean
Default: false

PostgresPool#

The PostgresPool section contains configuration properties which control the location of and how RStudio Package Manager interacts with a special postgres connection pool that is used for the following special purposes:

• Persistent Storage - When configured to use PostgreSQL for persistent storage (caching, etc.), the PostgreSQL Pool will be used for interactions with Postgres Large Object storage.
• Notifications - An RStudio Package Manager cluster uses PostgreSQL NOTIFY/LISTEN messaging to support intra-node communication. The PostgreSQL Pool will be used for this feature.

These properties must appear after [PostgresPool] in the configuration file.

PostgresPool Settings#

MaxOpenConnections#

The maximum number of open connections to the Postgres connection pool. This needs to be either greater than or equal to 10, or 0 for unlimited open connections.

Type: integer
Default: 10

Proxy#

The Proxy section contains configuration properties which allow the RStudio Package Manager to use an outbound proxy server. The URL configured here will be used for all HTTP requests and HTTPS requests.

; /etc/rstudio-pm/rstudio-pm.gcfg

[Proxy]
URL = 127.0.0.1:80

These properties must appear after [Proxy] in the configuration file.

Proxy Settings#

URL#

Set the proxy URL for outbound traffic. May be either a complete URL or a host[:port], in which case the http scheme is assumed.

Type: string
Default: <empty-string>

User#

The user to be used in a Proxy-Authorization HTTP(S) header.

Type: string
Default: <empty-string>

Password#

The encrypted password to be used in a Proxy-Authorization HTTP(S) header.

Type: encrypted-string
Default: <empty-string>

Storage#

The Storage configuration section contains properties that control whether variable data should be stored on a local filesystem or S3. You can configure the storage destination for eight classes of data. By default, each storage class defaults to file, but you can configure any storage class for S3.

; /etc/rstudio-pm/rstudio-pm.gcfg

[Storage]
; Each class defaults to `file`
; Cache = file
; Launcher = file
;
; You can override the destination to use S3
Metrics = s3
Packages = s3
CRAN = s3
Bioconductor = s3
Binaries = s3
PyPI = s3

Storage Settings#

Default#

Storage default for all storage classes unless otherwise overridden. Must be either file or S3.

Type: string
Default: file

Cache#

Storage location for the cache. Must be either file or S3.

Type: string
Default: file

Packages#

Storage location for packages. Must be either file or S3.

Type: string
Default: file

CRAN#

Storage location for CRAN packages. Must be either file or S3.

Type: string
Default: file

Bioconductor#

Storage location for Bioconductor packages. Must be either file or S3.

Type: string
Default: file

PyPI#

Storage location for PyPI packages. Must be either file or S3.

Type: string
Default: file

Binaries#

Storage location for binaries. Must be either file or S3.

Type: string
Default: file

Metrics#

Storage location for usage metrics aggregation. Must be either file or S3.

Type: string
Default: file

Launcher#

Storage location for job launcher logs. Must be either file or S3.

Type: string
Default: file

StorageAudit#

The StorageAudit section allows you to configure auditing which can be exported using the metrics endpoint. This can also be used in combination with the StorageAlerts section to enable alerts based on usage thresholds.

StorageAudit is enabled by default, but may be disabled if you do not require this functionality.

StorageAudit Settings#

CacheTimeout#

The minimum time between querying for filesystem usage. For large filesystems this can be a time-consuming operation.

Type: duration
Default: 30m

Enabled#

Enable storage auditing. This will periodically check and report on system usage.

Type: boolean
Default: true

StorageAlerts#

The StorageAlerts section allows customizable alerting thresholds based on a fixed size or a percentage basis. Use [StorageAlerts] to set default values or use FileStorage classes to override a specific storage location. For example, [StorageAlerts "cran"]

Alerting is enabled by default, but it can be customized or disabled completely depending on your needs. Alerting is currently supported only for FileStorage classes.

The alerting process will recursively check the free and used size of the disk on which the specified directory is mounted. For example, if your FileStorage is configured as follows, the alerting process will scan the disk on which /path/to/cran resides and report on the results.

; /etc/rstudio-pm/rstudio-pm.gcfg

[FileStorage "cran"]
Location = /path/to/cran

[StorageAlerts "cran"]
Threshold = 10%

All options are as follows.

; /etc/rstudio-pm/rstudio-pm.gcfg

[StorageAlerts]
; Enable UI alerts of type 'raw', 'safe', 'name' or disable with 'none'
; UIMessageType = safe
;
; Set a default for each underlying storage class.
; Can be a fixed size such as "10GB" or a percent like "90%"
; Disable by using 0, 0GB, 0% or not setting.
;
; The default alert threshold is 75%
; Threshold = 75%
;
; Optionally specify thresholds for individual FileStorage classes.
; These function as overrides for the default. Disable using
; one of the "0" values like above.
;
; [StorageAlerts "cache"]
; Threshold = 10GB
;
; [StorageAlerts "cran"]
; Threshold = 10%
;
; [StorageAlerts "packages"]
; Threshold = 0

StorageAlerts Settings#

Threshold#

The default threshold to alert for any storage class. May be either a percentage or a size. Must end with a '%' or a size 'GB'. For example 90% or 200GB. Leave empty to disable. Can be overridden for class-specific thresholds.

Type: string
Default: 75%

UIMessageType#

The type of message to present to the RStudio Package Manager Web UI. Must be one of 'raw' (the full message with details), 'safe' (a message without specific filesystem paths or threshold amounts), 'name' (the name of the filesystem storage class only) or 'none' (hidden from the UI). This setting cannot be overridden by class-specific configuration. Note, the server log will always contain the raw alert value.

Type: string
Default: name

FileStorage#

The FileStorage section contains configuration properties which control where files are stored. You can configure a FileStorage section for any of eight classes of data:

• binaries
• bioconductor
• cache
• cran
• launcher
• metrics
• packages
• pypi

If you wish to change the base storage location for all RStudio Package Manager data, please use the Server.DataDir property instead. Use a FileStorage configuration section only when you wish to change the storage location for a particular class of data.

For example, to configure a custom storage location for the cache, you would create the following configuration section:

; /etc/rstudio-pm/rstudio-pm.gcfg

[FileStorage "cache"]
Location = /path/to/cache

FileStorage Settings#

Location#

The directory to use for this storage class.

Type: string
Default: {Server.DataDir}/{StorageClass}

S3Storage#

The S3Storage section contains configuration properties which control where files are stored on S3. You can configure an S3Storage section for any of eight classes of data:

• binaries
• bioconductor
• cache
• cran
• launcher
• metrics
• packages
• pypi

If you wish to use S3 for all variable data classes, please use a generic S3Storage configuration section. You can then override the generic settings for any storage class as necessary. For example:

; /etc/rstudio-pm/rstudio-pm.gcfg

[Storage]
Default = s3

; Default S3 settings. This is the minimum-required setting for using S3.
[S3Storage]
Bucket = your-s3-bucket

; Override default S3 settings for the "packages" class. This demonstrates
; all the available S3 configuration settings.
[S3Storage "packages"]
Bucket = another-s3-bucket
Prefix = rspm-packages
Profile = dev-rspm
Region = us-west-1
EnableSharedConfig = true

Alternatively, you can specifiy each variable data class separately:

; /etc/rstudio-pm/rstudio-pm.gcfg

[Storage]
Cache = s3
Launcher = s3
Metrics = s3
Packages = s3
CRAN = s3
Bioconductor = s3
Binaries = s3
PyPI = s3

[S3Storage]
Bucket = your-s3-bucket

S3Storage Settings#

Bucket#

S3 bucket to use. Required.

Type: string
Default: <empty-string>

Prefix#

Prefix to prepend to item address. This is useful for organizing a shared S3 bucket. Optional.

Type: string
Default: {StorageClass}

Profile#

AWS Profile to use. This can also be defined through environment variables, the shared credentials file, or through the shared configuration file (if SharedConfig is enabled). Optional.

Type: string
Default: <empty-string>

Region#

AWS Region to use. This can also be defined through environment variables, the shared credentials file, or through the shared configuration file (if SharedConfig is enabled).

Type: string
Default: <empty-string>

EnableSharedConfig#

Overrides the AWS_SDK_LOAD_CONFIG env var value and enables the shared config functionality. Optional

Type: boolean
Default: false

EvictionPolicy#

Eviction policies can be used to keep server disk usage to a minimum. The Server.EvictedStorageClasses setting enables general eviction, however the EvictionPolicy section allows custom control of the objects in each class. You can configure a default EvictionPolicy section to control the lifetime of every cache object, or create custom EvictionPolicy sections for six classes of data if you need fine-grained control:

• binaries
• bioconductor
• cache
• cran
• metrics
• pypi

The Server.EvictionInterval and Server.EvictionSweepSchedule settings in the Server Configuration control when evictions occur. These two settings correspond to the two types of evictions:

Normal Eviction

• Runs at intervals defined by Server.EvictionInterval, and removes any assets in storage that have a last recorded access time that is older than the MaxAge setting for the storage class. The last recorded access times are stored in the RSPM database and managed by the RSPM service.

Sweep Eviction

• Removes orphaned items by enumerating all assets in persistent storage and deleting any for which we have no corresponding database record. A "sweep" eviction is more time consuming, and it runs on the schedule defined by Server.EvictionSweepSchedule.

Example:

; /etc/rstudio-pm/rstudio-pm.gcfg

[Server]
EvictedStorageClasses = "cache, metrics, cran, binaries"
EvictionInterval = 1h
EvictionSweepSchedule = "30 2 * * *"

; Defaults
[EvictionPolicy]
MaxAge = 720h

; Override for a specific persistent storage class
[EvictionPolicy "binaries"]
MaxAge = 300h

EvictionPolicy Settings#

MaxAge#

The duration of no access after which a file from a persistent class is considered stale.

Type: duration
Default: 720h

Exceptions#

A regular expression whose matches will not be evicted from persistent storage unless orphaned. To ignore default exceptions and use no exceptions for a particular storage class, use the string none.

Type: multi-string
Default: unspecified

Migration#

The Migration section contains configuration properties that control the migrations that occur upon upgrading to a new RStudio Package Manager version.

Migration Settings#

EnableMixedClassMigration#

Enables migration of CRAN packages to another storage class.

Type: boolean
Default: false

Swagger#

The Swagger section contains configuration properties that control the Server API documentation page served by the server.

Swagger Settings#

Enabled#

If true, enables serving the Swagger Server API Guide over the API.

Type: boolean
Default: false

Host#

Override the default value ([Server].Address) Swagger uses for the host value.

Type: string
Default: <empty-string>

HTTP#

Controls displaying the HTTP schema option on the Server API Guide page. Does not change any server options.

Type: boolean
Default: false

HTTPS#

Controls displaying the HTTPS schema option on the Server API Guide page. Does not change any server options.

Type: boolean
Default: false

Debug#

The Debug section contains configuration properties that control the logging behavior of the server.

Log

A space-separated list of log regions to enable. Note that log regions may be temporarily enabled or disabled using the rspm config debug logger activate command. To show the list of all available log regions, call rspm config debug logger show.

Type: string

Default: <empty string>

Reloadable: true

Debug Settings#

Log#

A space-separated list of log sources to collect from. Set to verbose to enable debug logging in all regions of the application.

Type: string
Default: <empty-string>

ReadTimeout#

The read timeout for the RSPM HTTP(s) debug server. Note that this is also used as the idle timeout.

Type: duration
Default: 1m

WriteTimeout#

The write timeout for the RSPM HTTP(s) debug server.

Type: duration
Default: 5m