aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Stendahl <14180120+JakobST1n@users.noreply.github.com>2019-08-15 16:20:22 +0200
committerGitHub <noreply@github.com>2019-08-15 16:20:22 +0200
commit6cbd0d57649af40359e6810f3aa31565565497d1 (patch)
tree6f5e63e3d2c73c755c2da68b4f98b81b23b68e71
parentb422dfbb697ec2474cefabd8adee550e78876fe1 (diff)
downloadRemoteWOL-6cbd0d57649af40359e6810f3aa31565565497d1.tar.gz
RemoteWOL-6cbd0d57649af40359e6810f3aa31565565497d1.zip
Create README.md
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cb3f85c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# RemoteWOL
+Simple webapp for remotly waking devices with WOL.
+
+I made it so that i can wake up my Mediaserver when i am not at home.
+
+# Usage
+1. Create a file named `config/devices.json`, containing the MAC-addresses of the devices you want to wake.
+2. Run `npm i` or `npm install`
+3. Start the app with `node app.js`, root might be required (You could also make a service, just to make it easier to manage the app).
+4. Setup port-forwarding to port 1000 on the device you have the webapp.
+5. Profit!
+Go to the website and press the link that says "Wake all devices", the app will now try to send a "Magic packet" to each of the MAC-addresses you have added to the config-file.