saini-anshul / ulauncher-surfshark

Ulauncher extension to connect to Surfshark VPN using OpenVPN
MIT License
3 stars 0 forks source link

ulauncher-surfshark

Quickly connect to and disconnect from SurfShark VPN from Ulauncher.

Uses OpenVPN to connect to SurfShark VPN profiles

Download and refresh server profiles from https://my.surfshark.com/vpn/api/v1/server/configurations

Connect to different types of VPN servers: Regular, Static-IP, or Multipoint; using UDP or TCP

Quikly search and connect to a specific VPN server based on Country or City name

Requirements

How to add extension to Ulauncher

  1. Open Ulauncher --> preferences

Ulauncher preferences

  1. Go to Extensions tab

Ulauncher extensions tab

  1. Press Add Extensions option

Ulauncher add extensions

  1. Paste the following URL and press Add:
https://github.com/saini-anshul/ulauncher-surfshark

Usage

Default keyword to trigger this extension is surf. This can be changed in the preferences.

Basic commands

Initial setup

The extension uses SurfShark's service credentials to connect to VPN servers, which can be found on the Manual Setup Page

Provide the service credentials using extensions settings page.

Extension Settings Page

Refreshing SurfShark VPN Server Profiles

The extension need to download SurfShark VPN connection profile database before connection to a VPN server can be established. This can be done by selecting the "Refresh DB" option.

Refresh VPN Profile DB

Connecting to VPN

To connect to a VPN, select "Connect followed by the type of connection (UDP in most cases).

Connect option

Connection Types List

Once connection type is selected, a list with available server profiles for that connection type is shown. By default, total number of servers displayed in the list is 10, which can be changed in the extention settings.

Server List

The extension allows searching for a specific server by Country or by City name.

Filtered Server List - TO

Filtered Server List - US

Select the desired server and provide password for extension to connect to the selected server using OpenVPN with admin privileges.

Connection Status

Once connected to a server, simply launch the extension to check on the status of VPN connection and server details.

Server Status and Connection Details

Disconnect

To disconnect from VPN server, launch extention using keyword and choose Disconnect option.

Disconnect Option

License

MIT