Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/achianumba/wg2uci
Generate a uci shell script from a wg-quick config file
https://github.com/achianumba/wg2uci
Last synced: 10 days ago
JSON representation
Generate a uci shell script from a wg-quick config file
- Host: GitHub
- URL: https://github.com/achianumba/wg2uci
- Owner: achianumba
- License: mit
- Created: 2024-06-21T17:00:00.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-11T15:46:59.000Z (6 months ago)
- Last Synced: 2024-07-11T18:13:11.927Z (6 months ago)
- Language: Shell
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wg2uci
wg2uci uses a [wg-quick](https://git.zx2c4.com/wireguard-tools/about/src/man/wg-quick.8) (WireGuard) configuration file to generate a shell script that configures a WireGuard interface and its peers through uci.
## Usage
### Generate `uci` WireGuard config script
Download [wg2uci](wg2uci):
```shell
curl -O https://raw.githubusercontent.com/achianumba/wg2uci/main/wg2uci
```
Make `wg2uci` executable:
```shell
chmod +x wg2uci
```
Generate a UCI interface/network script:
```shell
./wg2uci
```
Configure a WireGuard interface/network using the generated script
```shell
./config-.sh
```
### `wg2uci` options
- `-z | --zone`: Zone name. `wan` is the default zone but you may set it to `lan` or a custom zone.
- `i | --zone-input`: The firewall zone's INPUT chain's policy. Default is `ACCEPT`.
- `f | --zone-forward`: The firewall zone's FORWARD chain's policy. Default is `ACCEPT`.
- `-o | --zone-output`: The firewall zone's OUTPUT chain's policy. Default is `ACCEPT`.
- `-m | --zone-masq`: The firewall zone's masquerading. Default is `0` (disabled). `1` is enabled.
## Additional *.conf file fields
`wg2uci` treats the below comments in a `*.conf` file as config fields instead of comments:
- `# InterfaceName`: A valid UNIX interface name placed above the `[Interface]` header. The `*.conf` file's name is set as the interface's name in the absence of the `InterfaceName` comment.
**Example**
```ini
# InterfaceName = wg0
[Interface]
```
- `# Description`: A one-word description of a peer placed above a `[Peer]` header.
**Example**
```ini
# Description = GitHubCDNs
[Peer]
```
## Limitations
- Doesn't parse `PostUp` and `PostDown` directives.
- Doesn't handle multiple AllowedIPs when written on multiple lines (yet) instead of as a comma-separated list.
## To-do
- [x] Set wan, lan, custom firewall zone using the `-z | --zone` option.
- [ ] Configure forwarding to LAN.
- [ ] Open WireGuard interface's port.