tunnelblick icon Tunnelblick free software for OpenVPN on OS X and macOS We need translators for several languages…
Home Downloads Support Documents Issues Source Contribute Contact

Highlighted Articles
  Installing Tunnelblick
  Uninstalling Tunnelblick
  Setting up Configurations
  Using Tunnelblick
  Getting VPN Service
  Common Problems
  Configuring OpenVPN
  Release Notes
  Thanks
  FAQ

Discussion Group
  Read Before You Post

Preferences for version 3.3

On This Page
    Overview
    Preferences in the "VPN Details" Window
    Configuration Settings in the "VPN Details" Window
    Modifying Preferences That are Not in the "VPN Details" window
    Preferences That Control What Tunnelblick Does
    Preferences That Control What The User Sees
    Preferences That Control Updates
    Preferences That are Set by the User in a Check Box
    Per-Configuration Settings
    Preferences That Tunnelblick Uses Internally
    Sparkle Updater Preferences

Overview

Tunnelblick uses preferences to store user-specified settings for the program and for configurations.

Tunnelblick's preferences for a user are stored in ~/Library/Preferences/net.tunnelblick.tunnelblick.plist.

Note: Tunnelblick's settings for each configuration are stored as Mac OS X preferences. This document includes both Tunnelblick preferences and configuration settings.

Note: In Tunnelblick 3.2beta10 and earlier, preferences are stored in ~/Library/Preferences/com.openvpn.tunnelblick.plist.

If Tunnelblick.app contains a Contents/Resources/Deploy/forced-preferences.plist file, then preferences in that file override the corresponding preferences in the com.openvpn.tunnelblick.plist file. This overriding is called "forcing" the preference and such preferences are said to be "forced preferences".

Per-configuration preferences can be applied to all configurations by using "**" as the configuration name (see Per-Configuration Settings). If a configuration has its own preference corresponding to a "**"preferences, the configuration's own preference will override the "**" preference. NOTE: Prior to Tunnelblick 3.4beta10, only forced preferences may contain a "**".

Forced preferences will override normal preferences. See Deploying Tunnelblick for more details about Deployed configurations and forced preferences.

When using a Tunnelblick VPN Configuration, it may contain preferences in its Info.plist. Values of those preferences are used if the user has not specified different values. The use may also change the values after they are loaded from Info.plist.

Note: some preferences are stored as the opposite of the state of the corresponding check box: For example, the config-name-notMonitoringConnection preference is the opposite of the "Monitor Connection" check box

Preferences in the "VPN Details" Window

Most program preferences may be modified in the "Preferences" section of the "VPN Details" window.

Configuration Settings in the "VPN Details" Window

Configuration settings are implemented as preferences. Most may be modifed on the "Settings" tab of the "VPN Details" window. See Per-Configuration Settings.

Modifying Preferences That are Not in the "VPN Details" window

All other preferences can be modified by

  • Forcing them (see "Deployed" Versions).
  • Modifying them in the preferences file using Apple's "Property List Editor.app". “Property List Editor.app” is a small part of the free Developer Tools available from Apple (a free Apple Developer Connection membership is required). The Developer Tools are a very large (over 900MB download) suite of programs for developing software for Macs. The Developer Tools installs Property List Editor.app in /Developer/Applications/Utilities.
  • Modifying them by using the "defaults" commands in Terminal.app. For example, to disable the display of the duration of connections in the VPN Details window, use
    defaults write net.tunnelblick.tunnelblick "showConnectedDurations" -bool no

    or, for Tunnelblick 3.2beta10 and earlier, use
    defaults write com.openvpn.tunnelblick "showConnectedDurations" -bool no

