DAppNode Package VPN (Core)
Dappnode package responsible for providing the VPN connection
It is an AragonApp whose repo is deployed at this address: 0xe27438944187b49ef0005554a15b913b11baa08c and whose ENS address is: vpn.dnp.dappnode.eth
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Prerequisites
-
git
Install git commandline tool.
-
docker
Install docker. The community edition (docker-ce) will work. In Linux make sure you grant permissions to the current user to use docker by adding current user to docker group,
sudo usermod -aG docker $USER. Once you update the users group, exit from the current terminal and open a new one to make effect. -
docker-compose
Install docker-compose
Note: Make sure you can run git, docker ps, docker-compose without any issue and without sudo command.
Building
$ git clone https://github.com/dappnode/DNP_VPN.git
$ docker-compose -f docker-compose-vpn.yml build
or
$ docker build --rm -f build/Dockerfile -t dnp_vpn:dev build
Running
Start
$ docker-compose up -d
Stop
$ docker-compose down
Status
$ docker-compose ps
Logs
$ docker-compose logs -f
Generating a tar.xz image
xz is required
$ docker save vpn.dnp.dappnode.eth:dev | xz -e9vT0 > vpn.dnp.dappnode.eth_x.y.z.tar.xz
You can download the latest tar.xz version from here releases.
Loading a Docker image
$docker load -i vpn.dnp.dappnode.eth_x.y.z.tar.xz
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Eduardo Antuña Díez - Initial work - eduadiez
- DAppLion - API - dapplion
- Alex Floyd - Improvements and review - mex20
See also the list of contributors who participated in this project.
License
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details