github.com/mysteriumnetwork/node@v0.0.0-20240516044423-365054f76801/INSTALL.md (about)

     1  ## Mysterium VPN node (Any OS with Docker)
     2  
     3  Most convenient way requiring least configuration is to run a node using [Docker](https://docs.docker.com/install/).
     4  All node versions are available through docker hub:
     5  
     6  https://hub.docker.com/r/mysteriumnetwork/myst/
     7  
     8  ### Fetching and running docker image
     9  ```bash
    10  sudo docker run --cap-add NET_ADMIN --net host --name myst -d mysteriumnetwork/myst service --agreed-terms-and-conditions
    11  ```
    12  
    13  >**Note:** to run server, you will have to accept terms & conditions by adding '--agreed-terms-and-conditions' command line option.
    14  >
    15  >**Note 2:** it's mandatory to run docker container with --net host to correctly detect VPN service ip which needs to be published to clients, assuming that host on which node is running has external interface with public ip
    16  
    17  ### Debugging
    18  ```bash
    19  sudo docker logs -f myst
    20  ```
    21  
    22  ## Mysterium VPN node (Debian && Ubuntu) - tested on Ubuntu 16.04
    23  >**Note:** you need to replace {version} with specific version number from [releases](https://github.com/mysteriumnetwork/node/releases/)
    24  
    25  ### Download
    26   * https://github.com/mysteriumnetwork/node/releases/download/{VERSION}/mysterium-node_linux_amd64.deb
    27  
    28  ###  Add latest OpenVPN repository
    29  
    30  ```bash
    31  apt-get update && apt-get install -y curl
    32  curl -s https://swupdate.openvpn.net/repos/repo-public.gpg | apt-key add && echo "deb http://build.openvpn.net/debian/openvpn/stable focal main" > /etc/apt/sources.list.d/openvpn-aptrepo.list && rm -rf /var/cache/apt/* /var/lib/apt/lists/*
    33  apt-get update
    34  ```
    35  
    36  ### Installation
    37  ```bash
    38  wget https://github.com/mysteriumnetwork/node/releases/download/{VERSION}/myst_linux_amd64.deb
    39  sudo dpkg --install --force-depends myst_linux_amd64.deb
    40  sudo apt-get install -y --fix-broken
    41  ```
    42  
    43  ### Running service
    44  ```bash
    45  sudo service mysterium-node start
    46  sudo service mysterium-node status
    47  ```
    48  
    49  ### Debugging service
    50  ```bash
    51  sudo tail -f /var/log/mysterium-node/*
    52  ```
    53  
    54  ### Debugging standalone
    55  ```bash
    56  sudo myst --data-dir=/var/lib/mysterium-node --config-dir=/etc/mysterium-node --script-dir=/etc/mysterium-node --runtime-dir=/tmp --identity=0x123456..
    57  ```
    58  
    59  ## Mysterium VPN node and client standalone binaries (.tar.gz)
    60  
    61  #### Download
    62   * https://github.com/mysteriumnetwork/node/releases/download/{VERSION}/myst_{OS}_{ARCH}.tar.gz
    63  
    64  #### Extract
    65  ```bash
    66  tar -xvzf myst_{OS}_{ARCH}.tar.gz
    67  ```
    68  
    69  #### Running
    70  ```bash
    71  cd myst_{OS}_{ARCH}
    72  sudo ./myst
    73  ```
    74  
    75  >**Note:** to run server, you will have to add `service` subcommand and accept terms & conditions by adding '--agreed-terms-and-conditions' command line option.