Preferences That Control What Tunnelblick Does

  • placeIconInStandardPositionInStatusBar (Boolean): If set, the Tunnelblick icon will be positioned normally, to the left of the other icons at the time Tunnelblick is started. If cleared or not present, the Tunnelblick icon will be placed between the time display and the Spotlight icon. The default is not present.
  • doNotMonitorConfigurationFolder (Boolean): If set, Tunnelblick does not monitor the ~/Library/Application Support/Tunnelblick/Configurations folder for changes to configuration files. If cleared or not present, Tunnelblick monitors the folder and reacts appropriately to configuration files that are added or removed. If set, Tunnelblick must be restarted before showing added or removed configurations. The default is not present.
  • doNotLaunchOnLogin (Boolean): If set when Tunnelblick launches, Tunnelblick will not launch on the next login after the next logout, restart, shutdown, or crash occurs. If cleared or not present, Tunnelblick will launch on login if it was running on logout, restart, shut down, or crash. The default is not present.
  • onlyAdminsCanUnprotectConfigurationFiles (Boolean): If set, the user will be warned that they will only be allowed to examine configuration files when using the "Edit Configuration" button on OS X 10.4 (Tiger) or 10.5 (Leopard) and will be unable to modify them. If cleared or not present, the user will be asked if they wish to unprotect the configuration file before editing it on Tiger or Leopard. On OS X 10.6 (Snow Leopard), this preference is ignored. On Tiger and Leopard, TextEdit will be unable to save a modified configuration file that is protected; on Leopard, TextEdit will silently unprotect the configuration file if it is saved after being modified. The default is not present.
  • openvpnVersion (String): Specifies what version of OpenVPN to use. If not set, uses the earliest OpenVPN version that is available. If set to "-" (hyphen), uses the latest version of OpenVPN that is available. If set to a version number (for example, "2.2.1"), specifies a specific version of OpenVPN that should be used. This preference applies to all configurations that do not have a configuration-specific "-openvpnVersion" preference. (DEPRECATED as of 3.4beta14.)
  • standardApplicationPath (String): If present, the absolute path for the folder in which Tunnelblick is to be installed when installing Tunnelblick by double-clicking the icon in a downloaded disk image. If not present or empty, Tunnelblick will be installed in /Applications. The string may include a "~", which will be expanded appropriately to allow installation somewhere in the user's home folder. Default is not present.
  • doNotCreateLaunchTunnelblickLinkinConfigurations (Boolean): If set, no link will be created. If cleared or not present, Tunnelblick will create a link to itself in the ~/Library/Application Support/Tunnelblick/Configurations folder each time it is started. The default is to create the link.
  • useShadowConfigurationFiles (Boolean): If set, Tunnelblick will create and use "shadow copies" of configuration files on the local hard drive in a subfolder of /Library/Application Support/Tunnelblick. If cleared or not present, the original of each configuration file will be used. Configuration files must be owned by root and have permissions of "644" for security; if the configuration file is on a volume which does not allow this ownership and permissions, shadow copies must be used so the copies can be given the proper ownership and permissions. This happens automatically when the home folder is located on a network volume; it is not necessary to use this preference only when the home folder is on a non-network volume which doesn't allow the required ownership and permissions. The default is not present.
  • usePrivateConfigurationsWithDeployedOnes and useSharedConfigurationsWithDeployedOnes are booleans which may be used in a Deployed version of Tunnelblick (see Deploying Tunnelblick) to allow simultaneous display of configurations from the Private (~/Library/Application Support/Tunnelblick/Configurations) and Shared (/Library/Application Support/Tunnelblick/Shared) folders, respectively. These preferences must be forced — they will be ignored if they are not forced.
  • hookupTimeout (Number): The number of seconds that Tunnelblick should use trying to associate Tunnelblick VPN Configurations with OpenVPN processes that were running when Tunnelblick was launched. If zero, Tunnelblick will keep trying until it is closed.
  • openvpnTerminationInterval (Number): The number of seconds that Tunnelblick waits between SIGTERMs to an OpenVPN process that it is trying to disconnect. If zero, Tunnelblick will issue only one request.
  • openvpnTerminationTimeout (Number): The number of seconds that Tunnelblick should wait before considering a non-responsive OpenVPN connection to be closed. If zero, Tunnelblick will not consider the connection closed until the process exits.
  • maxLogDisplaySize (Number): The maximum number of characters that Tunnelblick should allow in the display of the log. If less than 10,000, Tunnelblick will use the default value of 100,000.
  • delayToShowStatistics (Number): Delay in seconds before showing the notification windows when the pointer (mouse) is over the Tunnelblick icon.
  • delayToHideStatistics (Number): Delay in seconds before hiding the notification windows when when the pointer (mouse) is no longer over the Tunnelblick icon or a notification window.
  • statisticsRateTimeInterval (Number): The number of seconds over which rate statistics are smoothed for display in the notification window.
  • notificationLog (Boolean): If set, all OS X notifications will be logged. (Used for debugging Tunnelblick.)
  • timeoutForIPAddressCheckBeforeConnection (Number): The number of seconds for which Tunnelblick will try to check the computer's apparent public IP address before attempting to make a VPN connection.
  • timeoutForIPAddressCheckAfterConnection (Number): The number of seconds for which Tunnelblick will try to check the computer's apparent public IP address after making a VPN connection.
  • timeoutForIPAddressCheckAfterSleeping (Number): The number of seconds for which Tunnelblick will try to check the computer's apparent public IP address after waking from computer sleep.
  • delayBeforeReconnectingAfterSleep (Number): The number of seconds for which Tunnelblick will wait after waking from computer sleep before attempting to reconnect configurations which were disconnected when the computer went to sleep if IP address checking is not enabled.
  • delayBeforeReconnectingAfterSleepAndIpaFetchError (Number): The number of seconds for which Tunnelblick will wait after waking from computer sleep before attempting to reconnect configurations which were disconnected when the computer went to sleep if IP address checking caused an error.
  • notOKToCheckThatIPAddressDidNotChangeAfterConnection (Boolean): If set, the user has not given permission for Tunnelblick to access tunnelblick.net to determine the computer's apparent public IP address. If cleared or not present, the user has given Tunnelblick permission to do so. (DEPRECATED as of 3.4beta14.)
  • managmentPortStartingPortNumber (Number): The port number (from 1 to 65535) of the port to use as a management port to communicate between Tunnelblick and OpenVPN. If the port is not available, successive port numbers will be tried. The default is 1337.

