Browse Source

Base: Add man page for network configuration

Maciej 3 years ago
parent
commit
238bed2f24
1 changed files with 39 additions and 0 deletions
  1. 39 0
      Base/usr/share/man/man5/Network.md

+ 39 - 0
Base/usr/share/man/man5/Network.md

@@ -0,0 +1,39 @@
+## Name
+
+NetworkServer - network configuration
+
+## Synopsis
+
+```**
+/etc/Network.ini
+```
+
+## Description
+
+The Network configuration is loaded by NetworkServer service on startup. It consists of a list of interfaces, with adapter names as groups.
+
+The interface that is not listed in this config file is not set up and disabled by default.
+
+## Options
+
+* `Enabled` (default: `true`) - Whether the interface is enabled.
+* `DHCP` (default: `false`) - Whether the DHCP client should be run on this interface.
+* `IPv4Address` (default: `0.0.0.0`) - The static IPv4 address for the interface. Used only when `DHCP` is `false`.
+* `IPv4Netmask` (default: `0.0.0.0`) - The static IPv4 netmask for the interface. Used only when `DHCP` is `false`.
+
+## Example
+
+```ini
+# Set static IP address to 10.0.0.5 and mask to 255.0.0.0
+[ep1s0]
+IPv4Address=10.0.0.5
+IPv4Netmask=255.0.0.0
+
+# Try to run DHCP discovery on ep0s8.
+[ep0s8]
+DHCP=true
+
+# Disable interface ep1s1 entirely. It is equivalent to not adding this entry at all.
+[ep1s1]
+Enabled=false
+```