For organizations wanting to align RStudio Connect to their branding strategy, this chapter provides context for the many optional configuration settings that can be used to achieve customizations to the default product branding and user experience.
Branding Configuration Settings#
Branding section of the configuration file allows you to remove elements of RStudio's brand from Connect and replace it with your own. These settings include the ability to change the logo, favicon, and display name used throughout the platform.
Branding.Enabled(Default: disabled) When enabled, RStudio Connect makes use of any
Brandingsettings and display "Powered by RStudio Connect" when applicable.
Branding.Logo(Default: none) Specify an image file path to use as the logo.
Branding.Favicon(Default: none) Specify an image file path to use as the favicon.
Branding.DisplayName(Default: "RStudio Connect") Provide a name to be used in place of "RStudio Connect" in product messages and emails. This does not extend to the removal of RStudio copyright information throughout the product.
Branding configuration example might look like this:
; /etc/rstudio-connect/rstudio-connect.gcfg [Branding] Enabled = true Logo = /path/to/logo.png Favicon = /path/to/favicon.ico DisplayName = "SuperPowers Inc."
An example of how the
DisplayName is used across product messages and emails can be seen in the password reset request workflow shown here:
DisplayName customization is also used in product dialog messages such as on log in, user role upgrade requests, content permission requests, publishing content with Git, jump start publishing instructions, content configuration settings labels, and more.
Server Configuration Settings#
Server section of the configuration file provides settings for things such as: custom landing pages for logged-out and logged-in users, the ability to restrict components and functions from viewers, and email customization features. These settings can be added to your default
Server configuration, as represented in the example found at the end of this section.
Custom Landing Pages#
Server.LandingDir (Default: none) Specifies an optional path from which a customized landing page is served to logged-out users. Learn more about how to customize the logged-out user landing page experience here.
Combine this feature with
Branding.DisplayName to ensure that the navigation bar displays your own logo and users are prompted to log in to the platform name you've specified.
Upon logging in, users are routed to the RStudio Connect content dashboard. To specify an alternate landing page,
RootRedirect can be used to divert users to a URL other than the standard RStudio Connect dashboard.
One option for creating a custom landing page is to make a content showcase with the
connectwidgets R package.
connectwidgets can be used to query an RStudio Connect server for your existing content items, then organize, subset, and style them with
htmlwidgets components in an R Markdown document or Shiny application.
connectwidgets provides links to content items that open in "Solo Mode". This provides a level of separation between viewers and the content dashboard and management tools that are more relevant to publishers and administrators. Additional information can be found in the RStudio Connect User Guide.
RootRedirect URL is set, it will be important to notify publishers and other administrators about where they can access the content dashboard view of RStudio Connect. This URL can also be customized with the
Server.Dashboardpath) The URL logged-in users will be redirected to when visiting the public URL used to access the server.
Server.DashboardPath(Default: "/connect") The URL path name to be used where RStudio Connect's dashboard is hosted.
If you plan to have viewers visit and interact with the content dashboard, there are a few
Server setting configurations that can be used to restrict a user's actions:
Server.HideViewerDocumentation(Default: disabled) When enabled, the Documentation menu item in the dashboard is hidden from viewers.
Server.ViewerKiosk(Default: disabled) When enabled, RStudio Connect does not prompt view-only users to request elevated privileges when attempting to access restricted resources.
Additional viewer restrictions are available through
Authorization settings described below.
Server.EmailSubjectPrefix(Default: "[RStudioConnect]") A leading subject prefix for all mail sent by RStudio Connect.
Server.SenderEmailDisplayName(Default: "RStudio Connect") The display name to use when sending outbound email.
Server.EmailFromUserAddresses(Default: Disabled) Controls the
Senderemail message fields. When enabled, user email addresses are used as the From message field and
Server.SenderEmailis the Sender field.
Some email providers do not support sending messages on behalf of other users.
Server.EmailFromUserAddressses cannot be customized in that case.
This setting may require additional configuration steps from your email server administrator. An example configuration for using Google Workspace as the SMTP provider can be found here.
Combine these settings with
Branding.DisplayName to ensure that system emails display your own logo and platform name:
Learn more about email customization options here.
Example Server Configuration#
; /etc/rstudio-connect/rstudio-connect.gcfg [Server] Address = https://super-powers.example.org/ RootRedirect = /landing-page DashboardPath = /dashboard LandingDir = /path/to/dir EmailProvider = SMTP SenderEmail = email@example.com EmailTo = firstname.lastname@example.org EmailSubjectPrefix = [Super Data Team] SenderEmailDisplayName = "Super Data Team" HideViewerDocumentation = true ViewerKiosk = true
To control aspects of what users are allowed to see and do within RStudio Connect, there are several
Authorization settings available. The most common authorization configuration to pair with custom branding is user masking. RStudio Connect provides a setting to prevent viewers from seeing any other users (names, emails, etc.) on the server. This setting does not apply to publishers or administrators.
Authorization.ViewersCanOnlySeeThemselves(Default: disabled) By default, viewers can see all users available in RStudio Connect. Enable this setting to prevent viewers from seeing any users other than themselves.
An example of the setting enabled:
; /etc/rstudio-connect/rstudio-connect.gcfg [Authorization] ViewersCanOnlySeeThemselves = true
The full set of Authorization settings can be reviewed in the Configuration Appendix.