https://github.com/KaiStarkk/wumps

https://github.com/KaiStarkk/wumps

Last synced: 26 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/KaiStarkk/wumps
• Owner: KaiStarkk
• Created: 2023-04-02T04:28:24.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-25T12:58:29.000Z (6 months ago)
• Last Synced: 2024-03-13T23:00:22.676Z (3 months ago)
• Language: JavaScript
• Size: 49.8 KB
• Stars: 28
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars - KaiStarkk/wumps - (JavaScript)

README

        
# WUMPS

## Web Utility for Managing Power States

### For \*arr users with power bills!

[![Build and Push Docker Image](https://github.com/KaiStarkk/wumps/actions/workflows/docker-image.yml/badge.svg)](https://github.com/KaiStarkk/wumps/actions/workflows/docker-image.yml)

![image](https://user-images.githubusercontent.com/1722064/229474685-60f1c7e5-431e-4185-94af-21889cab82e1.png)

When starting out with self-hosted media servers, many users run \*arr apps on their personal machines. It's not uncommon to have Windows services installed for Sonarr, Radarr, Readarr, Prowlarr, Jellyfin, Audiobookshelf, Jellyseerr, VueTorrent, Dashy... and the like.

This can be inefficient, as personal computers (let's be honest, _gaming computers_) run on power-intensive hardware, and are wasting energy while idle if not in use. Not to mention the noise and heat coming out of that ATX case! This is compounded when the computer is left on 24/7 _in case_ you might need to add something to a DVR or watch 15 minutes of a show on your lunch break.

Yes it's possible to buy a $2000 NAS and run Unraid/OMV, set up redundant disks, split your libraries onto dedicated drives/volumes so only one spins up when you use it (etc. etc. etc.) but who has the money and time for that!

This is a very simple app intended to provide a dashboard for powering personal machines on and off instead.

## Installation

NOTE: This app is intended to be installed on a lightweight client such as an old Raspberry Pi, on the same local network as your media server_gaming computer_. If you happen to have an old RPI1/0 lying around, remember they run on ARMv6 so some extra work may be necessary to compile binaries if you don't use docker.

1. Pull the latest image, build, and start the app using

`docker run -d --restart always --network host kaistarkk/wumps`

2. Install [SleepOnLan](https://github.com/SR-G/sleep-on-lan) on any target machines that you need to be able to hibernate as well as wake.

The recommended method of exposing this application to the internet is to use a Cloudflare Zero Trust tunnel. See the `cloudflared` documentation for further details on setting up a tunnel.

WUMPS runs on port 9008 by default.

## Roadmap

-   [X] Improve install instructions

-   [X] Save configuration from the dashboard

-   [X] Tidy up UI for changing configuration

-   [ ] Add authentication

-   [ ] Switch between multiple saved hosts (tiles?)

-   [ ] Check for updates

## Contributing

Current dependencies and stack:

-   [SleepOnLan](https://github.com/SR-G/sleep-on-lan)

-   Python3 (w/ wakeonlan, ping3, configparser)

-   Flask

-   HTML/CSS/JS (jinja)

-   Docker

## Support

This app is given to the world freely as a Boddhisattva-like act. Go forth and love. 

## License

Same as any other \*arr software.