repository·master·Indexed 27 days ago
https://github.com/anankke/sspanel-uimA PHP-based management system for proxy services supporting Shadowsocks 2022, V2Ray, Trojan, and TUIC. It features user and node management, automated billing with gateways like PayPal and Stripe, a universal subscription interface, and LLM integration for support. Includes a CLI tool (xcat) for database migrations, configuration updates, and automated client downloads, as well as a Telegram bot for user account management and check-ins.
SSPanel UIM includes the following core capabilities:
json, clash, sip008, and sing-box formats.The ClientDownload command relies on a config/clients.json file to determine which software to update. Each client entry in the clients array should include:
name: The identifier for the client.gitRepo: The GitHub repository path (e.g., owner/repo).tagMethod: Determines how to find the version. Supported values:github_pre_release: Fetches the latest pre-release tag.savePath: The local directory where files will be stored.downloads: An array of download objects containing:sourceName: The filename pattern on GitHub (supports %taskName%, %tagName%, and %tagName1% placeholders).saveName: The filename pattern to use locally (supports %taskName%, %tagName%, and %tagName1% placeholders). If empty, sourceName is used.Placeholders:
%taskName%: The name of the client task.%tagName%: The full version tag (e.g., v1.2.3).%tagName1%: The version tag with the first character removed (e.g., 1.2.3).The /my command allows users to retrieve their personal profile and account information via the Telegram bot.
menu command to show user options.Note on Group Usage: If the system configuration telegram_group_quiet is enabled, or if the chat ID does not match the configured telegram_chatid, the command will not respond in groups.
/my/menu command is a Telegram bot command used to access the user's personal center (个人中心) via private chat. When triggered in a private chat, the bot retrieves the user's index keyboard and displays a message with interactive inline buttons./menuThe /checkin command allows users to perform a daily check-in via Telegram (in private chats or authorized groups). Successful check-ins grant the user a specified amount of traffic reward.
Behavioral Rules:
telegram_group_quiet is disabled in the configuration and if the group's chat ID matches the configured telegram_chatid.获得了 X MB 流量).The /ping command is used to test connectivity and retrieve unique identifiers for users or groups.
telegram_group_quiet configuration setting is not enabled).Note: The command uses Markdown parsing for private messages.
/pingThe /start command initializes the bot session. Its behavior depends on the chat type and the system configuration:
发送 /help 获取帮助 (Send /help to get help).? (question mark) if the telegram_group_quiet configuration setting is not enabled. If telegram_group_quiet is enabled, the bot remains silent in groups.In both cases, the bot simulates a 'typing' action before responding.
/startThe /help command displays a list of all available commands within the system. It can be used in both private chats and group chats.
Behavioral Notes:
telegram_group_quiet is enabled, the command will not respond in groups or supergroups./help or by including the bot's username (e.g., /help @YourBotName). If help_any_command is enabled in the configuration, the bot may respond to other command patterns as well.The following environment variables control the behavior of the ClientDownload command:
| Variable | Description |
|---|---|
github_access_token | GitHub personal access token used to authenticate API requests to GitHub, helping to bypass rate limits. |
enable_r2_client_download | If set, the command will upload downloaded files to Cloudflare R2 using Cloudflare::uploadR2 and then remove the local file. |
The Migration command accepts the following arguments for the [version] parameter:
├─=: php xcat Migration [版本]
│ ├─ <version> - 迁移至指定版本（前进/退回）
│ ├─ latest - 迁移至最新版本
│ ├─ new - 导入全新数据库至最新版本