node

module
v0.0.0-...-be0919c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 12, 2018 License: GPL-3.0

README

Mysterium Node - decentralized VPN built on blockchain

Go Report Card Build Status

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

Prerequisites

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: Dabian 9, Ubuntu 16.04 and Centos 7.

You can check latest docker node versions here: https://hub.docker.com/r/mysteriumnetwork/myst/

Installation

Go to docker on how to get a recent docker version for Your OS.

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

More detailed installation options described here. 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

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).

Directories

Path Synopsis
bin
client
cmd
core
ip
promise
Package promise allows client to issue proposal, that will be sent to the provider.
Package promise allows client to issue proposal, that will be sent to the provider.
Package metadata contains build information of executable usually provided by automated build systems like Travis.
Package metadata contains build information of executable usually provided by automated build systems like Travis.
dto
service_discovery
dto
services
Tequila API The purpose of this documentation is to provide developers an insight of how to interact with Mysterium Node via Tequila API.
Tequila API The purpose of this documentation is to provide developers an insight of how to interact with Mysterium Node via Tequila API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL