/node

Mysterium Node - VPN server and client for decentralized Mysterium Network

Primary LanguageGoGNU General Public License v3.0GPL-3.0

Mysterium Node - decentralized VPN built on blockchain

Go Report Card pipeline status pullreminders codecov GoDoc

Cross-platform software to run a node in Mysterium Network. It contains Mysterium server (node), client API (tequila API) and client-cli (console client) for Mysterium Network.

Currently node supports OpenVPN as its underlying VPN transport.

Getting Started

Installation options

Debian / Ubuntu / Raspbian

Install latest stable release:

sudo -E bash -c "$(curl -s https://raw.githubusercontent.com/mysteriumnetwork/node/master/install.sh)" 

Or install latest snapshot (development build):

SNAPSHOT=true sudo -E bash -c "$(curl -s https://raw.githubusercontent.com/mysteriumnetwork/node/master/install.sh)" 

Service logs:

sudo journalctl -u mysterium-node.service

Service status:

sudo systemctl status mysterium-node.service

Installation script tested on these OSes so far: Raspbian 10, Debian 9, Debian 10, Ubuntu 18.04 and Ubuntu 16.04 .

Docker

To run a node as docker container you will need docker. You should be able to run a node on any OS that supports docker. Tested on these OSes so far: Debian 9, Ubuntu 16.04 and Centos 7.

You can get latest node docker images here: https://hub.docker.com/r/mysteriumnetwork/myst/

Run node:

sudo docker run --cap-add NET_ADMIN --net host --name myst -d mysteriumnetwork/myst service --agreed-terms-and-conditions

Access service logs:

sudo docker logs -f myst

Further information

More installation options are described in the installation guide.
For possible issues while running a node refer to our FAQ section.

Built With

  • go - The Go Programming Language
  • travis - Travis continuous integration tool
  • docker - Containerize applications
  • openvpn - Solid VPN solution
  • wireguard - extremely simple yet fast and modern VPN

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

  • Valdas Petrulis - Lead developer, go evangelist - Waldz
  • Tadas Valiukas - Senior developer, experienced bug maker - tadovas
  • Donatas Kučinskas - Senior developer, clean code savvy - donce
  • Antanas Masevičius - Network engineer / developer, net guru - zolia
  • Paulius Mozuras - Software developer, python lover - interro
  • Ignas Bernotas - Senior developer, open source enthusiast - ignasbernotas
  • Andrej Novikov - Senior developer, JS enthusiast, UX jazzman - shroomist

See also full list of contributors who participated in this project.

License

This project is licensed under the terms of the GNU General Public License v3.0 (see details).