Skip to main content

Branding and Experience Customizations

Overview

The default Posit Connect product branding and user experience can be customized, letting organizations align Posit Connect to their branding strategy.

Branding configuration settings

Enhanced Advanced

The Branding section of the configuration file allows you to remove elements of the Posit 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, Posit Connect makes use of any Branding settings and display “Powered by Posit 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: “Posit Connect”) Provide a name to be used in place of “Posit Connect” in product messages and emails. This does not extend to the removal of Posit copyright information throughout the product.

Example of Posit Connect Dashboard Customization, showing locations of favicon, display name, and logo usage.

A 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:

Example of Branding Customization in the Password Reset Request Workflow, showing display name usage.

The 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, content configuration settings labels, and more.

Server configuration settings

The 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

Logged-out users

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.

Note

Combine this feature with Branding.Enabled, Branding.Logo, and 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.

Logged-in users

Upon logging in, users are routed to the Posit Connect content dashboard. To specify an alternate landing page, RootRedirect can be used to divert users to a URL other than the standard Posit Connect dashboard.

One option for a custom landing page is the Custom Landing Page item in the Connect Gallery. It is an example Shiny app that organizes content by tags and lists only the content that each viewer can access, and a starting point for a landing page organized however you choose. The Quarto: Content Hub Gallery item is a static alternative that lists the content its publisher can see. Both give viewers a way to find content without using the content dashboard and management tools, which are more relevant to publishers and administrators. For more information, see Curating Content in the User Guide.

Once the RootRedirect URL is set, it will be important to notify publishers and other administrators about where they can access the content dashboard view of Posit Connect. This URL can also be customized with the DashboardPath setting.

Note

When using a curated content page as a Server.RootRedirect, set its sharing setting to All users - login required.

Viewer restrictions

If you plan to have viewers visit and interact with the content dashboard, you can restrict what they see with the Viewer role’s permissions, described below.

Email customization

Note

Some email providers do not support sending messages on behalf of other users. Server.EmailFromUserAddresses 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.Enabled, Branding.Logo, and Branding.DisplayName to ensure that system emails display your own logo and platform name:

Example of Posit Connect Email and Branding Customization, showing email subject prefix, email sender display name, sender email, logo, and branding enabled usages.

Learn more about email customization options here.

Authentication notice customization

NoteLicensing Enhanced Advanced

Branding.DisplayName is only available to some licenses.

  • Branding.DisplayName (Default: “Posit Connect”) Name used in product messages and emails.

  • The sign-in, sign-up, and account-completion pages show the Authentication Notice custom message. Manage it on System > Custom Messaging, as described in Custom messaging. SAML and proxied authentication have no Connect sign-in page, so the notice does not appear for them.

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 = superpowers@example.org
EmailTo = no-reply@example.org
EmailSubjectPrefix = [Super Data Team]
SenderEmailDisplayName = "Super Data Team"

Viewer role permissions

To control what viewers can see and do within Posit Connect, revoke permissions from the Viewer role on the People > Roles page. See Customizing user roles. These restrictions apply only to viewers. The Administrator role’s permissions cannot be changed, so administrators keep every permission. To also hide other users’ email addresses from publishers, revoke users:read-email from the Publisher role after you revoke it from the Viewer role.

  • Revoke users:read and groups:read to prevent viewers from seeing any users other than themselves, or groups they don’t belong to.
  • Revoke users:read-email to hide other users’ email addresses from viewers.
  • Revoke documentation:read to hide the Documentation page in the dashboard, and the server’s custom documentation, from viewers.
  • Revoke roles:request to stop prompting viewers to request an account role upgrade or content access when they try to access restricted resources.

The full set of Authorization settings can be reviewed in the Configuration Appendix.