Commit e0901f
2026-04-14 00:11:49 Anonymous: Initial commit| /dev/null .. vip docs/vip-sentinel.md | |
| @@ 0,0 1,21 @@ | |
| + | # Vip-Sentinel |
| + | |
| + | [Vip-Sentinel Dashboard](http://192.168.40.60:5006/admin/dashboard) |
| + | |
| + | vip-sentinel lives on krypton (192.168.40.60) |
| + | vip-sentinel is a guard layer between VIP's Microsoft Bookings calandar and vip's pixel streaming service. |
| + | vip-sentinel is a backend that maintanins a database of VIP bookings. When a student makes a booking with micosoft bookings, a http request is sent to vip-sentinel via powerautomate and updates the vip-sentinel database accordingly. |
| + | When students authenticate into the VIP pixel-streaming app, the app sends a request to the vip-sentinel server to check if the authenticated student has a booked session. If they do, the student is allowed to use VIP as usual. If not, the student is redirected to the booking page. |
| + | |
| + | vip-sentinel also provides a [dashboard](http://192.168.40.60:5006/admin/dashboard) for real time monitoring of vip usage analytics, session history, and game instance health monitoring. |
| + | |
| + | |
| + | |
| + | # Vip-sentinel service |
| + | Vip-sentinel can be deployed / restarted etc with `sudo systemctl <start/stop/restart> vip-sentinel` on krypton (192.168.40.60) |
| + | |
| + | vip-sentinel has environment variables which enable/disable its enforcement of bookings. |
| + | You can change its enforcement protocol through `sudo nano /etc/vip-sentinel.env` on krypton (192.168.40.60) by switching `GUARD_MODE=` to `enforce` to enforce bookings, or `open` to ignore bookings (anyone with an isn email can acess at any time). Change the enviornment variable, save and then use `sudo systemctl restart vip-sentinel` for the new protocol to take effect. |
| + | |
| + | # Super users |
| + | vip-sentinel also has a list of superusers who can use the app without a booking. To view or update the list, use `sudo nano /opt/vip-guard/app/main.py` on krypton and edit the list `SUPERUSER_EMAILS`. Save and then redeploy with `sudo systemctl restart vip-sentinel` for changes to take effect. |