This guide walks you through the basics of getting started with Viscosity on your Mac. It covers how to install and open Viscosity, how to create or import your first VPN connection, and where to find the main controls and settings once Viscosity is running.

Installing & Running Viscosity

Before you can use Viscosity it must first be installed using the instructions below. You must have administration rights on your computer to be able to install Viscosity.

Installing Viscosity

1. Open the Viscosity.dmg file (usually located in your Downloads folder) by double-clicking it.
2. Drag Viscosity to your Applications folder.

3. Eject the Viscosity disk image.

   
   
   

Running Viscosity

Viscosity can be launched by double-clicking on its icon in your Applications folder. You can also launch Viscosity using Spotlight by searching for Viscosity.

By default Viscosity won't appear as an icon in the Dock when it is running. Instead it will add an icon to the menu bar, which can be used to control Viscosity.

Your VPN Provider

Viscosity allows you to connect to any VPN server that supports the OpenVPN protocol. Your VPN Provider is the person or company who runs the server you wish to connect to (the other end of the connection).

Typically your VPN provider falls into one of the following categories:

• Workplace: Your workplace may provide a VPN server so you can remotely and securely access the work network and Internet. In most cases the person to contact for more information or connection details would be your IT/System Administrator.

• Personal: If you are familiar with VPNs you may have set up your own OpenVPN server so you can access your home network, and/or to have the same benefits as using a VPN Service. If you're interested in running your own server please see Introduction to Running an OpenVPN Server.

• VPN Service: Many third party companies specialize in offering VPN services to users. There are a number of reasons why you may want to subscribe to a VPN Service, including protecting your privacy and security while on public networks, accessing location restricted websites, and accessing blocked content. Most VPN Service providers provide a webpage or support site where you can obtain connection details.

Some workplaces and VPN Service providers may provide special bundled versions of Viscosity that already contain all of your connections, allowing you to skip the steps below. You may like to check with your VPN Provider to see if they offer this.

Creating Your First Connection

You can create a connection in Viscosity by manually configuring a connection, or by importing a connection from a bundle or OpenVPN configuration file.

Importing A Connection

You can import a connection into Viscosity by double clicking on a Viscosity connection bundle or OpenVPN configuration file, or by following the steps below:

Step 1

Open Viscosity, go to the Viscosity menu and select Settings…. The Settings window should appear.

Step 2

Make sure the Connections toolbar item is selected, and then click the + button in the bottom-left corner of the window. Select Import Connection then From File... from the menu that appears.

Step 3

Select the connection bundle (.visc or .visz) or OpenVPN configuration file (.ovpn or .conf) supplied by your server administrator. Click the Open button.

Step 4

Your connection will now appear in the Viscosity menu. To connect, select your connection from the menu. The menu icon will update to let you know when your new connection has connected.

Manually Creating A Connection

You can manually create a new connection in Viscosity using the instructions below. You'll need to obtain the necessary settings and any certificates/keys from your VPN provider.

Step 1

Open Viscosity, go to the Viscosity menu and select Settings…. The Settings window should appear.

Step 2

Make sure the Connections toolbar item is selected, and then click the + button in the bottom-left corner of the window. Select New Connection from the menu that appears.

Step 3

Give your connection a name, which can be anything you want. In the Address field enter the address of the OpenVPN server. Change the port if the server doesn’t use the default value. Select the protocol and device that matches the OpenVPN server’s settings.

Step 4

Click on the Authentication tab. From the Authentication Type menu select the authentication type your OpenVPN server requires. Different options will be displayed depending on the type. To use multiple authentication types, simply select each type in turn from the menu and configure it. Most fields require you to select a certificate or key file. Your server administrator should have provided you with these if required. To specify a file, click the Select… button, locate the file, and click Open.

Step 5

Use the tab bar to configure the remaining sections (Options, Networking, Transport, and Advanced) as required. In most cases the default settings will work. If your server requires you to enter a username and password to connect, make sure you tick the Use Username/Password Authentication checkbox under the Options tab. Click the Save button when finished.

Step 6

Your connection will now appear in the Viscosity menu. To connect, select your connection from the menu. The menu icon will update to let you know when your new connection has connected.

Using Viscosity

The following sections provide a brief overview of Viscosity's interface and options.

The Viscosity Menu

The Viscosity menu is the main way of interacting with Viscosity and your connections. The Viscosity menu can be found at the top-right corner of your screen (near the clock). Clicking on the icon once will bring up the menu.

The Viscosity menu allows you to connect or disconnect a connection by selecting it from the menu, open Viscosity's Settings window, open Viscosity's Details window, and to quit Viscosity. Your connections will be automatically disconnected when Viscosity quits.

Please note that by default Viscosity does not appear in the dock.

The Details Window

The Details window allows you to monitor your VPN connections. If you wish to check the status of a connection, experience trouble connecting, you should first check the details window for information. The Details window has three main sections, as outlined below. You can switch between these sections by clicking on the relevant buttons near the middle of the window.

• Traffic Graph: The traffic graph will graph network traffic for the last 60 seconds. It will automatically scale to match the maximum traffic rate. The vertical axis on the left will list the range of data rates, while the In/Out values list the current data rate of traffic passing through the VPN connection.

• Traffic: The traffic section lists total data amounts that have passed through the VPN network adapter. These values are reset each time the connection is re-established.

• Log: The log section displays the OpenVPN log output. The log will contain important information if you are having trouble connecting.

The Settings Window

Viscosity's Settings window allows you to access and edit your VPN connections, as well as change Viscosity's overall settings. The toolbar at the top of the window can be used to navigate between the following sections.

• Connections: The Connections area allows you to manage your VPN connections. Use the + button to add new connections, the - button to remove a selected connection, and the Edit button to edit a selected connection.

• General: The General area allows you to modify general global settings, including automatic update settings.

• Appearance: The Appearance area allows you to change the look and feel of Viscosity, including the menu bar icons and the behaviour of the Details window.

• Advanced: Settings in the Advanced area should only be changed by advanced users. This area allows you to change the OpenVPN version Viscosity uses, as well as options to aid troubleshooting.

For full information regarding the options available please see the Using Viscosity and Connection Settings articles.