Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sameerdhoot/wolweb
Web interface for sending Wake-on-lan (magic packet). An HTTP server built using GoLang and uses Bootstrap for UI.
https://github.com/sameerdhoot/wolweb
bootstrap4 docker-container docker-image golang jsgrid wake
Last synced: 27 days ago
JSON representation
Web interface for sending Wake-on-lan (magic packet). An HTTP server built using GoLang and uses Bootstrap for UI.
- Host: GitHub
- URL: https://github.com/sameerdhoot/wolweb
- Owner: sameerdhoot
- License: gpl-3.0
- Created: 2020-11-04T05:29:08.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T22:22:50.000Z (3 months ago)
- Last Synced: 2024-09-27T02:04:47.779Z (about 1 month ago)
- Topics: bootstrap4, docker-container, docker-image, golang, jsgrid, wake
- Language: JavaScript
- Homepage:
- Size: 801 KB
- Stars: 291
- Watchers: 5
- Forks: 74
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://golang.org)
[](http://golang.org)
[](http://golang.org)
# Web interface for sending Wake-on-LAN (Magic Packet)
A GoLang based HTTP server which will send a Wake-on-LAN package (magic packet) on a local network. The request can be send using web interface or directly using HTTP request with the mapped device name in the URL. The only computing device I have running 24x7 is handy-dandy Raspberry Pi 4 (4GB) with docker containers. All other devices like server, laptop and NAS as powered only when I need them. I needed a way to easily turn them on specifically when trying to automate things like nightly builds.
This application is intended do be used in conjunction with a reverse proxy and secured with an SSL certificate. As the intended use case was with home networks, the application has no in-built authentication. While this could pose a slight security risk even if this was hacked to application is intended to be containerised so the attack surface if limited.
I have bookmarked direct link to device(s) on my browsers to wake them using single HTTP call for ease of access.
Use cases:
- Wake-up my home computers remotely, for access remotely over RDP.
- Integration with automated routines to allow parts of a home lab to sleep instead of running 24x7 to save energy.
## Configuring WOL
On some devices WOL can be difficult to correctly configure and have work reliably.
> Follow this article for [Dell Laptops](https://www.dell.com/support/article/en-us/sln305365/how-to-setup-wake-on-lan-wol-on-your-dell-system?lang=en).
## Bootstrap UI with JS Grid for editing data
The UI features CRUD operation implemented using [js-grid.com](https://github.com/tabalinas/jsgrid) plugin.
### Wake-up directly using HTTP Request
/wolweb/wake/**<hostname>** - Returns a JSON object
```json
{
"success": true,
"message": "Sent magic packet to device Server with Mac 34:E6:D7:33:12:71 on Broadcast IP 192.168.1.255:9",
"error": null
}
```
## Configure the app
The application will use the following default values if they are not explicitly configured as explained in sections below.
| Config | Description | Default
| --- | --- | --- |
| Host | Define the host address on which the webserver will listen | **0.0.0.0**
| Port | Define the port on which the webserver will listen | **8089**
| Virtual Directory | A virtual directory to mount this application under | **/wolweb**
| Broadcast IP and Port | This is broadcast IP address and port for the local network. *Please include the port :9* | **192.168.1.255:9**
You can override the default application configuration by using a config file or by setting environment variables. The application will first load values from config file and look for environment variables and overwrites values from the file with the values which were found in the environment.
**Using config.json:**
```json
{
"host": "0.0.0.0",
"port": 8089,
"vdir":"/wolweb",
"bcastip":"192.168.1.255:9"
}
```
**Using Environment Variables:**
*Environment variables takes precedence over values in config.json file.*
| Variable Name | Description
| --- | --- |
| WOLWEBHOST | Override for default HTTP host
| WOLWEBPORT | Override for default HTTP port
| WOLWEBVDIR | Override for default virtual directory
| WOLWEBBCASTIP | Override for broadcast IP address and port
## Devices (targets) - devices.json format
```json
{
"devices": [
{
"name": "Server",
"mac": "34:E6:D7:33:12:71",
"ip": "192.168.1.255:9"
},
{
"name": "NAS",
"mac": "28:C6:8E:36:DC:38",
"ip": "192.168.1.255:9"
},
{
"name": "Laptop",
"mac": "18:1D:EA:70:A0:21",
"ip": "192.168.1.255:9"
}
]
}
```
## Usage with Docker
This project includes [Dockerfile (based on Alpine)](./Dockerfile) and [docker-compose.yml](./docker-compose.yml) files which you can use to build the image for your platform and run it using the docker compose file. If interested, I also have alternate [Dockerfile (based on Debian)](.Debian_Dockerfile). Both of these Dockerfile are tested to run on Raspberry Pi Docker CE. If you want to use this application as-is, you will only need to download these two docker-related files to get started. The docker file will grab the code and compile it for your platform.
> I could not get this to run using Docker's bridged network. The only way I was able to make it work was to use host network for the docker container. See this [https://github.com/docker/for-linux/issues/637](https://github.com/docker/for-linux/issues/637) for details.
### With docker-compose
```bash
docker-compose up -d
```
### Build and run manually
```bash
docker build -t wolweb .
docker run --network host -it wolweb
```
### Extract the compiled application from an image
```bash
docker cp wolweb:/wolweb - > wolweb.gz
```
## Build
You need Go 1.20 to build binary for any OS.
```powershell
# Windows
go build -o wolweb.exe .
```
```shell
# Linux/macOS
go build -o wolweb .
```
### Build for ASUS Routers (ARM v5)
I initially thought of running this application on my router, so I needed to build the application without having to install build tool on my router. I use the following **PowerShell** one liner to build targeting the ARM v5 platform on my Windows machine with VS Code:
```powershell
$Env:GOOS = "linux"; $Env:GOARCH = "arm"; $Env:GOARM = "5"; go build -o wolweb .
```
Copy the file over to router and make it executable.
```sh
chmod +x wolweb
```
> To see detailed instructions on how to run this application as service on ASUS router with custom firmware [asuswrt-merlin](https://www.asuswrt-merlin.net/) see this [Wiki guide](https://github.com/sameerdhoot/wolweb/wiki/Run-on-asuswrt-merlin)
## NGiNX Config
I am already using NGiNX as web-proxy for accessing multiple services (web interfaces) from single IP and port 443 using free Let's Encrypt HTTPS certificate. For accessing this service, I just added the following configuration under my existing server node.
```
location /wolweb {
proxy_pass http://192.168.1.4:8089/wolweb;
}
```
> This is also the reason why I have an option in this application to use virtual directory **/wolweb** as I can easily map all requests for this application. My / is already occupied for other web application in my network.
## Credits
This project is based on a couple of framworks and provided below:
* https://github.com/dabondi/go-rest-wol - Provided the initial project framework
* https://github.com/sabhiram/go-wol - Provided the functionality to the REST
Thank you to the developers behind both projects, David Baumann and Shaba Abhiram!
## License
Distributed with GNU General Public License (c) 2023