5.5 KiB
Networking
Armbian uses Netplan.io to describe networking configurations. Netplan is a utility to easily configure Linux networking, using a declarative approach. If you want to configure your network manually, it is as simple as editing and creating Netplan yaml files (see the yaml configuration reference at the Netplan docs).
Netplan is used to configure networks on all Armbian images since Release 24.05, no matter if minimal, CLI or desktop, Debian or Ubuntu. However, the networking backends are different based on if you choose a minimal image or not.
Minimal images
!!! tip "Netplan renderer: networkd"
Minimal images are using the systemd-networkd backend, which has a smaller footprint compared to Network-Manager which is used in all non-minimal images. systemd-networkd is a system daemon that manages network configurations. It detects and configures network devices as they appear; it can also create virtual network devices. This service is great for simple connections, but can also be useful to set up complex network configurations.
Armbian defaults
All ethernet interfaces are configured for DHCP and will automatically receive an IP address from your router.
/etc/netplan/10-dhcp-all-interfaces.yaml:
network:
version: 2
renderer: networkd
ethernets:
all-eth-interfaces:
match:
name: "e*"
dhcp4: yes
dhcp6: yes
ipv6-privacy: yes
Configuration examples
Setting a fixed IP address
The following example configures a static IP 192.168.1.199 for the eth0 interface. Please adjust as necessary.
!!! question "How to find your device's Ethernet interface?"
Use command:
```sh
ip addr
```
It is usually something like `eth0`, `enp4s3` or `lan`.
/etc/netplan/20-static-ip.yaml:
network:
version: 2
renderer: networkd
ethernets:
eth0: # Change this to your ethernet interface
addresses:
- 192.168.1.199/24
routes:
- to: default
via: 192.168.1.1
nameservers:
addresses:
- 9.9.9.9
- 1.1.1.1
See also the Netplan docs for reference.
Connecting to WiFI network
!!! tip "It is recommended to make a separate config file for wireless network."
Create the following file:
sudo nano /etc/netplan/30-wifis-dhcp.yaml:
network:
version: 2
renderer: networkd
wifis:
wlan0:
dhcp4: true
dhcp6: true
access-points:
"Your-SSID":
password: "your-password"
Replace SSID with the name of the network you want to connect to and wlan0 with the wifi interface used on your system.
!!! question "How to find your device's WiFi interface?"
Use command:
```sh
ip addr
```
It is usually something like `wlan0`, `wlo1` or `wlx12334c47dec3`.
See also the Netplan docs for reference.
Applying your configuration
Once you are done configuring your network, it is time to test syntax and apply it.
Fix file permissions
According to the Netplan docs, the permissions must be restricted to the root user.
sudo chmod 600 /etc/netplan/*.yaml
Test syntax
This will verify the syntax and test if your device can connect
sudo netplan try
Apply the configuration
sudo netplan apply
CLI and desktop images
!!! tip "Netplan renderer: Network Manager"
Server CLI and desktop images are using the Network-Manager backend. You can use similar methods for configuring your network as with the networkd backend used on minimal images.
Setting a fixed IP address
The following example configures a static IP 192.168.1.199 for the eth0 interface. Please adjust the example to your likings.
!!! question "How to find your device's Ethernet interface?"
Use command:
```sh
ip addr
```
It is usually something like `eth0`, `enp4s3` or `lan`.
/etc/netplan/20-static-ip.yaml:
network:
version: 2
renderer: NetworkManager # Different than 'networkd'
ethernets:
eth0: # Change this to your ethernet interface
addresses:
- 192.168.1.199/24
routes:
- to: default
via: 192.168.1.1
nameservers:
addresses:
- 9.9.9.9
- 1.1.1.1
See also the Netplan docs for reference.
Alternatively, you can also use Network-Manager directly via the command line or GUI tools on your desktop:
nmtui-edit eth0
??? note "Display screenshot"
Replace eth0 with the name of your Ethernet Interface.
Connecting to WiFI network
For connecting to a wireless network, you can use the same method as mention above for use with networkd on minimal images. Just make sure to replace renderer: networkd with renderer: NetworkManager.
Alternatively, you can also use Network-Manager directly via the command line or GUI tools on your desktop:
nmtui-connect SSID
??? note "Display screenshot"
Replace SSID with the name of your wireless network.