Skip to content

Basic Authentication

Basic Authentication is useful when a static list—or range—of IP addresses required by other methods of site restriction are not available. Common uses for Basic Authentication are for restricting access to non-production environments, or to production environments that are not yet launched and still under development.

Enabling Basic Authentication on an environment will restrict public traffic from accessing all sites hosted on the environment. All requests to access a site on the environment will trigger a Basic Authentication login portal in the browser. Valid Basic Authentication login credentials that were configured in the VIP Dashboard must be submitted in order to access the site.

Prerequisites

  • To view an environment’s Basic Authentication list, a user must have at minimum an Org guest role or an App read role for that application.
  • To edit an environment’s Basic Authentication list, a user must have at minimum an Org admin role or an App admin role for that application.

Limitations

Note

The Basic Authentication and IP Allow List access restriction methods cannot both be active at the same time. If both are activated, Basic Authentication will take precedence.

Types of requests restricted by Basic Authentication

Once enabled, the following request types will be blocked for users not logged in with Basic Authentication credentials:

  • requests from logged in and anonymous users
  • for static files, media files, and dynamically generated content
  • for a WordPress or a Node.js application
  • both cached and uncached requests

When enabled, Basic Authentication will also block content from Jetpack’s content distribution tools. To modify this behavior, review available options to Control Content Distribution via Jetpack.

Enable Basic Authentication

Basic Authentication is enabled by providing one or more users with log in credentials in the VIP Dashboard. Basic Authentication will remain enabled until all users have been removed from the Basic Authentication user list.

All sites that exist on a WordPress multisite environment with Basic Authentication enabled will share the same applied access restrictions and user log in credentials.

Changes made to Basic Authentication will take up to 10 minutes to apply to the environment.

  1. Navigate to the VIP Dashboard.
  2. Select an environment to which the settings will apply from the environment dropdown located at the upper left of the VIP Dashboard.
  3. Select “Access & Routing” from the sidebar navigation at the left of the screen.
  4. Select Basic Authentication from the submenu.
  5. Select the “+ Add User” button located in the upper right of the panel.
  6. Provide a Username and a Password for the new user in the “Add a User” form fields.
    The password entered will be encrypted when stored.
  7. Select “Confirm“.
Screenshot of the settings panel for adding a new user to the Basic Authentication access list

Remove Basic Authentication user access

Removing a user from the Basic Authentication panel will remove their access to the site as long as Basic Authentication is enabled.

Basic Authentication is disabled by removing all users from the settings panel.

Changes made to Basic Authentication will take up to 10 minutes to apply to the environment.

  1. Navigate to the VIP Dashboard.
  2. Select an environment to which the settings will apply from the environment dropdown located at the upper left of the VIP Dashboard.
  3. Select “Access & Routing” from the sidebar navigation at the left of the screen.
  4. Select Basic Authentication from the submenu.
  5. Select the button labeled “Remove” located to the right of an existing user.
  6. Select “Confirm“.
Screenshot of the Basic Authentication panel in the VIP Dashboard

Last updated: January 26, 2024

Relevant to

  • Node.js
  • WordPress