User Guide

From UntangleWiki
Jump to: navigation, search

The Untangle User Guide


Getting Started

If you have not already installed Untangle, read the Installation Guide.


The Administration Interface

The Administration Interface is the main interface used to configure Untangle.

A registration and welcome message is displayed upon the first visit to the administration interface. It will make a suggestion about the suggested applications that may be useful for your network. You can choose to install the recommended apps or to install the apps manually.

Untangle's web GUI with trial applications installed

There are four main tabs in the administration interface.

  1. Dashboard
  2. Apps
  3. Config
  4. Reports (only visible if the Reports app is installed.)

Tip: Using Mozilla Firefox or Google Chrome browsers is recommended for administration.

Dashboard

The Dashboard provides an overview of the state of at a glance. It is extremely useful for quickly viewing or monitoring what is happening on the network and the current status of the Untangle server.

An example dashboard

By default the dashboard will several widgets which show varying information. However, the dashboard is completely customizable. Widgets can be removed and added so the administrator sees exactly the information that is important to them on the dashboard.

There are many different type of widgets available:

Name Information
Information Shows some information about Untangle, like name, model, version, etc.
Resources Shows an overview current memory swap and disk usage.
CPU Load Shows a graph of recent CPU load.
Network Information Shows an overview of the network information like session count and device/host count.
Network Layout Shows an overview of the network layout based on the interface configuration.
Map Distribution Shows the current sessions mapped geolocation on a world map, sized by throughput.
Report Shows any Report Entry from Reports

To change what is displayed on the dashboard click on Manage Widgets at the top. From here you can show or hide the built-in widgets, or add new widgets from Reports by clicking on the Add button.

When adding a Report widget, you must also specify a timeframe (the number of hours worth of data to display) and a refresh interval (how often the widget refreshes on the dashboard).

When viewing a Report Entry in Reports you can also easily add it to your dashboard by clicking on the Add to Dashboard button.

If you see an alert icon near the top of the dashboard, hover over it for more information - these are Administrative Alerts designed to help you keep your Untangle healthy.

Applications

Applications are little plugins that add functionality to your Untangle server - just like "apps" on an iPhone or Android device.

On the Apps tab you'll see the currently installed apps. Across the top there is a dropdown menu to switch to different Policies. Policies can be controlled via the Policy Manager app.

The default Apps view of the "Default" skin
The Apps view of the responsive "Simple Grey" skin

Apps can be installed by clicking the "Install Apps" button at the top. It will display the apps that can currently be installed. To install an app simply click on its icon. You can install as many apps at the same time as you like. After starting the installation of the desired apps you can click the "Done" button at the top to go back to the apps view.

Once installed the applications' settings can be configured by clicking on the Settings button or the icon of app, depending on the skin. Applications install with the suggested configuration which is the default settings and on/enabled in most cases. An application that is off/disabled will not process any network traffic. To enable a disabled application edit the settings and click "Enable" on the first tab inside the settings.

After clicking Settings, you will be presented with tabs for different settings sections, as well as typical buttons marked OK, Cancel and Apply. Apply saves any changes. OK saves any changes and closes the window. Cancel closes the window without saving settings. On the left hand side there is a Remove button which will remove the application from the current policy. The Help button will open the help for the tab currently being viewed.

Untangle has two types of Applications:

  • Filter Applications All the Applications above the Services pane in the interface can have one instance per policy.
  • Service Applications All the Applications below the Services pane are global and exist in all virtual racks.

Many networks only need one policy which means all traffic gets processed by the same apps and same configuration, but multiple policies (sometimes called "racks") are possible for bigger networks. For more information about running multiple racks check out the Policy Manager application.

To learn more about each application use the links below.

Filter Applications

 
WebFilter 42x42.png WebFilterLite 42x42.png VirusBlocker 42x42.png VirusBlockerLite 42x42.png SpamBlocker 42x42.png SpamBlockerLite 42x42.png
Web Filter Web Filter Lite Virus Blocker Virus Blocker Lite Spam Blocker Spam Blocker Lite
 
PhishBlocker 42x42.png WebCache 42x42.png BandwidthControl 42x42.png ApplicationControl 42x42.png ApplicationControlLite 42x42.png SSLInspector 42x42.png
Phish Blocker Web Cache Bandwidth Control Application Control Application Control Lite SSL Inspector
 
CaptivePortal 42x42.png Firewall 42x42.png IntrusionPrevention 42x42.png AdBlocker 42x42.png
Captive Portal Firewall Intrusion Prevention Ad Blocker

Service Applications

 
Reports 42x42.png PolicyManager 42x42.png DirectoryConnector 42x42.png WANFailover 42x42.png WANBalancer 42x42.png
Reports Policy
Manager
Directory
Connector
WAN
Failover
WAN
Balancer
 
CaptivePortal 42x42.png IPsecVPN 42x42.png OpenVPN 42x42.png ConfigurationBackup 42x42.png BrandingManager 42x42.png
Captive
Portal
IPsec
VPN
OpenVPN Configuration
Backup
Branding
Manager
 
LiveSupport 42x42.png
Live
Support

Config

The config tab holds all the settings related to configuration of the Untangle server itself and settings for components of the platform that apps may interact with.

This is an list of all sections available under the Config tab in the Administration UI.

Network

The Network configuration contains all the settings to control how your Untangle server routes and handles network traffic. Properly configuring network settings is critical for proper operation.

The Network Configuration documentation documents how networking in Untangle functions and is commonly configured.

Administration

Administration controls the administration-related functionality of the Untangle server.

Email

Email contains all the email-related configuration of the Untangle server.

Local Directory

Local Directory stores a list of users that can be used by the applications.

Upgrade

Upgrade allows the server to upgrade and contains upgrade-related settings

System

System contains settings related to the server

About

About contains system information

Reports

The reports tab is only visible if the Reports app is currently installed. To read more about reports view the reports documentation.