update readme and screenshots
55
README.md
@@ -4,7 +4,7 @@
|
||||
|
||||
<div align="center" width="100%">
|
||||
<h2>UpSnap</h2>
|
||||
<p>A simple wake on lan web app written with SvelteKit, Go, PocketBase and nmap.</p>
|
||||
<p>A simple wake on lan web app written with SvelteKit, Go and PocketBase.</p>
|
||||
<a target="_blank" href="https://github.com/seriousm4x/upsnap"><img src="https://img.shields.io/github/stars/seriousm4x/upsnap" /></a>
|
||||
<a target="_blank" href="https://github.com/seriousm4x/UpSnap/releases"><img src="https://img.shields.io/github/downloads/seriousm4x/upsnap/total" /></a>
|
||||
<a target="_blank" href="https://github.com/seriousm4x/UpSnap/releases"><img src="https://img.shields.io/github/go-mod/go-version/seriousm4x/UpSnap?filename=backend/go.mod" /></a>
|
||||
@@ -15,22 +15,25 @@
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- Dashboard to wake up devices with one click
|
||||
- Set timed wake and shutdown events via cron
|
||||
- Add custom ports to devices which will be pinged
|
||||
- Discover devices by scanning network
|
||||
- User/Password or OIDC protected login
|
||||
- Dark/light or system prefered color scheme
|
||||
- [Docker images](https://github.com/seriousm4x/UpSnap/pkgs/container/upsnap) for amd64, arm64, arm/v7, arm/v6
|
||||
- 🚀 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 |
|
||||
| ------------------------------ | ------------------------------- |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|  |  |
|
||||
| Dark | Light |
|
||||
| --------------------------------- | ---------------------------------- |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|
||||
## 🚀 Run the binary
|
||||
|
||||
@@ -38,7 +41,7 @@ Just download the latest binary from the [release page](https://github.com/serio
|
||||
|
||||
For more options check `./upsnap --help` or visit [PocketBase documentation](https://pocketbase.io/docs).
|
||||
|
||||
If you need network discovery, make sure to have `nmap` installed and run upsnap as root/admin.
|
||||
If you want to use network discovery, make sure to have `nmap` installed and run UpSnap as root/admin.
|
||||
|
||||
## 🐳 Run in docker
|
||||
|
||||
@@ -71,27 +74,9 @@ upsnap.example.com {
|
||||
}
|
||||
```
|
||||
|
||||
## 🔒 Authorisation
|
||||
## 🔒 User permissions
|
||||
|
||||
**Since version 3.1 authorisation is enabled by default.**
|
||||
|
||||
User management is done through the PocketBase webinterface at [http://localhost:8090/\_/](http://localhost:8090/_/). This is mainly for internal use, such as within a home or corporate network. For external use please see below.
|
||||
|
||||
- To manage users, click the "Collections" icon on the left and select "users".
|
||||
- To manage admins, click the "Settings" icon on the left and select "Admin".
|
||||
|
||||
Api permissions listed by user role:
|
||||
|
||||
| Api | Unauthorized | Users | Admins |
|
||||
| ---------------- | ------------ | ----- | ------ |
|
||||
| List/Search Rule | ❌ | ✅ | ✅ |
|
||||
| View Rule | ❌ | ✅ | ✅ |
|
||||
| Create Rule | ❌ | ❌ | ✅ |
|
||||
| Delete Rule | ❌ | ❌ | ✅ |
|
||||
| Manage Rule | ❌ | ❌ | ✅ |
|
||||
| Wake devices | ❌ | ✅ | ✅ |
|
||||
| Shutdown devices | ❌ | ✅ | ✅ |
|
||||
| Scan network | ❌ | ❌ | ✅ |
|
||||
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
|
||||
|
||||
|
||||
BIN
assets/account-dark.webp
Normal file
|
After Width: | Height: | Size: 24 KiB |
BIN
assets/account-light.webp
Normal file
|
After Width: | Height: | Size: 25 KiB |
|
Before Width: | Height: | Size: 326 KiB |
|
Before Width: | Height: | Size: 324 KiB |
BIN
assets/home-dark.webp
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
assets/home-light.webp
Normal file
|
After Width: | Height: | Size: 39 KiB |
|
Before Width: | Height: | Size: 230 KiB |
|
Before Width: | Height: | Size: 223 KiB |
|
Before Width: | Height: | Size: 150 KiB |
|
Before Width: | Height: | Size: 151 KiB |
BIN
assets/new-manual-dark.webp
Normal file
|
After Width: | Height: | Size: 60 KiB |
BIN
assets/new-manual-light.webp
Normal file
|
After Width: | Height: | Size: 63 KiB |
BIN
assets/new-scan-dark.webp
Normal file
|
After Width: | Height: | Size: 39 KiB |
BIN
assets/new-scan-light.webp
Normal file
|
After Width: | Height: | Size: 41 KiB |
6
assets/pngToWebp.sh
Executable file
@@ -0,0 +1,6 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
for i in *.png; do
|
||||
magick -quality 100 "$i" "$(basename "$i" .png)".webp
|
||||
rm "$i"
|
||||
done
|
||||
BIN
assets/settings-dark.webp
Normal file
|
After Width: | Height: | Size: 31 KiB |
BIN
assets/settings-light.webp
Normal file
|
After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 690 KiB |
|
Before Width: | Height: | Size: 696 KiB |
BIN
assets/users-dark.webp
Normal file
|
After Width: | Height: | Size: 31 KiB |
BIN
assets/users-light.webp
Normal file
|
After Width: | Height: | Size: 32 KiB |