OpenVPN for Kodi (on OSMC)

A script that allows you to control OpenVPN from within Kodi.

Features

• Start and stop OpenVPN from with Kodi.
• Setup multiple VPN connections.
• Display current geo-location.

Screenshots

Installation

Download the latest zip file and install the addon. See http://kodi.wiki/view/HOW-TO:Install_an_Add-on_from_a_zip_file for more details on installing addons from zip file.

On OSMC you'll need to install beautifulsoup..

sudo apt-get install python-beautifulsoup

and edit the configuration...

nano ~/.kodi/addons/script.openvpn/resources/settings.xml

Change the openvpn setting from /usr/bin/openvpn to /usr/sbin/openvpn.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings>
        <category label="2000">
                <setting label="2007" type="lsep"/>
                <setting label="2001" type="action" action="RunScript(script.openvpn, import)"/>
                <setting label="2002" type="action" action="RunScript(script.openvpn, delete)"/>
                <setting label="2003" type="lsep"/>
                <setting id="openvpn" type="file" label="2000" default="/usr/sbin/openvpn"/>
                <setting id="ip" type="ipaddress" label="2004" default="127.0.0.1"/>
                <setting id="port" type="number" label="2005" default="1337"/>
                <setting id="args" type="text" label="2006" default=""/>
        </category>
        <category label="2010">
                <setting id="sudo" type="bool" label="2011" default="false"/>
                <setting id="sudopwdrequired" type="bool" label="2012" default="true" enable="!eq(-1,false)"/>
        </category>
        <category label="2020">
                <setting id="debug" type="bool" label="2021" default="false"/>
        </category>
</settings>

You can test your connection first on the commandline like so:

openvpn configfile.ovpn

In my case this did not work due to root privileges being needed. Instead:

sudo openvpn configfile.ovpn

...did work. So then we need to change the settings.xml to enable root privs...

<setting id="sudo" type="bool" label="2011" default="true"/>

Now the keyboard will popup and ask for the root password.

If you need to store your password do this

echo yourosmcpwd>>~/.kodi/userdata/addon_data/script.openvpn/pass

Now it won't ask for a password.

Usage

The SimilarTracks script can be accessed from the Programs menu or called using the RunScript builtin function (RunScript(script.openvpn)). The script can be passed the following arguments; e.g. RunScript(script.openvpn, Los Angeles).

import: Run the import configuration dialog.

delete: Run the delete configuration dialog.

location: Display the current geo-location. Uses IPInfoDB API.

disconnect: Disconnect the current OpenVPN connection.

<openvpn configuration>: Run the specified OpenVPN configuration.

Settings

The following settings are available.

Import OpenVPN Configuration File: Selecting this setting invokes the import configuration dialog.

Delete OpenVPN Configuration File: Selecting the option invokes the delete configuration dialog.

OpenVPN: Set this to the OpenVPN binary. Default: /usr/bin/openvp

Management IP Address: Use this option to change the IP address used by OpenVPN management interface. Default: 127.0.0.1

Management Port: Use this option to change the port used by the OpenVPN management interface. Default: 1337

Additional Arguments: Use this option to specify any extra command line arguments to be supplied to OpenVPN.

Use sudo when running OpenVPN: Set this option to true if you require OpenVPN to be run using sudo. Default: false

Password is required: Set to true if a password is required when using sudo. Default: true

FAQ

Is this plugin available in a Kodi addons repository? No

I can't get the OpenVPN plugin to work on Raspberry Pi? Before asking me for help I suggest reading the following guide.

License

OpenVPN for Kodi is licensed under the GPL 3.0 license.