https://github.com/nirebu/piwol-server
A Wake on Lan server designed to run on a Raspberry Pi
https://github.com/nirebu/piwol-server
api express javascript local-network newbie nodejs piwol-server raspberry-pi small-projects wake-on-lan
Last synced: about 1 year ago
JSON representation
A Wake on Lan server designed to run on a Raspberry Pi
- Host: GitHub
- URL: https://github.com/nirebu/piwol-server
- Owner: nirebu
- Created: 2019-08-05T22:41:30.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T00:54:02.000Z (over 3 years ago)
- Last Synced: 2025-03-28T04:28:33.734Z (about 1 year ago)
- Topics: api, express, javascript, local-network, newbie, nodejs, piwol-server, raspberry-pi, small-projects, wake-on-lan
- Language: JavaScript
- Size: 198 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# piwol-server
This is an implementation of a Wake on Lan API server written in Node JS based on express.
## What is it?
It aims to be a small server you can keep on 24/7 on a low powered device in your Home/Small office environment, for the occasions in which you need to access remotely your main machine, but it's off.
## Development
I'm developing this project just to have an excuse to use the Raspberry Pi and to scratch the proverbial itch. I'm still learning to code, so expect buggy and messy code. If anyone wants to join in the development, you're welcome to open issues and submit pull requests to show me where I'm going totally wrong.
## Preparing the Raspberry Pi
Much of the work is based on the `arp` command, which is not installed by default on the Raspberry. To get it installed you need to install the `net-tools` package
```bash
sudo apt install net-tools
```
On the Raspberry PI install `nodejs` with the following command
```bash
sudo apt install nodejs npm
```
## How to test it
Clone this repo, install its dependencies and you should be set:
```bash
git clone https://github.com/nirebu/piwol-server.git
cd piwol-server
npm install
```
Get yourself a ristretto while it installs (right now not many dependencies) and then
```bash
npm run dev
```
## Todo
- [ ] Integrate a logging middleware, perhaps `morgan`?
- [ ] Finish up the API, but first, need to build the frontend