void/amneziawg-go
2
0
Fork 0
mirror of https://github.com/amnezia-vpn/amneziawg-go.git synced 2025-06-07 22:03:44 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source 
Signed-off-by: Mark Puha <p.mark95@gmail.com>
Signed-off-by: Mark Puha <marko10@inf.elte.hu>
This commit is contained in:
Mark Puha 2023-09-03 13:31:21 +02:00 • committed by Mark Puha
parent 1f0f5d5b7c
commit 1ab8729390
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -4,14 +4,6 @@ This is an implementation of WireGuard in Go.
## Usage ## Usage
### Config gen
The configs are generate from a yml file. If you want to change the config run `make cfg_gen config_name` where `config_name` is the name of the yaml file you'd like to generate from. The script will search in the `cfg/settings/` folder
### Example:
`make cfg_gen default` will generate a config from `cfg/settings/default.yml` the file will be called `cfg/cfg_values.go`
Every time you make changes to the yml you need to rerun this.
Most Linux kernel WireGuard users are used to adding an interface with `ip link add wg0 type wireguard`. With wireguard-go, instead simply run: Most Linux kernel WireGuard users are used to adding an interface with `ip link add wg0 type wireguard`. With wireguard-go, instead simply run:
``` ```
@ -59,6 +51,18 @@ This requires an installation of the latest version of [Go](https://go.dev/).
``` ```
$ git clone https://git.zx2c4.com/wireguard-go $ git clone https://git.zx2c4.com/wireguard-go
$ cd wireguard-go $ cd wireguard-go
```
### Config gen
The configs are generate from a yml file. If you want to change the config run `make cfg_gen config_name` where `config_name` is the name of the yaml file you'd like to generate from. The script will search in the `cfg/settings/` folder
### Example:
`make cfg_gen default` will generate a config from `cfg/settings/default.yml` the file will be called `cfg/cfg_values.go`
Every time you make changes to the yml you need to rerun.
After the generation is done you can build with:
```
$ make $ make
``` ```