geezer686 / upsnap Goto Github PK

UpSnap

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

• 🚀 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 for amd64, arm64, arm/v7, arm/v6
• 🏠 Self-Hostable, No Cloud Bullshit!

Dark	Light

Just download the latest binary from the release page and run it ./upsnap serve --http=0.0.0.0:8090.

For more options check ./upsnap --help or visit PocketBase documentation.

If you want to use network discovery, make sure to have nmap installed and run UpSnap as root/admin.

You can use the docker-compose example. See the comments in the file for customization.

If you want to change the port, change the following (5000 in this case):

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:

entrypoint: /bin/sh -c "apk update && apk add --no-cache <YOUR_PACKAGE> && rm -rf /var/cache/apk/* && ./upsnap serve --http 0.0.0.0:8090"

You can search for your needed package here.

Caddy example

upsnap.example.com {
    reverse_proxy localhost:8090
}

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.

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.

Fork this branch and clone it.

1. Start backend

cd backend
go mod tidy
go run main.go serve

2. Start frontend

cd frontend
pnpm i
pnpm run dev

Open up http://localhost:5173/, create an admin user and add some devices.