Docs / WPMU DEV Plugins / The Hub Client WPMU DEV

14. The Hub Client WPMU DEV

Written by Katherine Pannell, Patrick & 1 other | Last updated: October 19, 2020

This guide explains how to use The Hub Client plugin to offer better site management to your clients by overseeing plugins, accessing hosting information, scheduling backups, and more from one convenient area.

To use The Hub Client plugin, your site needs to be connected to our Hub in order to access its API. We recommend reading Installing the WPMU DEV Dashboard Plugin for a guide to connecting your site. Already connected? You can now move onto the installation and configuring the plugin.

14.1 White Label Hub Client

Link to chapter 1

The Hub Client ties into our White Label services by allowing you to rebrand the Hub 2.0 as your own. You can fully customize the aesthetic to fit your taste and remove WPMU DEV branding, all through The Hub Client plugin.

14.1.1 Installation

Link to chapter 1

In order to add The Hub Client to your site, it needs to be downloaded from our WPMU DEV plugins page, installed via WPMU DEV Dashboard or you can navigate to The Hub Client page, and click on Find out more about The Hub Client under White label The Hub.

find out more about the hub client

To download the plugin file, click Download.

download button for the hub client

When the file has finished downloading, the plugin can be installed and activated on your desired site. It can even be installed on a domain-mapped subsite in a multisite, so you can truly brand the experience.  See Uploading a New Plugin for a detailed guide to adding a new plugin.

14.1.2 Setup

Link to chapter 1

Once The Hub Client has been activated, you will be met with a welcome page, giving you an overview of the setup procedure and our exciting vision for the future.

the hub client welcome modal

Click Get Started to jump into the setup. You can also tick the Don’t show me this again box if you would like to skip the welcome page next time.

In The Hub Client, you can change the settings to suit your preferences. Before we get into the configuration, just a note that the live preview bar at the top will show you what the top-level menu will look like for your users on the front end.

the hub client preview menu bar

You can also access the technical documents (these documents), for a complete guide to using The Hub Client, by clicking on View documentation.

view documentation button

The plugin settings allow you to adjust the following features:

Site Brand Name and Logo

the hub client brand name and logo

Brand Name

Allows you to display your brand name on your Hub login page. See how to select the Client Page here.

brand name on hub page

Logo

This feature allows you to choose a brand logo to display on the login page and on the top-level Hub menu. Ensure that the logo is less than 1MB and has either a transparent background or a background that matches the Navigation background color.

brand logo on hub page

brand logo in menu

If you change your mind later and want to remove your logo, you can click Remove in the logo module.

remove logo button

Click Remove once again to confirm the removal of your logo or click Cancel to exit without making any changes.

confirm removal of logo

Top-level menu color scheme

color scheme options

Enables you to select a custom background color for the top-level menu. The cursor can be manually dragged to achieve the desired color or you can type in a hex color code. As the color is adjusted, it will change in the live preview bar to give you a better sense of what the final menu will look like.

The navigation text feature controls the color of the text on the top-level menu to best suit your website.

Navigation text selected & hover

This setting allows you to customize the color of the text when an item is selected or when your mouse hovers over an item. If you don’t want the text to change color, you can set the navigation text selected & hover color to the same as the navigation text color.

Configuration

Subsite

(only for WordPress Multisites)

select subsite

If The Hub Client is installed on a multisite, you can select a subsite on which the Hub will appear.

type in subsite to select

Type in the subsite you want to select and click Save changes.

navigation menu settings

Allows you to customize your Hub menu to include other pages that you may want to access easily or advertise. This is done by selecting which menu from your website you wish to add to the top-level menu, which can be customized by adjusting your site menus in Appearance>Menus. Any items from the selected menu will be added to the top-level menu, alongside the default items for the Hub.

navigation items on Hub menu

Client Page

client page setting

The Client Page is the selected page on which you would like The Hub to be displayed. It is also the page that will be used for the login.

By default, a page called hub will be created and will be selected as the Client Page. If you already have a page called hub, the page will take the name hub1 and so forth, numerically increasing. This page will be removed if you deactivate The Hub Client plugin or if you Reset your configuration. If you don’t want to use the default page, you can easily change this by clicking on hub > and selecting a different page on your site.

Terms of Service URL and Privacy Policy URL

tos and pp URL settings

These settings allow you to set your own Terms of Service and Privacy Policy. This can be done by simply clicking Add and linking each URL.

add url for terms of service

Remember to click Save Changes to save your new URL.

Your Terms of Service and Privacy Policy are important for when a new user is added and confirms your invitation. Upon their setup, they will be asked to agree to the Terms of Service and Privacy Policy that you have set. However, the Terms of Service and Privacy Policy checkbox will only appear on your invitations once you have added URLs for both documents.

accept invitation as new user

Reset configuration

To reset your settings to their default values, click Reset.

reset configuration

When asked to confirm the reset, click Reset to proceed with reverting your settings or click Cancel to exit.

14.1.3 Using The Hub

Link to chapter 1

The Hub offers several features to make your life easier and your site management more efficient. In order to make use of these features, a site needs to be added to the Hub. For a detailed description of how to connect a new site to the Hub, read Add a Site to Hub 2.0.

