search

jpillora / sleep-on-lan

Send your computer to sleep via HTTP
MIT License
8 stars 3 forks source link

readme

sleep-on-lan

It's easy to wake your computer with Wake-On-Lan

Now you can send your computer back to sleep with Sleep-On-Lan!

Install

Get Node.js

npm install -g sleep-on-lan

Help

$ sleep-on-lan --help

  Usage: sleep-on-lan [options]

  Options:

    -h, --help              output usage information
    -V, --version           output the version number
    -p, --port <port>       Port to run server on (default: 57339)
    -H, --host <host>       Interface to run server on (default: 0.0.0.0)
    -u, --url <url>         URL to trigger sleep (default: sleep)
    -w, --wait <ms>         Wait in milliseconds before sleeping (default: 3000)
    -d, --daemonize         Daemonize the sleep server
    -l, --log <file>        Sends output to a logfile
    -n, --no-periodic-wake  Prevents the system from waking every 2 hours for WOL compatibility (Mac OSX)

See this article for more information on the --no-periodic-wake option

Example

Host A

$ sleep-on-lan
Listening at http://0.0.0.0:57339/sleep

Host B

$ curl http://host-a:57339/sleep...
ok

Host A

#1:
  Sleeping in 1000ms
  Time: Fri Jun 13 2014 22:32:47 GMT+1000 (EST)
  IP address: 10.0.0.1

... and when it wakes...

#2:
  Woke
  Time: Fri Jun 13 2014 22:36:15 GMT+1000 (EST)

Run sleep-on-lan at startup

$ crontab -e
# insert the line:
@reboot sleep-on-lan -d -l ~/log.txt
# save and exit
crontab: installing new crontab

MIT License

Copyright © 2014 Jaime Pillora <dev@jpillora.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.