Preferences That Control What The User Sees

  • menuIconSet (String): If set, specifies the name of the folder of icons that Tunnelblick should use to display the connection status in the status bar (usually, near the Spotlight icon). The default is "TunnelBlick.TBMenuIcons". The folder may appear in several locations; see Icon Animation.
  • doNotShowOutlineViewOfConfigurations (Boolean): If set or if running on OS X 10.5 ("Leopard") or earlier, the contents of configuration folders in the "Configurations" panel will always be shown. If cleared or not present and running on OS X 10.6 ("Snow Leopard") or later, the contents of configuration folders can be hidden or shown by clicking on the disclosure triangle next to the name of the folder. The default is not present.
  • doNotShowConnectionSubmenus (Boolean): If set, each configuration is shown as a single menu item even if it is in a subfolder. (It is shown as "Connect folder1/folder2/config".). If cleared or not present, configurations in subfolders display only the subfolder name, and reveal contents of the subfolder only when moused-over. The default is not present.
  • doNotShowCheckForUpdatesNowMenuItem (Boolean): If set, the "Check for Updates Now" item on the "Options..." submenu will not be displayed. If cleared or not present, the item will be displayed. The default is not present.
  • doNotShowAddConfigurationMenuItem (Boolean): If set, the "Add a Configuration..." item on the "Options..." submenu will not be displayed. If cleared or not present, the item will be displayed. The default is not present.
  • doNotShowVpnDetailsMenuItem (Boolean): The default is not present.
  • doNotShowSuggestionOrBugReportMenuItem (Boolean): The default is not present.
  • doNotShowNotificationWindowOnMouseover (Boolean): The default is not present.
  • disableAdvancedButton (Boolean): The default is not present.
  • disableCheckNowButton (Boolean): The default is not present.
  • disableResetDisabledWarningsButton (Boolean): The default is not present.
  • disableCopyLogToClipboardButton (Boolean): The default is not present.
  • disableAddConfigurationButton (Boolean): If set, disables the '+' button. The default is not present.
  • disableRemoveConfigurationButton (Boolean): If set, disables the '-' button. The default is not present.
  • disableWorkOnConfigurationButton (Boolean): If set, disables the 'gear' button. The default is not present.
  • disableRenameConfigurationMenuItem (Boolean): The default is not present.
  • disableDuplicateConfigurationMenuItem (Boolean): The default is not present.
  • disableMakeConfigurationPrivateOrSharedMenuItem (Boolean): The default is not present.
  • disableExamineOpenVpnConfigurationFileMenuItem (Boolean): The default is not present.
  • disableShowOpenVpnLogInFinderMenuItem (Boolean): The default is not present.
  • disableDeleteConfigurationCredentialsInKeychainMenuItem (Boolean): The default is not present.
  • showConnectedDurations (Boolean): If set, the time that a configuration has been connected is displayed in the "VPN Details" window. If cleared, the time is not displayed. The default is set.
  • maximumNumberOfTabs (Number): (This preference is not used in Tunnelblick 3.2beta16 and later.) The maximum number of configurations that Tunnelblick will display in tabs (in the VPN Details window). If there are more than this many configurations, Tunnelblick will display them in a list on the left side of the VPN Details window.
  • connectionWindowDisplayCriteria (String): This controls the Notification Window display. It should have one of the following values (without the quote marks): "neverShow", "showWhenConnecting", or "showWhenChanges". The default is "showWhenConnecting".
  • welcomeURL (String): The URL for a web page that will be displayed as a welcome screen if no ...Tunnelblick.app/Contents/Resources/Deploy/Welcome/index.html file exists.
  • welcomeWidth (Number): The width of welcome display (defaults to 500 pixels).
  • welcomeHeight (Number): The height of welcome display (defaults to 500 pixels).
  • doNotShowWelcomeDoNotShowAgainCheckbox (Boolean): If present and true, the 'Do not show again' checkbox is not displayed on the welcome screen. The default is not present.
  • skipWelcomeScreen (Boolean): If present and true, the welcome screen is not displayed. The default is not present.
  • doNotShowDisconnectedNotificationWindows (Boolean): If present and true, notification (status) windows will not be displayed for configurations that are disconnected. The default is not present.
  • statusDisplayNumber (Number): If present and nonzero, a display number (generated by OS X) specifying on which display notification windows should be displayed. The default is not present, which causes notification windows to be displayed on the largest screen.

    Preferences That Control Updates

  • updateAutomatically (Boolean): If set, when Tunnelblick detects an update it will be downloaded and installed automatically. If cleared or not present, the user will be asked This preference may ONLY be forced; the user's normal preference is ignored because it can be changed at any time by a Sparkle check box. The default is not present.
  • updateCheckAutomatically (Boolean): If set, Tunnelblick checks for updates each time it is launched, and periodically thereafter. If cleared or not present, no checking is done. There is no default value; the user is asked if they want to enable automatic updates the first time Tunnelblick is launched and whenever the information that Tunnelblick sends when checking for an update changes (so the user can decide whether or not to include the information).
  • updateCheckInterval (String or Number): If set, the number of seconds between automatic checks for updates. If not present or empty, the default time (86,400 seconds = 24 hours) is used. If a time less than 3600 seconds (one hour) is specified, it will be changed to 3600 seconds. The default is not present.
  • updateFeedURL (String): If present, the URL to check for updates. If not present or blank, "https://tunnelblick.net/appcast.rss" (for Tunnelblick 3.0b24 and earlier) or "https://tunnelblick.net/updates/update.php" is used. This preference may ONLY be forced; the user's normal preference is ignored for security reasons. The default is not present.
  • updateSendProfileInfo (Boolean): If set, Tunnelblick will send "system profile" information to the Tunnelblick website when checking for updates. If cleared or not present, no such profile information will be sent when checking for updates. There is no default value; when the user is asked if they want to enable automatic updates the first time Tunnelblick is launched and whenever the information the profile information changes, a check box allows the user to set or clear this value.
  • updateSigned (Boolean): If set, forces Tunnelblick to update to a digitally signed version (see Tunnelblick and Digital Signatures). If cleared or not present, Tunnelblick will choose a signed or unsigned version as appropriate. The default is not present.
  • updateUnsigned (Boolean): If set, forces Tunnelblick to update to a version that is not digitally signed (see Tunnelblick and Digital Signatures). If cleared or not present, Tunnelblick will choose a signed or unsigned version as appropriate. The default is not present.
  • onlyAdminCanUpdate (Boolean): If set, update checking will be disabled unless the logged-in user is a member of the "administrator" group. If cleared or not present, update checking will be performed even if the user is not a member of the "administrator" gouger. After an update, an administrator username/password will be required to run Tunnelblick (so the new copy can secure itself). The default is not present.
  • updateUUID: This is an anonymous, unique ID string. If updateSendProfileInfo is set, this string is sent to the Tunnelblick update website when checking for updates. It allows the website to count the number of unique Tunnelblick users.
  • doNotUnrebrandLicenseDescription: (Boolean): If set, skips the un-rebranding of the license description that appears in the Info panel. If cleared or not present, the un-rebranding will be undone although the rebranded name will be presented. Default is not present.

    Preferences That are Set by the User in a Check Box