Each site can be controlled through the different modules available. If you would like more information on how to use these modules for a site, we recommend reading Managing a Website in Hub 2.0.

Among many effective site management tools, the Hub also allows you to control domains and DNS records. Detailed guides to managing domains and DNS records can be found at Domains and DNS from the WPMU DEV Technical Documents.

14.1.4 Users & Roles

Link to chapter 1

Users & Roles

user & roles manage button in the hub client

Click Manage to jump to the Users & Roles settings in The Hub.

In The Hub

The Hub is a central site director that allows for delegation to multiple users. These users can be added to the Hub with customized site access, allowing you to distribute site permissions to multiple colleagues or clients.

A Quick Guide

Looking for a comprehensive run-through of how to set up new users? Read our blog on how to Simply Set Up Users & Roles in The Hub for more information.

Depending on whether you are already a present user of the Hub or you are a user who has been added to the Hub under certain permissions, the experience will be different.

Confirmation Email

When you create a new user, they will be required to confirm your invitation and set up their user profile. You will receive a confirmation email if this process has been completed successfully, as a means to inform you that the new user has been added to your team.

Already a present user? Great, the Hub will function as-is for you.

If you are a new user, the accessibility of all the features will be dependent on the permissions given to you by the admin. See Users for more information about Users & Roles in the Hub.

The Hub Client Emails

Just note that the email system for The Hub Client works slightly differently to the Hub 2.0. Typically, when a new user invite has been sent from the Hub 2.0, the email will be sent from [email protected] or [email protected] However, in The Hub Client, the email will be sent from your own WordPress email. 

The DNS feature in the Hub will only be available to users that have that feature enabled for their accessibility. This would include users that have View and Edit roles, which is specified in Roles. In addition, this includes users with custom roles that enable DNS access. If you are unsure about how to manage custom roles, we recommend reading Create a custom user role.

Allowlist Our IPs

If you are experiencing errors when sending out emails to invite your users, it may be due to our IPs not being allowlisted on your site. Specifically for this issue, we recommend adding the WPMU DEV Site IP, found in the WPMU DEV IP Addresses document, to your allowlist. However, in general, it is a good idea to add all of our IPs to your allowlist to ensure that all of our services can communicate with your site smoothly.

In The Hub Client Plugin

Users & Roles can be configured inside The Hub, rather than inside The Hub Client Plugin. If you attempt to access Users & Roles from the plugin side with an older version of The Hub Client, you will be redirected to the Users & Roles settings in The Hub. This is done to protect the safety of your sites that are connected to The Hub, with regards to the user roles that surround gaining access to your connected sites.

Two-Factor Authentication

Users can also enable two-factor authentication for added security.

World-class Security

Two-factor authentication is a great way to create an extra layer of security but it is by no means the only way to improve your site’s safety. Our Defender plugin has been developed to take care of all of your security needs, and Two-factor authentication is just one of Defender’s powerful tools. Visit the Defender plugin page for more information on how you can take your site security to the next level with Defender.

After accepting the invitation, the new user can access the Hub with the permissions granted by the admin. Click on the Account icon in the top right-hand corner to access the dropdown menu. From there, click on Two Factor Authentication to open the authentication configuration module.

set up two factor authentication

Two-factor authentication can now be set up by the user. For more information on this setup process, visit the Two-Factor Authentication documents.

Single Sign-On

If you’re wanting to manage your websites more efficiently without needing to constantly sign into your admin area, Single Sign-on is a gamechanger. This is supported on The Hub Client as well as The Hub. Simply enable Single Sign-on in your WPMU DEV Dashboard plugin Settings to allow Single Sign-on for yourself and the rest of your team.

Visibility for User-Created Sites

What happens if an added user creates a site and connects it to the Hub? If a new site is created by a user, it will not be visible under their My Sites list at first. This is because the user has been granted permissions based on the initial list of sites, which changes when a new site is created. The new site will be visible under the admin’s My Sites section and access to the new site can be given by managing the user’s permissions, as discussed in Managing Existing Users

Once the user’s site permissions have been updated by the admin, the new site will be visible under the user’s My Sites section.

14.1.5 Login

Link to chapter 1

Once you have configured The Hub Client plugin settings, the Hub can be accessed by viewing the selected Client Page on the front end. To select a page where you want the Hub to appear, adjust the plugin settings as specified here.

Enter your WPMU DEV credentials to log into the Hub. Alternatively, you can use your Team user credentials if you are a user added to the Hub by the admin. Tick the Remember me box to skip the login process next time.

hub client login screen

14.2 White Label WPMU DEV Plugins

Link to chapter 2

Our White Label services allow you to remove all WPMU DEV branding so that you can use your own branding or even your client’s branding. This is largely offered as a tool through our WPMU DEV Dashboard Plugin. For a guide to rebranding with the WPMU DEV Dashboard Plugin, read our White Label Plugins document.

The process of white labeling your site is also closely linked to our Branda plugin. Branda simplifies white label branding, maintenance and much more. Read our WPMU DEV documents on Branda to learn more about the plugin’s capabilities.