Access Server

Follow us

Change the logo on the web server interfaces

This tutorial will show you how to rebrand the web interface so it has your company logo instead of the default OpenVPN Technologies Inc. logo, like so:

Please note: this tutorial was written based on OpenVPN Access Server 1.8.3

In order to do this you will need a tool such as WinSCP to copy files to the Access Server and to edit text files on the server. You will have to use a username and password that has console or SSH root access to the server. In this guide we will assume the OpenVPN Access Server can be reached via SSH on IP address and we will be logging in as root using WinSCP in SCP mode. We will also be using PuTTY to issue a command on the Command Line Interface to restart the OpenVPN Access Server. While you issue this command, obviously all VPN clients will be momentarily disconnected.

Regarding the logo file itself; it can be in just about any format you like. It can be huge, it can be small, it can be JPEG, PNG, GIF, BMP, who cares. But we do have a few pointers for you that will help you make the best out of it. First of all, the width is going to be a limiting factor since it tends to go outside of its boundaries when the width is over about 345 pixels. The picture doesn't center, it just aligns left and spreads out to the right. This can be ugly. Height is not so much an issue - it will just push the login field down a bit if you need more space. I kept it at 90 pixels and that looked fine. Since the client interface and the admin interface will both be using this picture, and they don't have exactly the same background colors, you will probably want to make it a .PNG file with a transparent background.

In short: make the picture a PNG file with 345 pixels width and 90 pixels height and transparent background.

Start WinSCP, click ‘Session’, enter the IP address of your server, the username and password, select SCP and click ‘Login’.

Once connected, click on the ‘Open folder’ icon and open: /usr/local/openvpn_as/

Find the .PNG logo file you want to use on your hard drive (left panel) and drag it to the server (right panel).

Please ensure that the filename contains no foreign characters and no spaces. Make the filename as SIMPLE as possible!

Verify that your logo file is on the server (should be listed in the right panel) and doubleclick 'etc'.

Rightclick on 'as.conf' and select 'edit'. A text editor will now load.

Scroll down a bit until you find 'sa.company_name='. You will need to make changes here.

Fill in a descriptive name for your server after 'sa.company_name=' and add the line: 'sa.logo_image_file=/usr/local/openvpn_as/companylogo.png'.

Close the text editor and answer 'Yes' to confirm saving the changes.

Start PuTTY and connect to the IP address of your server on port 22, SSH, and click ‘Open’.

Enter the server’s username and password. It must have root access. This is not a VPN client username!

Execute command: /etc/init.d/openvpnas restart

Please note that the descriptive name entered after "sa.company_name" is only visible in the admin web UI. You could use this as an identifier so you can quickly see which server it is you have accessed and where it is located, for example. And if you REALLY want text in the client interface, why don't you just edit it into the logo picture itself - that's a fairly easy solution. The result for the client web UI and the admin web UI looks like so:

Troubleshooting: now I can't reach my server's web UI at all!

This happens when there is a mistake in the file name or path in as.conf's directive for the company image logo. This is why we advise people to use as plain a filename as possible and to follow the guide closely so you get it right. You can easily undo the damage by either removing the two offending lines from as.conf and issuing a /etc/init.d/openvpnas restart command again, or you can fix the problem by getting the file path and name exactly right. It also helps if you use a file name that doesn't contain any strange characters such as spaces.