Skip to content

Latest commit

 

History

History
140 lines (91 loc) · 3.62 KB

README.md

File metadata and controls

140 lines (91 loc) · 3.62 KB
Raw

mysterium-vpn-desktop

GitHub release (latest by date) Downloads Lint

⚠️ MysteriumVPN 2.0 for Desktop is available. https://www.mysteriumvpn.com

Mysterium VPN is a Desktop VPN client for Windows, macOS and Linux.

It is the first Mysterium Network use case in action. Our dVPN is our flagship product and showcases the potential of our residential IP network. Learn more

Usage

Download and install the latest version for your platform. After installation, run MysteriumVPN to get started.

Linux

Ubuntu/Debian

  • Download the .deb package from releases
  • Install app with dependencies:
sudo apt install ./package-name.deb

CentOS/Fedora/RHEL

  • Download the .rpm package from releases
  • Install app with dependencies:
sudo dnf install package-name.rpm

macOS

Manual Install

  • Download the .dmg package from releases
  • Open the package and drag MysteriumVPN.app onto the Applications shortcut

Homebrew

  • Mysterium VPN can also be installed with Homebrew:
brew install --cask mysteriumvpn
  • Update
brew upgrade --cask mysteriumvpn

Windows

Manual Install

  • Download the .exe file from releases
  • Run the executable to install

Chocolatey

  • Mysterium VPN can also be installed with chocolatey:
choco install -y mysteriumvpn
  • Update
choco update -y mysteriumvpn

Logs

Logs help to debug issues when something goes wrong. Make sure to attach all of them when submitting a bug report.

Windows

  • %USERPROFILE%\AppData\Roaming\MysteriumVPN\logs (app)
  • %USERPROFILE%\.mysterium\logs\mysterium-node.log (node)
  • %PROGRAMDATA%\MystSupervisor\myst_supervisor.log (supervisor)

macOS

  • ~/Library/Logs/MysteriumVPN (app)
  • ~/.mysterium/logs/mysterium-node.log (node)
  • /var/log/myst_supervisor.log (supervisor)

Linux

  • ~/.config/MysteriumVPN/logs (app)
  • ~/.mysterium/logs/mysterium-node.log (node)
  • /var/log/myst_supervisor.log (supervisor)

** Note: In development mode, application logs are printed to the console

Development

Pre-requisites:

  • Node 14 LTS
  • yarn

  1. Install and build the project

    yarn && yarn build

  2. Start (webpack dev server with hot reload):

    yarn dev

Packaging for distribution

Required env variables (macOS):

  • APPLEID
  • APPLEIDPASS (generate an app-specific password for this)
  • APPLETEAMID
yarn bundle

Development guide

./docs/DEV_GUIDE.md

Upgrading electron version

When upgrading, upload debug symbols to sentry:

node sentry-symbols.js

https://docs.sentry.io/platforms/javascript/electron/#uploading-debug-information