stop-server/README.md

Stop your computer using your phone or your tablet, from your bed or your couch

# stop-server [![](https://badge.fury.io/js/stop-server.svg)](https://www.npmjs.com/package/stop-server) [![](https://travis-ci.org/typicode/stop-server.svg?branch=master)](https://travis-ci.org/typicode/stop-server)

> Shut down :zap: your computer using Node.js and a phone (works on OS X, Linux and Windows)

_Created because I usually watch movies on my computer from my bed and I wanted to be able to shut it down remotely :)_

## Usage

1. Install `stop-server`

  ```bash
  npm install -g stop-server
  stop-server start # Need to be done only once
  ```

2. Visit [http://localhost:5709/qr.html](http://localhost:5709/qr.html) on your computer and scan the QR code or go directly to `http://your-local-ip:5709` __on your phone__. You should see this page:

  ![](http://i.imgur.com/4WadpZc.png)

3. That's all :)

__Important__ depending on your OS, you need to allow commands to be used without sudo:

```bash
# Run 'sudo visudo' and add
your-username ALL=NOPASSWD: /sbin/shutdown       # OS X and Linux
your-username ALL=NOPASSWD: /usr/sbin/pm-suspend # Linux only
```

## Uninstall

```
npm rm -g stop-server
```

## How it works?

stop-server is a simple Express server with a few routes:

```
POST http://your-local-ip:5709/power-off
POST http://your-local-ip:5709/sleep
```

It's also automatically started on log in using [user-startup](https://github.com/typicode/user-startup).

## License

MIT - [typicode](https://github.com/typicode/stop-server)