Wake-on-LAN (WoL)
Wake-on-LAN (WOL) lets you remotely wake your Unraid server from a shutdown or sleep state by sending a "magic packet" over the network. This page will help you set up WoL for your local network.
Requirements
For WoL to work properly, make sure you meet the following requirements:
-
NIC support: Your network interface controller should support WoL; most modern NICs do.
-
BIOS/UEFI settings: Enable WoL in your motherboard's BIOS/UEFI under power management. Here are some common setting names:
Setting name Description Wake on LAN Generic WoL setting PME event wake-up For PCIe wake events Power on by PCI/PCIe devices Alternate name for WoL ErP ready Must be disabled for WoL to work -
Power connection: Ensure your server is plugged into a power source.
-
Network connection: Connect your server to your LAN with an Ethernet cable (WiFi WoL is not supported).
Not all hardware supports S3 sleep or WoL reliably. Some systems may experience issues entering sleep, fail to wake up correctly, or require additional BIOS/UEFI settings. Always test these features thoroughly before relying on them.
Putting an Unraid server to sleep
The preferred and user-friendly way to manage sleep on Unraid is by using the Dynamix S3 Sleep plugin. This plugin offers a graphical interface to help schedule sleep, wake, and idle behavior, while also addressing common issues that may arise with various hardware configurations.
To install and configure:
- Open the Apps tab in the Unraid WebGUI.
- Search for "Dynamix S3 Sleep" and install the plugin.
- Navigate to Settings → Sleep Settings to set up your sleep and wake options.
The plugin manages most sleep configuration options.
Alternative manual method - Click to expand/collapse
If you want more control or need advanced customization, you can configure sleep and WoL settings through the command line. This method is recommended for advanced users.
To configure sleep manually:
-
Identify your primary network interface (usually
eth0
) by running the following command:ifconfig
Note the MAC address (labelled as
ether
). -
Enable WoL on the interface with this command:
ethtool -s eth0 wol g
-
Put the server to sleep by entering this command:
echo -n mem > /sys/power/state
WoL settings configured manually are not persistent across reboots by default. To make them permanent:
- Create a
go
file on your flash drive at/boot/config/go
. - Add this line:
/sbin/ethtool -s eth0 wol g
Wake your Unraid server
To wake your Unraid server remotely, you need to send a special "magic packet" over your local network. This packet includes your server's MAC address and instructs the network interface to power on the system from a sleep or shutdown state. Different operating systems provide various tools and methods for sending this packet. Below are specific instructions for Windows, macOS, and Linux.
- Windows
- macOS
- Linux
Using WakeOnLan CMD
-
Download wolcmd.exe.
-
Run it in Command Prompt:
wolcmd.exe <MAC_ADDRESS> <SERVER_IP> 255.255.255.255
Terminal method (recommended)
-
Install
wakeonlan
using Homebrew:brew install wakeonlan
-
Send the magic packet:
wakeonlan MAC_ADDRESS
GUI alternative: miniWOL
-
Download miniWOL v3 from the App Store.
-
Add your server using its MAC address.
-
Click the sun icon to wake your server.
Terminal method
wakeonlan MAC_ADDRESS
Install it with sudo apt install wakeonlan
if it's not already installed.
Alternative: WoL GUI
You can install a wol
GUI frontend from your Linux distribution's package manager.