Skip to main content

Tutorial: How to Change the Branding on the Admin and Client Web UIs

Abstract

Looking to change the logo on the web server interfaces of OpenVPN Access Server? Here's how to do just that.

Overview

It's easy to add branding to your Access Server web interfaces—it takes just a few simple steps. This tutorial walks you through the process.

When you first launch Access Server, your VPN has an Admin Web UI and a Client Web UI, with a default display using our OpenVPN logo. Some customers leave this as is; others prefer to replace it with their company branding. Here’s what you can configure:

  1. The web interface logo.

  2. A name or tag for the admin web interface.

  3. Show or hide the footer.

web-interface-logo.gif
  • An installed Access Server.

  • A file transfer program (WinSCP or SCP, for example).

  • Console access and the ability to get root access.

When your users sign in to the Admin or Client Web UIs, you can display a name or description with the server or instance. For example, you could use it as an identifier to quickly see what server you are logging into.

server-name.png
  1. Sign in to the console and get root privileges.

  2. Open the as.conf file for editing (we use nano):

    nano /usr/local/openvpn_as/etc/as.conf
  3. Locate the sa.company_name and change it to your specific text desired (if it is commented out, make sure you delete the #):

    sa.company_name=OpenVPN Inc.
  4. Save and exit the file.

  5. Restart the Access Server service:

    service openvpnas restart
    • The new text should now display on the Admin and Client Web UI login pages.

Why can’t I reach my web server’s interfaces after these changes?

If you can’t access your Admin or Client Web UI pages online after making these changes, there’s likely a mistake in the file name or path in as.conf.

It helps to use a very simple filename. You can easily back out your changes by removing the two offending lines from as.conf and issuing a service openvpnas restart command again. You can also review the file name and path to ensure accuracy and correct any errors you find. It also helps avoid complicating your filename with characters such as spaces, extra dots, etc. Keep it simple: companylogo.png, for example.

Can I add branding to OpenVPN Connect apps?

Branding options are not present with the OpenVPN Connect apps.

How do I configure the Client Web UI page?

In addition to what you see on the Client Web UI login screen, you can configure what displays for them after they log in. By default, they will see these links for downloading the OpenVPN Connect apps:

  • OpenVPN Connect Windows.

  • OpenVPN Connect macOS

  • Linux (for the community client download)

  • iOS mobile app

  • Android app

You can show or hide these from the CWS Settings page in your Admin Web UI and change additional settings. Refer to the user manual for details.

Tip

You can also configure whether users can change their password from the Client Web UI from Authentication > Settings. Refer to the user manual for details.