How orvice/ss-panel works
ss-panel is a Shadowsocks account and server-management panel with a Vue interface and a PHP API. Users register with an invite code or log in, then use the panel to manage account settings and view service information; administrators manage users, nodes, invitations, configuration, and traffic records. Server-side Mu and MuV2 endpoints support the documented Shadowsocks variants, with MuV2 also providing V2Ray-related behavior. The excerpts show authentication and token-storage calls; other subsystem links are limited to README statements and source-index references.
Main entry points: MuV2 MuV2 protocol API · TokenController.php Authentication API · User.php User accounts · Admin Admin API
Components 21
Web client
- Vue panel shell
src/App.vue - User pages
src/pages - Admin pages
src/pages/Admin
Panel API
- Authentication API
app/Controllers/Api/TokenController.php - User API
app/Controllers/Api/UserController.php - Admin API
app/Controllers/Api/Admin - Token controller
app/Controllers/Api/TokenController.php
Server protocols
- Mu protocol API
app/Controllers/Mu - MuV2 protocol API
app/Controllers/MuV2 - V2Ray generation
app/Services/V2rayGenerator.php
Domain and storage
- User accounts
app/Models/User.php - Server nodes
app/Models/Node.php - Traffic records
app/Models/TrafficLog.php - Invite codes
app/Models/InviteCode.php
Shared services
- Service factory
app/Services/Factory.php - Token provider
app/Providers/TokenStorageServiceProvider.php - Token storage
app/Services/Auth/TokenStorage.php - Logging service
app/Services/Logger.php
Other components
- Panel user
- Administrator
- Shadowsocks servers
Connections 16
- Panel user → Vue panel shell: uses panel
README.md - Administrator → Admin pages: manages panel
README.md - Vue panel shell → User pages: renders
src/App.vue - Authentication API → User accounts: looks up and saves
app/Controllers/Api/TokenController.php - Authentication API → Invite codes: validates and consumes
app/Controllers/Api/TokenController.php - Authentication API → Service factory: requests token storage
app/Controllers/Api/TokenController.php - Token provider → Token storage: registers
app/Providers/TokenStorageServiceProvider.php - Token storage → User accounts: stores user ID
app/Services/Auth/TokenStorage.php - Mu protocol API → Shadowsocks servers: serves protocol
README.md - MuV2 protocol API → Shadowsocks servers: serves protocol
README.md - MuV2 protocol API → V2Ray generation: uses generator
app/Controllers/MuV2/NodeController.php - MuV2 protocol API → Server nodes: reads node data
app/Controllers/MuV2/NodeController.php - MuV2 protocol API → Traffic records: uses traffic records
app/Controllers/MuV2/NodeController.php - User API → User accounts: uses account model
app/Controllers/Api/UserController.php - Admin API → Server nodes: manages nodes
app/Controllers/Api/Admin/NodeController.php - Admin API → Traffic records: reads traffic
app/Controllers/Api/Admin/NodeController.php