Most of Tunnelblick's warning messages include a "Do not warn about this again" check box. Checking the check box sets the corresponding preference.

  • skipWarningAboutReprotectingConfigurationFile (Boolean): If set, Tunnelblick on Snow Leopard will not warn the user that any changes made to a configuration file will require an administrator username/password before the changed configuration can be used. If cleared or not present, the warning will be displayed. Default is not present.
  • skipWarningAboutSimultaneousConnections (Boolean): If set, Tunnelblick will not warn the user when a user tries to connect and there is at least one existing connection. If cleared or not present, the warning will be displayed. Default is not present.
  • skipWarningThatCannotModifyConfigurationFile (Boolean): If set, Tunnelblick on Tiger or Leoaprd will not warn the user that any changes made to a configuration file will not be able to be saved. If cleared or not present, the warning will be displayed. Default is not present.
  • skipWarningThatNameChangeDisabledUpdates (Boolean): If set Tunnelblick will warn that an update will fail if the name of Tunnelblick.app has been changed by the user. If cleared or not present, the warning will be displayed. Default is not present.
  • skipWarningAboutNonAdminUpdatingTunnelblick (Boolean): If set, Tunnelblick will not warn a non-administrator user that an update will require an administrator username/password before the changed updated application can be used. If cleared or not present, the warning will be displayed. Default is not present.
  • skipWarningAboutUnknownOpenVpnProcesses (Boolean): If set, Tunnelblick will not warn about OpenVPN processes that it cannot associate with a Tunnelblick VPN Connection.
  • skipWarningThatIPAddressDidNotChangeAfterConnection (Boolean): If set, Tunnelblick will not warn that the computer's apparent public IP address did not change after making a VPN connection. If this warning is skipped, Tunnelblick will not attempt to access tunnelblick.net before or after a VPN connection is made.
  • skipWarningThatDNSIsNotWorking (Boolean): If set, Tunnelblick will not warn about DNS not appearing to work after a VPN connection has been made.
  • skipWarningThatInternetIsNotReachable (Boolean): If set, Tunnelblick will not warn about the Internet appearing to be unreachable after a VPN connection has been made.
  • skipWarningAboutIgnoredConfigurations is a boolean which controls display of the warning that one or more configurations are being ignored. Configurations are ignored if there are higher priority configurations with the same name. Priorities are, from highest to lowest:
    1. Deployed .tlbk configurations
    2. Deployed .ovpn and .conf configurations
    3. Shared .tblk configurations
    4. Private .tblk configurations
    5. Private .ovpn and .conf configurations

