mirror of
https://github.com/mudler/edgevpn.git
synced 2025-09-26 21:01:44 +08:00
f314c4ebc0
* feat: add docker compose example Signed-off-by: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com> * new: add basic healthcheck to the docker compose example Signed-off-by: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com> --------- Signed-off-by: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com>
1.5 KiB
1.5 KiB
title, linkTitle, weight, description
| title | linkTitle | weight | description |
|---|---|---|---|
| Getting Started | Getting Started | 1 | First steps with EdgeVPN |
Get EdgeVPN
Prerequisites: No dependencies. EdgeVPN releases are statically compiled.
From release
Just grab a release from the release page on GitHub. The binaries are statically compiled.
Via Homebrew on Macos
If you're using homebrew in MacOS, you can use the edgevpn formula
brew install edgevpn
Building EdgeVPN from source
Requirements:
- Golang installed in your system.
- make
$> git clone https://github.com/mudler/edgevpn
$> cd edgevpn
$> go build
Using Docker Compose
Using docker is still experimental as setups can vary wildly. An example docker-compose.yml file is provided for convenience but you'll likely need to edit it.
$> git clone https://github.com/mudler/edgevpn
$> cd edgevpn
$> sudo docker compose up --detach
Creating Your First VPN
Let's create our first vpn now and start it:
$> EDGEVPNTOKEN=$(edgevpn -b -g)
$> edgevpn --dhcp --api
That's it!
You can now access the web interface on http://localhost:8080.
To join new nodes in the network, simply copy the EDGEVPNTOKEN and use it to start edgevpn in other nodes:
$> EDGEVPNTOKEN=<token_generated_before> edgevpn --dhcp