github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/README.md (about) 1 # Mysterium Node - decentralized VPN built on blockchain 2 3 [![Go Report Card](https://goreportcard.com/badge/github.com/mysteriumnetwork/node)](https://goreportcard.com/report/github.com/mysteriumnetwork/node) 4 [![pipeline status](https://gitlab.com/mysteriumnetwork/node/badges/master/pipeline.svg)](https://gitlab.com/mysteriumnetwork/node/pipelines) 5 [![codecov](https://codecov.io/gh/mysteriumnetwork/node/branch/master/graph/badge.svg)](https://codecov.io/gh/mysteriumnetwork/node) 6 [![GoDoc](https://godoc.org/github.com/mysteriumnetwork/node?status.svg)](http://godoc.org/github.com/mysteriumnetwork/node) 7 8 Cross-platform software to run a node in Mysterium Network. It contains Mysterium server (node), 9 client API (tequila API) and client-cli (console client) for Mysterium Network. 10 11 Currently node supports WireGuard as its underlying VPN transport. 12 13 ## Getting Started 14 15 - [Homepage](https://mysterium.network) 16 - [Whitepaper](https://mysterium.network/whitepaper.pdf) 17 - [Latest release](https://github.com/mysteriumnetwork/node/releases/latest) 18 - [Snapshot builds](https://github.com/mysteriumnetwork/node-builds/releases) - bleeding edge, use at your own risk 19 - [Documentation](https://docs.mysterium.network/) 20 - [Help Center](https://help.mystnodes.com/) 21 - [Installation guide](https://help.mystnodes.com/en/?q=installation) 22 23 ## Installation options 24 25 ### Debian / Ubuntu / Raspbian 26 27 Install latest stable release: 28 ```bash 29 sudo -E bash -c "$(curl -s https://raw.githubusercontent.com/mysteriumnetwork/node/master/install.sh)" 30 ``` 31 32 Or install latest snapshot (development build): 33 ```bash 34 SNAPSHOT=true sudo -E bash -c "$(curl -s https://raw.githubusercontent.com/mysteriumnetwork/node/master/install.sh)" 35 ``` 36 37 Service logs: 38 ```bash 39 sudo journalctl -u mysterium-node.service 40 ``` 41 42 Service status: 43 ```bash 44 sudo systemctl status mysterium-node.service 45 ``` 46 47 Installation script tested on these OSes so far: _Raspbian 10_, _Debian 9_, _Debian 10_, _Ubuntu 18.04_ and _Ubuntu 20.04_. 48 49 ### Docker 50 51 Our docker images can be found in [Docker hub](https://hub.docker.com/r/mysteriumnetwork/myst). 52 53 To run a node in a docker container you will need [docker](https://www.docker.com/). On Linux, to manage docker as a non-root user (execute commands without `sudo`), follow [postinstall guide](https://help.mystnodes.com/en/articles/3777670-running-a-node-as-docker-image-on-linux-host/). 54 You should be able to run a node on any OS that supports docker. We have tested it on these OSes so far: 55 - Debian 9 56 - Debian 10 57 - Ubuntu 18.04 58 - Ubuntu 20.04 59 - Ubuntu 22.04 60 - Yocto Linux (BalenaOS) 61 62 Run node: 63 ```bash 64 docker run \ 65 --cap-add NET_ADMIN \ 66 --net host \ 67 --name myst -d \ 68 mysteriumnetwork/myst service --agreed-terms-and-conditions 69 ``` 70 71 Access service logs: 72 ```bash 73 docker logs -f myst 74 ``` 75 76 ### Further information 77 78 More installation options are described in the [installation guides](https://help.mystnodes.com/en/?q=installation). 79 For possible issues while running a node refer to our [Troubleshooting guides](https://help.mystnodes.com/en/collections/1992526-troubleshooting-mystnodes-help-center). 80 81 ## Built With 82 83 * [go](https://golang.org/) - The Go Programming Language 84 * [gitlab](https://docs.gitlab.com/ce/ci/) - GitLab CI/CD 85 * [docker](https://www.docker.com/what-docker) - Containerize applications 86 * [openvpn](https://openvpn.net) - Solid VPN solution 87 * [wireguard](https://www.wireguard.com/) - Extremely simple yet fast and modern VPN 88 * [geth](https://geth.ethereum.org/) - Official Go implementation of the Ethereum protocol 89 90 ## Contributing 91 92 For a detailed guide, please visit our [developer docs](https://docs.mysterium.network/for-developers/node-development). 93 94 ## Core contributors 95 * **Valdas Petrulis** - *Lead developer, go evangelist, node bootstrapper* - [Waldz](https://github.com/Waldz) 96 * **Tadas Valiukas** - *Senior developer, experienced bug maker* - [tadovas](https://github.com/tadovas) 97 * **Donatas Kučinskas** - *Senior developer, clean code savvy* - [donce](https://github.com/donce) 98 * **Antanas Masevičius** - *Network engineer / developer, net guru* - [zolia](https://github.com/zolia) 99 * **Ignas Bernotas** - *Senior developer, open source enthusiast* - [ignasbernotas](https://github.com/ignasbernotas) 100 * **Dmitry Shihovtsev** - *Senior developer, devops ninja* - [soffokl](https://github.com/soffokl) 101 * **Viktoras Kuznecovas** - *Senior developer, supersonic typing specialist* [vkuznecovas](https://github.com/vkuznecovas) 102 * **Tadas Krivickas** - *Senior fullstack engineer, CI boss, refactoring fairy* [tadaskay](https://github.com/tadaskay) 103 * **Jaro Šatkevič** - *Senior developer, micro-payments researcher, crypto maniac* [chompomonim](https://github.com/chompomonim) 104 * **Andzej Maciusovič** - *Senior developer, disciplined world changer* [anjmao](https://github.com/anjmao) 105 * **Mantas Domaševičius** - *Senior fullstack engineer, always ready for pair programming* [mdomasevicius](https://github.com/mdomasevicius) 106 * **Tomas Mikalauskas** - *Backend developer, golang lover, payment guru* [tomasmik](https://github.com/tomasmik) 107 * **Vlad Iarmak** - *Protocol architect, networking guru, inexhaustible RFC writer* [Snawoot](https://github.com/Snawoot) 108 109 See also full list of [contributors](https://github.com/mysteriumnetwork/node/contributors) who participated in this project. 110 111 ## License 112 113 This project is licensed under the terms of the GNU General Public License v3.0 (see [details](./LICENSE)).