Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dappnode/dnp_vpn
Dappnode package responsible for providing the VPN connection
https://github.com/dappnode/dnp_vpn
Last synced: 9 days ago
JSON representation
Dappnode package responsible for providing the VPN connection
- Host: GitHub
- URL: https://github.com/dappnode/dnp_vpn
- Owner: dappnode
- License: gpl-3.0
- Created: 2018-03-12T22:37:36.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-22T16:37:49.000Z (11 months ago)
- Last Synced: 2024-01-22T20:57:17.693Z (11 months ago)
- Language: TypeScript
- Size: 4.41 MB
- Stars: 7
- Watchers: 11
- Forks: 13
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# DAppNode Package VPN (Core)
[](https://dappnode.io/)
[](https://docs.dappnode.io)
[](https://donate.dappnode.io)
[](https://app.element.io/#/room/#DAppNode:matrix.org)
[](https://twitter.dappnode.io)
Dappnode package responsible for providing the VPN connection
It is an AragonApp whose repo is deployed at this address: [0xe27438944187b49ef0005554a15b913b11baa08c](https://etherscan.io/address/0xe27438944187b49ef0005554a15b913b11baa08c) and whose ENS address is: [vpn.dnp.dappnode.eth](https://etherscan.io/enslookup?q=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](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) commandline tool.
- docker
Install [docker](https://docs.docker.com/engine/installation). 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](https://docs.docker.com/compose/install)
**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](https://tukaani.org/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](https://github.com/dappnode/DNP_VPN/releases).
### Loading a Docker image
```
$docker load -i vpn.dnp.dappnode.eth_x.y.z.tar.xz
```
## Contributing
Please read [CONTRIBUTING.md](https://github.com/dappnode/DAppNode/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/dappnode/DNP_VPN/tags).
## Authors
- **Eduardo Antuña Díez** - _Initial work_ - [eduadiez](https://github.com/eduadiez)
- **DAppLion** - _API_ - [dapplion](https://github.com/dapplion)
- **Alex Floyd** - _Improvements and review_ - [mex20](https://github.com/mex20)
See also the list of [contributors](https://github.com/dappnode/DNP_VPN/contributors) who participated in this project.
## License
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details
## References
[git](https://git-scm.com/)
[docker](https://www.docker.com/)
[docker-compose](https://docs.docker.com/compose/)