整理文件

plugins/UserOnlineDevices/README.md

@@ -0,0 +1,25 @@
+# User Online Devices Plugin
+
+This plugin provides online IP monitoring for Xboard users and administrators.
+
+## Features
+
+- Shows the current online device count based on Xboard's built-in `DeviceStateService`
+- Provides an administrator page to inspect all users' online IP counts
+- Provides an administrator API endpoint with paginated user online IP data
+- Provides a temporary signed dashboard page for a single user snapshot
+
+## Routes
+
+- `GET /api/v1/user-online-devices/summary`
+- `GET /api/v1/user-online-devices/panel-url`
+- `GET /api/v2/{secure_path}/user-online-devices/users`
+- `GET /{secure_path}/user-online-devices`
+- `GET /user-online-devices/panel/{user}` (temporary signed URL)
+
+## Notes
+
+- This plugin reuses Xboard's existing real-time device state data from Redis.
+- In current Xboard releases, plugin development is primarily backend-oriented, so this plugin ships standalone pages instead of patching the compiled SPA bundle directly.
+- The "online device" count is effectively the number of unique online IPs reported by nodes.
+- The administrator entry is `/{secure_path}/user-online-devices`, which reads the current admin login token and shows paginated user online IP data.