https://github.com/timofurrer/ariseem

Minimalistic REST API for wake-on-lan
https://github.com/timofurrer/ariseem

api docker flask microservice python rest wake-on-lan wol

Last synced: 3 days ago
JSON representation

Minimalistic REST API for wake-on-lan

• Host: GitHub
• URL: https://github.com/timofurrer/ariseem
• Owner: timofurrer
• License: mit
• Created: 2017-11-01T10:57:05.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-01T13:11:53.000Z (about 7 years ago)
• Last Synced: 2024-12-13T21:52:56.009Z (8 days ago)
• Topics: api, docker, flask, microservice, python, rest, wake-on-lan, wol
• Language: Python
• Size: 9.77 KB
• Stars: 10
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# arise 'em

`ariseem` is a minimalistic service exposing a REST API to boot machines using wake-on-lan.

It's pure Python and does not require any system dependencies.

## Installation

Just use docker:

```

docker build . -t ariseem && docker run -v $PWD:/app --net=host -it ariseem

```

If you want to expose this service into the internet please make sure you are properly secured

with a proxy in front of this service. TLS and at least some form of authentication.

## Configuration

`ariseem` is configured via YAML file:

```

machines:

    myserver: AA:BB:CC:DD:EE:FF

    mypc: AA:BB:CC:FF:EE:DD

groups:

    vpn:

        - myserver

        - mypc

```

`ariseem` can only *wol* machines configured in the `machines` section.

In addition groups of machines can be specified in the `groups` section.

## Usage

```

GET /api/machines

POST /api/machines/myserver

GET /api/groups

POST /api/groups/vpn

```