README.md

swyd

Tired of manually booting up and powering off your LAN devices using the terminal? Try swyd instead!

Key features

• Check whether your devices are currently online and turn them on and off by simply pressing a button
• Create and restore backups (snapshots)
• Provides out of the box username/passsword authentication to secure the access
• Fully responsive UI! Turn on your media server using your phone!

Prerrequisites

swyd is just a friendly user interface to operate your devices.

You will still need to:

• Enable wake-on-lan capabilities in all devices you would like to remotely turn on
• Manually install the SSH credentials of the server hosting swyd in all devices you would like to remotely turn off (ssh-copy-id).

Setup

swyd runs on port 23254

Docker

The easiest way to deploy swyd is through Docker. Here's a sample docker-compose.yaml file:

version: '3.8'

services:
  swyd:
    image: ghcr.io/joseantmazonsb/swyd:latest
    container_name: swyd
    restart: unless-stopped
    network_mode: host
    environment:
      - SWYD_ROOT=/etc/swyd # Configuration files
      - SWYD_SNAPSHOTS=/var/swyd/snapshots # Backups
      - SWYD_PRIVATE_KEY=verysecret # Authentication
    volumes:
      # To be able to send commands through ssh
      - /path/to/.ssh:/root/.ssh
      # Optional, to persist data if the container is stopped
      - /path/to/swyd:/etc/swyd
      - /path/to/var/swyd/snapshots:/var/swyd/snapshots

Alternatively, if you'd rather use docker run, you could do:

docker run -d \
  --name swyd \
  --restart unless-stopped \
  --network host \
  -e SWYD_ROOT=/etc/swyd \
  -e SWYD_SNAPSHOTS=/var/swyd/snapshots \
  -e SWYD_PRIVATE_KEY=verysecret \
  -v /path/to/.ssh:/root/.ssh \
  -v /path/to/etc/swyd:/etc/swyd \
  -v /path/to/var/swyd/snapshots:/var/swyd/snapshots \
  ghcr.io/joseantmazonsb/swyd:latest

Screenshots