Per-Configuration Settings

The following preferences must each be prefixed by the name of the configuration as it is displayed when you click the Tunnelblick icon or in the VPN Details window. (Usually that is the name of the configuration file without the extension, but it can be different if you have configurations in subfolders.) For example, if a configuration is named "xyz", the preferences would be named "xyzautoConnect", "xyz-keychainHasUsernameAndPassword", etc.

If you wish a forced preference to be used for all configurations, use an asterisk ("**") instead of the name of the configuration. This will cause it to be used for all configurations except those that have a specific forced preference. For example, if there is a forced "**useDNS" preference and a forced "XYZuseDNS" preference, the forced preference will be used for all configurations except the configuration named "XYZ". Note that ordinary users can rename private configurations, which means that the user could rename the private configuration named "XYZ" and it would no longer use the specific "XYZ-useNDS" forced preference. Shared and Deployed configurations can not be renamed except by a computer administrator.

  • autoConnect (Boolean): If set, Tunnelblick will connect using the configuration when it Tunnelblick is launched if the -onSystemStart preference is not present or is false, or when the computer starts if the -onSystemStart preference is true. If cleared or not present, the user must connect manually. The user may specify this using the "Connect" selection on the "VPN Details" "Settings" tab for the configuration. The default is not present.
  • -onSystemStart (Boolean): If set and autoConnect is also set, the configuration will be connected when the computer starts instead of when Tunnelblick launches. The default is not present (check box not checked). The user may set this by selecting the "when computer starts" radio button in the VPN Details window.
  • useDNS (Number): Determines if Tunnelblick will use scripts before and after a connection is made and if so, which scripts. Which scripts depend on the value: 1 uses the standard scripts to save and restore the computer's DNS and WINS settings, 2 uses the scripts provided in Tunnelblick 3.0b10, 3 uses scripts from http://openvpn.net/archive/openvpn-users/2006-10/msg00120.html. If 0 or not present, no scripts are run by Tunnelblick (the user may specify scripts in the configuration file). The user may specify this by setting "Set Nameserver" on the "VPN Details" "Settings" tab for the configuration. The default is 1. Note: if this value is non-zero, any "up" and "down" options in the configuration file will be ignored.
  • -openvpnVersion (String, available only in Tunnelblick 3.4beta14 and later): Specifies what version of OpenVPN to use to connect the configuration. If set to "-", uses the latest version of OpenVPN that is available. If set to a version number (for example, "2.2.1"), specifies the specific version of OpenVPN that should be used. If not set, the application-wide "openvpnVersion" preference will be used to determine which version of OpenVPN to use. (If neither preference is set, the earliest version of OpenVPN will be used.)
  • -loadTun (String, available only in Tunnelblick 3.4beta14 and later): Specifies if Tunnelblick should load the tun kext (device driver). If 'always', the driver will always be loaded before connecting. If 'never', the driver will never be loaded before connecting. If not set, Tunnelblick will examine the configuration file to determine whether or not to load the tun kext. The driver will be unloaded when the connection is closed unless it is in use by another configuration.
  • -loadTap (String, available only in Tunnelblick 3.4beta14 and later): Specifies if Tunnelblick should load the tap kext (device driver). If 'always', the driver will always be loaded before connecting. If 'never', the driver will never be loaded before connecting. If not set, Tunnelblick will examine the configuration file to determine whether or not to load the driver. The driver will be unloaded when the connection is closed unless it is in use by another configuration.
  • -notOKToCheckThatIPAddressDidNotChangeAfterConnection (Boolean): If set, will check the computer's apparent public IP address before and after connecting. If cleared or not present, no checking will be done.
  • -notMonitoringConnection (Boolean): If cleared or not present, Tunnelblick will monitor the network and restart the connection if changes to the network DNS or WINS configurations are detected. If set, no monitoring will be done. The user may specify this using the "Monitor Connection" check box on the "VPN Details" "Settings" tab for the configuration. This preference is ignored, and the check box is disabled, if the "useDNS" preference is not set to 1 (i.e., the "Set Nameserver" is not specified). The default is cleared (check box checked).
  • -doNotRestoreOnDnsReset and -doNotRestoreOnWinsReset (Boolean): If set, a DHCP renew which restores the original, pre-VPN DNS or WINS information will restart the connection. If cleared or not present, the post-VPN information will replace the DHCP-supplied information. The default is not present.
  • -doNotDisconnectOnFastUserSwitch (Boolean): If set, Tunnelblick will not disconnect the configuration when the user is switched out. If cleared or not present, when the user is switched out using OS X's Fast User Switching, Tunnelblick will disconnect the configuration if it is not set to connect "when computer starts". The default is not present. Only available in Tunnelblick 3.2beta04 and later.
  • -doNotReconnectOnFastUserSwitch (Boolean): If set, Tunnelblick will not attempt to reconnect the configuration when the user is switched back in. If cleared or not present, when the user is switched in, Tunnelblick will attempt to reconnect the configuration if it is not set to connect "when computer starts". The default is not present. Only available in Tunnelblick 3.2beta04 and later.
  • -doNotDisconnectOnSleep (Boolean): If set, Tunnelblick will not disconnect the configuration when the computer goes to sleep. If cleared or not present, when the computer goes to sleep, Tunnelblick will disconnect the configuration if it is not set to connect "when computer starts". The default is not present. Only available in Tunnelblick 3.4beta18 and later.
  • -doNotReconnectOnWakeFromSleep (Boolean): If set, Tunnelblick will not attempt to reconnect the configuration when the computer wakes from sleep. If cleared or not present, when the computer wakes up, Tunnelblick will attempt to reconnect the configuration if it is not set to connect "when computer starts". The default is not present.
  • -doNotFlushCache (Boolean): If set, Tunnelblick will not flush the DNS cache after a connection is established and after it is disconnected. Note: if this is not set (the default), under some circumstances, traffic between two computers on a LAN may be routed through a bridged VPN. See Issue 154 comment 10.
  • -useDownRootPlugin (Boolean): If set, Tunnelblick will use its built-in "openvpn-down-root.so" plugin to allow the configuration file to use the "user" and "group" options to stop running the OpenVPN process as root once a connection has been established (as a security measure). See Using Tunnelblick for details. The default is not present.
  • -keychainHasPrivateKey (Boolean): If set, the user's Keychain contains the connection's private key, and Tunnelblick will use it when needed without interacting with the user. If cleared or not present, the user will be asked for the private key if the connection requires it. This preference is set when the user checks the "Save to Keychain" check box on the dialog which asks for the private key. If this preference is forced, it has a special meaning: the check box is not displayed, the private key is not stored in the user's Keychain, and the user is asked each time the connection requires it. The default is not present.
  • -keychainHasUsernameAndPassword (Boolean): If set, the user's Keychain contains the connection's username and password, and Tunnelblick will use them when needed without interacting with the user. If cleared or not present, the user will be asked for the username and password if the connection requires it. This preference is set when the user checks the "Save to Keychain" check box on the dialog which asks for the username and password. If this preference is forced, it has a special meaning: the check box is not displayed, the username and password are not stored in the user's Keychain, and the user is asked each time the connection requires them. The default is not present.
  • -doNotParseConfigurationFile (Boolean): If set, Tunnelblick will not parse the configuration file for 'dev tun', 'dev tap', 'user', and 'group' options, and both tun and tap kexts will be loaded when making a VPN connection.
  • -skipWarningAboutDownroot (Boolean): If set, the warning about 'user' and/or 'group' options requiring the use of the 'openvpn-down-root.so' plugin will be disabled.
  • -disableEditConfiguration (Boolean): (This preference is not used in Tunnelblick 3.2beta16 and later.) If set, the "Edit Configuration" button on the "VPN Details" window tab for the configuration will be dimmed and disabled. If cleared or not present, the button will be enabled. The default is not present.
  • -disableConnectButton (Boolean): If set, the "Connect" button will be disabled.
  • -disableDisconnectButton (Boolean): If set, the "Disconnect" button will be disabled.
  • -doNotLoadTapKext (Boolean): If set, the standard tap kext will not be loaded.
  • -doNotLoadTunKext (Boolean): If set, the standard tun kext will not be loaded.
  • -loadTapKext (Boolean): If set, the standard tap kext will be loaded.
  • -loadTunKext (Boolean): If set, the standard tun kext will be loaded.
  • -doNotShowOnTunnelblickMenu (Boolean): If set, the configuration will not be displayed in the Tunnelblick menu.
  • -prependDomainNameToSearchDomains (Boolean): If set, makes Tunnelblick add the domain name provided by OpenVPN to the start of the list of search domains if the search domains are not manually set.
  • -doNotUseDefaultDomain (Boolean): If cleared, a domain of 'openvpn' will be used if no domain is specified in the OpenVPN configuration or pushed by the OpenVPN server. If set, no default domain will be used. Cleared by default.
  • -useRouteUpInsteadOfUp (Boolean): If cleared, Tunnelblick will use the "--up" OpenVPN option to run the set DNS/WINS script before routing has been established. If set, Tunnelblick will use the "--route-up" OpenVPN option to run the set DNS/WINS script after routing has been established. (This is necessary in some situations.) Cleared by default.
  • -waitForDHCPInfoIfTap (Boolean): If set, the 'Set nameserver' script will wait for DHCP info from a TAP connection before returning to OpenVPN. If cleared, the script will return to OpenVPN immediately and process the DHCP info asynchronously.

