wol

Wake on Lan and some useful stuff as web service.

install

pip install git+https://github.com/JleMyP/wol.git#egg=wol[all]

for using as cli tool, i recommend use pipx

pipx install git+https://github.com/JleMyP/wol.git#egg=wol[cli,ssh,scapy]

launch dev web server

wol-dev-server

to get command-line arguments type wol-dev-server -h.

arguments

• --bind, -b - listen interface address. default - 127.0.0.1;
• --port, -p - listen port. default - 5000;
• --debug, -d - run in debug mode. default - false;
• --no-db - do not use database and disable CRUD api.

arguments also can be passed through env vars prefixed by WOL_, example - WOL_PORT=3000 python -m wol.wsgi.

more seriously launch

gunicorn --access-logfile - 'wol.wsgi:create_app()'

docker launch

docker run --rm -ti -p 5000:5000 ghcr.io/jlemyp/wol

or for use syn/ack tcp packets instead of ping for checking host:

docker run --rm -u root -p 5000:5000 ghcr.io/jlemyp/wol

port can be passed at the build stage - --build-arg PORT=8000, or at the launch stage - -e PORT=8000.
default user has no root permissions, so the port can't be less than 1024, or you can launch the container with root user - -u root -e PORT=80.
other configurations can be passed wia GUNICORN_CMD_ARGS variable.

usage

api doc
cli doc

todo

functionality:

• ssh pkey
• access control
  • jwt
• browsable interface
• configuration
  • sentry dsn
  • userless mode
• sync names: host, hostname, address, login, username, etc
• validate model filling in per model actions
• replace configparser by typer
• extend per model actions
• mass core operations
• mass per model operations
• add hosts from scanning net

operability:

• in-app openapi doc
• healthcheck
  • disable ht logs
• sentry
• tests
  • ci