Skip to content

Commit a6b4475

Browse files
committed
add network config info to the config docs
Signed-off-by: Zen <[email protected]>
1 parent 9187be3 commit a6b4475

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

docs/configuration.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,28 @@ key_type = "gpg"
413413
key_file = "/boot/luks.gpg"
414414
```
415415

416-
#### masks
416+
### Network modules
417+
418+
Currently, network modules are only implemented to be used with 3rd party modules which require network access.
419+
420+
The only required config to use networking is to define a specific network interface, by name, using `net_device`.
421+
422+
> `net_device` is used to automatically configure `net_device_mac` which is used to set the MAC address of the primary network interface.
423+
424+
#### ugrd.net.static
425+
426+
If a static IP is required, the following parameters can be used:
427+
428+
* `autodetect_ip` (true) Automatically detect the IP address of the primary network interface, reusing it at boot time.
429+
* `autodetect_gateway` (true) Automatically detect the gateway of the primary network interface, reusing it at boot time.
430+
* `ip_address` - The static IP address to use, automatically populated if `autodetect_ip` is true. In the format `a.b.c.d/cidr`.
431+
* `ip_gateway` - The static gateway to use, automatically populated if `autodetect_gateway` is true.
432+
433+
#### ugrd.net.dhcpcd
434+
435+
If enabled, this module will attempt to use `dhcpcd` to configure the primary network interface.
436+
437+
### masks
417438

418439
To mask an import used by another module, the mask parameter can be used:
419440

0 commit comments

Comments
 (0)