The following preferences control what Tunnelblick does when a network setting change occurs. They may have values of 'ignore', 'restore', or 'restart'. 'ignore' will cause the network change to be ignored; 'restore' will cause the network change to be reversed (the setting will be set to the post-VPN setting); and 'restart' will cause the connection to be restarted. They are usually set by controls on the "While Connected" tab of the "Advanced" settings window. They will be ignored (and the controls disabled) if the "-leasewatchOptions" preference is present.

The following preferences control what happens when a setting changes to match the setting before the VPN was connected. All of them default to restore if not set.

  • -changeDNSServersAction (String, as described above)
  • -changeDomainAction (String, as described above)
  • -changeSearchDomainAction (String, as described above)
  • -changeWINSServersAction (String, as described above)
  • -changeNetBIOSNameAction (String, as described above)
  • -changeWorkgroupAction (String, as described above)

The following preferences control what happens when a setting changes to something else. All of them default to restart if not set.

  • -changeOtherDNSServersAction (String, as described above)
  • -changeOtherDomainAction (String, as described above)
  • -changeOtherSearchDomainAction (String, as described above)
  • -changeOtherWINSServersAction (String, as described above)
  • -changeOtherNetBIOSNameAction (String, as described above)
  • -changeOtherWorkgroupAction (String, as described above)

  • -leasewatchOptions DEPRECATED (String, available in Tunnelblick 3.2beta08 and later): If set, contains '-i' followed by letters indicating DNS/WINS changes that should be ignored. The default is not present. If not present and monitoring the connection, changes to the following parameters will be restored or cause a reconnection attempt:
    -DomainName
    -ServerAddresses
    -SearchDomains
    • NetBIOSName
    • Workgroup
    • WINSAddresses

    To ignore changes to a parameter, use 'd', 'a', 's', 'n', 'g', and/or 'w', respectively after the '-i'.

    The -leasewatchOptions preference is deprecated because finer control may be asserted by using other preferences that are be set on the "While Connected" tab of the "Advanced" settings window.

