UpSnap

A simple wake on lan web app written with SvelteKit, Go and PocketBase.

## ✨ Features - 🚀 One-Click Device Wake-Up Dashboard - ⏰ Timed Events via Cron for Automation - 🔌 Ping Any Port You Choose - 🔍 Discover Devices with Network Scanning (nmap required) - 👤 Secured User Management - 🎨 29 Themes - 🐳 [Docker images](https://github.com/seriousm4x/UpSnap/pkgs/container/upsnap) for amd64, arm64, arm/v7, arm/v6 - 🏠 Self-Hostable, No Cloud Bullshit! ## 📸 Screenshots | Dark | Light | | --------------------------------- | ---------------------------------- | | ![](/assets/home-dark.webp) | ![](/assets/home-light.webp) | | ![](/assets/account-dark.webp) | ![](/assets/account-light.webp) | | ![](/assets/new-manual-dark.webp) | ![](/assets/new-manual-light.webp) | | ![](/assets/new-scan-dark.webp) | ![](/assets/new-scan-light.webp) | | ![](/assets/settings-dark.webp) | ![](/assets/settings-light.webp) | | ![](/assets/users-dark.webp) | ![](/assets/users-light.webp) | ## 🚀 Run the binary Just download the latest binary from the [release page](https://github.com/seriousm4x/UpSnap/releases) and run it `./upsnap serve --http=0.0.0.0:8090`. For more options check `./upsnap --help` or visit [PocketBase documentation](https://pocketbase.io/docs). If you want to use network discovery, make sure to have `nmap` installed and run UpSnap as root/admin. ## 🐳 Run in docker You can use the [docker-compose](docker-compose.yml) example. See the comments in the file for customization. If you want to change the port, change the following (5000 in this case): ```yml entrypoint: /bin/sh -c "./upsnap serve --http 0.0.0.0:5000" healthcheck: test: curl -fs "http://localhost:5000/api/health" || exit 1 interval: 10s ``` And if you need additional packages inside the container, do this: ```yml entrypoint: /bin/sh -c "apk update && apk add --no-cache && rm -rf /var/cache/apk/* && ./upsnap serve --http 0.0.0.0:8090" ``` You can search for your needed package [here](https://pkgs.alpinelinux.org/packages). ### Reverse Proxy **Caddy example** ``` upsnap.example.com { reverse_proxy localhost:8090 } ``` ## 🔒 User permissions UpSnap offers unique access for each user, per device. While admins have all permissions, they can assign specific rights to users such as displaying/hiding a device, accessing device editing, deleting and powering devices on/off. ## 🌍 Exposing to the open web Although UpSnap has user authorisation, it is **not recommended to expose it to the open web** and make it accessible by everyone! **Reason**: The shutdown device command is basically a command piped to #sh (root if you run docker). If anyone gains unauthorized access and can abuse this api route in any way, the attacker has access to a (root) shell on your local network. **Recommended**: If you need access from outside your network, please use a vpn. Wireguard or OpenVPN is your way to go. ## 🔧 Help developing Fork this branch and clone it. 1. Start backend ```sh cd backend go mod tidy go run main.go serve ``` 2. Start frontend ```sh cd frontend pnpm i pnpm run dev ``` Open up [http://localhost:5173/](http://localhost:5173/), create an admin user and add some devices. ## 🌟 Star History [![Star History Chart](https://api.star-history.com/svg?repos=seriousm4x/UpSnap&type=Date&theme=dark)](https://star-history.com/#seriousm4x/UpSnap&Date)