GithubHelp home page GithubHelp logo

bltavares / october Goto Github PK

View Code? Open in Web Editor NEW
14.0 3.0 0.0 14 KB

Wake-on-lan webapp - ๐ŸŽต Wake me up, when september ends ๐ŸŽต

Dockerfile 10.22% Makefile 16.73% Handlebars 14.11% Rust 58.94%
wake-on-lan wol wakeonlan

october's Introduction

October

Wake-on-lan webapp - ๐ŸŽต Wake me up, when september ends ๐ŸŽต

Usage

To start, run the self-contained binary with a CSV list of host,mac and visit localhost:3493. It should render a table of devices using a default template.

october -a sample.csv

Overriding the template

You can override the internal template with the --template flag, giving it a handlebar template file. For faster development, you can use the --autoreload flag to preview changes locally.

The service will host the current working directory as HTTP assets if you want to provide images or CSS styling.

Run

This project aims to run on Docker with minimal size, and also targets multiplaform builds, including Windows, Linux and Raspberry Pi (Zero to 4).

You can either compile it with cargo build --release or use the provided bltavares/october Docker image.

To run properly, it requires to be on the host network without any isolation, otherwhise your router will not advertise the 'magic packet' to your devices.

Targets

Platform Docker Size
armv7-musleabihf Yes 2.03MB
arm-musleabi Yes 2.08MB
aarch64-musl Yes 1.99MB
x86_64-musl Yes 2.49MB
Windows No 2.29MB
Mac No N/A

Docker

Example command for Docker

docker run -d \
  --restart=unless-stopped \
  --network=host \
  -p 3493:3493 \
  -v sample.csv:/opt/sample.csv \
  --name october \
  bltavares/october -a /opt/sample.csv

Build

To build and publish multi-architecture docker images:

make all
make publish
make manifest

Debugging

sudo netcat -ulp 9

Then you should see something from netcat.

october's People

Contributors

bltavares avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.