Preferences That Tunnelblick Uses Internally

  • haveDealtWithSparkle1dot5b6 (Boolean): If set, Tunnelblick has reset the Sparkle Updater preferences for Sparkle version 1.5b6, so the user will be or has been asked about automatically checking for updates and including system profile information. If cleared, this has not been done yet. See the "updateCheckAutomatically" and "updateSendProfileInfo" preferences. The default is not present; Tunnelblick maintains this preference automatically. This preference is ignored if the "updateCheckAutomatically" and "updateSendProfileInfo" preferences are both forced (to any value).
  • detailsWindowFrame: The size and position of the "OpenVPN Log” window when it was last closed.
  • detailsWindowFrameVersion: The version of Tunnelblick that saved the detailsWindowFrame preference.
  • askedUserIfOKToCheckThatIPAddressDidNotChangeAfterConnection (Boolean): If set, 6, Tunnelblick has asked the user for permission to check the computer's apparent IP address before and after making a VPN connection (which involves sending the IP address and port and Tunnelblick version number to tunnelblick.net). If cleared, this has not been done yet.

Sparkle Updater Preferences

All preferences starting with the letters "SU" are preferences used privately by Sparkle Updater (the program used for Tunnelblick's update mechanism). They cannot be forced and should not be modified. They include:

  • SUEnableAutomaticChecks (Boolean)
  • SUSendProfileInfo (Boolean)
  • SUAutomaticallyUpdate (Boolean)
  • SULastCheckTime (Date/time)
  • SULastProfileSubmissionDate (Date/time)
  • SUHasLaunchedBefore (Boolean)
  Deutsch     Français     中文(简体)     Русский     Español     日本語     …