SSPanel-Uim/config/.config.example.php

<?php

//注释里请勿使用英文方括号、分号、单引号，否则迁移Config时会出错

//config迁移附注（由开发者填写本次config迁移后需要注意的地方，站长勿动）
//如需换行，直接换行即可，无需换行符
//【新增/删除】config无需写入迁移附注
$_ENV['config_migrate_notice'] =
    '新增 enable_change_email 配置項
新增 smtp_bbc 配置項
';
$_ENV['version'] = 2;    //仅当涉及【需要修改config以外的文件】时才需要+1，站长勿动


//基本设置--------------------------------------------------------------------------------------------
$_ENV['key']        = '1145141919810';                //!!! 瞎 jb 修改此key为随机字符串确保网站安全 !!!
$_ENV['debug']      = false;                          //正式环境请确保为 false
$_ENV['appName']    = 'SSPanel-UIM';                      //站点名称
$_ENV['baseUrl']    = 'https://sspanel.host';               //站点地址
$_ENV['muKey']      = 'NimaQu';                       //用于校验魔改后端请求，可以随意修改，但请保持前后端一致，否则节点不能工作！

$_ENV['enableAdminApi'] = false;                      // 是否启用 Admin API, 如果不知道此项用途请保持为 false
$_ENV['adminApiToken']  = 'ChangeMeToSafeKey';        // Admin API 的 Token, 请生成为高强度的 Token

//数据库设置--------------------------------------------------------------------------------------------
// db_host|db_socket 二选一，若设置 db_socket 则 db_host 会被忽略，不用请留空。若数据库在本机上推荐用 db_socket。
// db_host 例: localhost（可解析的主机名）, 127.0.0.1（IP 地址）, 10.0.0.2:4406（含端口)
// db_socket 例：/var/run/mysqld/mysqld.sock（需使用绝对地址）
$_ENV['db_driver']    = 'mysql';
$_ENV['db_host']      = '';
$_ENV['db_socket']    = '';
$_ENV['db_database']  = 'sspanel';           //数据库名
$_ENV['db_username']  = 'root';              //数据库用户名
$_ENV['db_password']  = 'sspanel';           //用户名对应的密码
#高级
$_ENV['db_charset']   = 'utf8mb4';
$_ENV['db_collation'] = 'utf8mb4_unicode_ci';
$_ENV['db_prefix']    = '';

//流媒体解锁 如下设置将使397，297号节点复用4号节点的检测结果 使用时去掉注释符 //
$_ENV['streaming_media_unlock_multiplexing'] = [
    //'397' => '4',
    //'297' => '4',
];

//邮件设置--------------------------------------------------------------------------------------------
$_ENV['sendPageLimit']      = 50;           //发信分页 解决大站发公告超时问题
$_ENV['email_queue']        = true;         //如题，自动计划任务邮件使用队列 需要每分钟执行 php xcat Job SendMail
$_ENV['mail_filter']        = 0;            //0: 关闭; 1: 白名单模式; 2; 黑名单模式;
$_ENV['mail_filter_list']   = array("qq.com", "vip.qq.com", "foxmail.com");


//备份设置--------------------------------------------------------------------------------------------
$_ENV['auto_backup_email']  = '';                               //接收备份的邮箱
$_ENV['auto_backup_password'] = '';                               //备份的压缩密码
$_ENV['backup_notify']      = false;                            //备份通知到TG群中


//用户注册设置-----------------------------------------------------------------------------------------
$_ENV['free_user_reset_day']            = 0;                         //免费用戶的流量重置日，0为不重置
$_ENV['free_user_reset_bandwidth']      = 0;                         //需要重置的免费流量，0为不重置
$_ENV['random_group']              = '0';                       //注册时随机分组，注册时随机分配到的分组，多个分组请用英文半角逗号分隔

$_ENV['enable_reg_im']             = false;                      //注册时是否要求用户输入IM联系方式

$_ENV['reg_forbidden_ip']          = '127.0.0.0/8,::1/128';     //注册时默认禁止访问IP列表，半角英文逗号分割
$_ENV['min_port']                  = 10000;                     //用户端口池最小值，如果该数值为0则用户在注册的时候不会被分配多用户端口，适合纯V2Ray/Trojan机场
$_ENV['max_port']                  = 65535;                     //用户端口池最大值，如果该数值为0则用户在注册的时候不会被分配多用户端口，适合纯V2Ray/Trojan机场
$_ENV['reg_forbidden_port']        = '';                        //注册时默认禁止访问端口列表，半角英文逗号分割，支持端口段

$_ENV['mu_suffix']                 = 'microsoft.com';           //单端口多用户混淆参数后缀，可以随意修改，但请保持前后端一致
$_ENV['mu_regex']                  = '%5m%id.%suffix';          //单端口多用户混淆参数表达式，%5m代表取用户特征 md5 的前五位，%id 代表用户id, %suffix 代表上面这个后缀。

#邀请链接
$_ENV['invite_price']              = -1;                        //用户购买邀请码所需要的价格，价格小于0时视为不开放购买
$_ENV['custom_invite_price']       = -1;                        //用户定制邀请码所需要的价格，价格小于0时视为不开放购买


//已注册用户设置---------------------------------------------------------------------------------------
#基础
$_ENV['enable_checkin']             = true;         //是否啓用簽到功能
$_ENV['checkinMin']                 = 1;            //用户签到最少流量 单位MB
$_ENV['checkinMax']                 = 50;           //用户签到最多流量

$_ENV['auto_clean_uncheck_days']    = -1;           //自动清理多少天没签到的0级用户，小于等于0时关闭
$_ENV['auto_clean_unused_days']     = -1;           //自动清理多少天没使用的0级用户，小于等于0时关闭
$_ENV['auto_clean_min_money']       = 1;            //余额低于多少的0级用户可以被清理

$_ENV['enable_bought_reset']        = true;         //购买时是否重置流量
$_ENV['enable_bought_extend']       = true;         //购买时是否延长等级期限（同等级配套）

$_ENV['port_price']                 = -1;           //用户随机重置端口所需要的价格，价格小于0时视为不开放购买
$_ENV['port_price_specify']         = -1;           //用户指明钦定端口所需要的价格，价格小于0时视为不开放购买

$_ENV['disconnect_time']        = 60;            //在用戶超过套餐连接IP数后多久才会拒绝新连接

#高级
$_ENV['class_expire_reset_traffic'] = 0;            //等级到期时重置为的流量值，单位GB，小于0时不重置
$_ENV['account_expire_delete_days'] = -1;           //账户到期几天之后会删除账户，小于0时不删除

$_ENV['enable_kill']                = true;         //是否允许用户注销账户
$_ENV['enable_change_email']        = true;         //是否允许用户更改賬戶郵箱

#用户流量余量不足邮件提醒
$_ENV['notify_limit_mode']          = true;         //false为关闭，per为按照百分比提醒，mb为按照固定剩余流量提醒
$_ENV['notify_limit_value']         = 20;           //当上一项为per时，此处填写百分比；当上一项为mb时，此处填写流量

//订阅设置---------------------------------------------------------------------------------------
$_ENV['Subscribe']                  = true;                         //本站是否提供订阅功能
$_ENV['subUrl']                     = $_ENV['baseUrl'] . '/link/';  //订阅地址，如需和站点名称相同，请不要修改
$_ENV['mergeSub']                   = true;                         //合并订阅设置 可选项 false / true
$_ENV['enable_sub_extend']          = true;                         //是否开启订阅中默认显示流量剩余以及账户到期时间以及 sub_message 中的信息
$_ENV['enable_forced_replacement']  = true;                         //用户修改账户登录密码时，是否强制更换订阅地址

// 订阅中的营销信息
// 使用数组形式，将会添加在订阅列表的顶端
// 可用于为用户推送最新地址等信息，尽可能简短且数量不宜太多
$_ENV['sub_message']                = [];
$_ENV['disable_sub_mu_port']        = false;                        // 将订阅中单端口的信息去除
$_ENV['subscribeLog']               = false;                        //是否记录用户订阅日志
$_ENV['subscribeLog_show']          = true;                         //是否允许用户查看订阅记录
$_ENV['subscribeLog_keep_days']     = 7;                            //订阅记录保留天数
$_ENV['mu_port_migration']          = false;                        //为后端直接下发偏移后的端口
$_ENV['add_emoji_to_node_name']     = false;                        //为部分订阅中默认添加 emoji
$_ENV['add_appName_to_ss_uri']      = true;                         //为 SS 节点名称中添加站点名
$_ENV['subscribe_client']           = true;                         //下载协议客户端时附带节点和订阅信息
$_ENV['subscribe_client_url']       = '';                           //使用独立的服务器提供附带节点和订阅信息的协议客户端下载，为空表示不使用
$_ENV['Clash_DefaultProfiles']      = 'default';                    //Clash 默认配置方案
$_ENV['Surge_DefaultProfiles']      = 'default';                    //Surge 默认配置方案
$_ENV['Surge2_DefaultProfiles']     = 'default';                    //Surge2 默认配置方案
$_ENV['Surfboard_DefaultProfiles']  = 'default';                    //Surfboard 默认配置方案


//审计自动封禁设置--------------------------------------------------------------------------------------------
$_ENV['enable_auto_detect_ban']      = false;       // 审计自动封禁开关
$_ENV['auto_detect_ban_numProcess']  = 300;         // 单次计划任务中审计记录的处理数量
$_ENV['auto_detect_ban_allow_admin'] = true;        // 管理员不受审计限制
$_ENV['auto_detect_ban_allow_users'] = [];          // 审计封禁的例外用户 ID

// 审计封禁判断类型：
//   - 1 = 仁慈模式，每触碰多少次封禁一次
//   - 2 = 疯狂模式，累计触碰次数按阶梯进行不同时长的封禁
$_ENV['auto_detect_ban_type']        = 1;
$_ENV['auto_detect_ban_number']      = 30;             // 仁慈模式每次执行封禁所需的触发次数
$_ENV['auto_detect_ban_time']        = 60;             // 仁慈模式每次封禁的时长 (分钟)

// 疯狂模式阶梯
// key 为触发次数
//   - type：可选 time 按时间 或 kill 删号
//   - time：时间，单位分钟
$_ENV['auto_detect_ban'] = [
    100 => [
        'type' => 'time',
        'time' => 120
    ],
    300 => [
        'type' => 'time',
        'time' => 720
    ],
    600 => [
        'type' => 'time',
        'time' => 4320
    ],
    1000 => [
        'type' => 'kill',
        'time' => 0
    ]
];


//Bot 设置--------------------------------------------------------------------------------------------
# Telegram bot
$_ENV['enable_telegram']                    = false;        //是否开启 Telegram bot
$_ENV['use_new_telegram_bot']               = true;         //是否使用新的 Telegram bot
$_ENV['telegram_token']                     = '';           //Telegram bot,bot 的 token ，跟 father bot 申请
$_ENV['telegram_chatid']                    = '';           //Telegram bot,群组会话 ID,把机器人拉进群里之后跟他 /ping 一下即可得到
$_ENV['telegram_bot']                       = '_bot';       //Telegram 机器人账号
$_ENV['telegram_group_quiet']               = false;        //Telegram 机器人在群组中不回应
$_ENV['telegram_request_token']             = '';           //Telegram 机器人请求Key，随意设置，由大小写英文和数字组成，更新这个参数之后请 php xcat Tool setTelegram

# 通用
$_ENV['finance_public']                     = true;         //财务报告是否向群公开
$_ENV['enable_welcome_message']             = true;         //机器人发送欢迎消息

# Telegram BOT 其他选项
$_ENV['allow_to_join_new_groups']           = true;         //允许 Bot 加入下方配置之外的群组
$_ENV['group_id_allowed_to_join']           = [];           //允许加入的群组 ID，格式为 PHP 数组
$_ENV['telegram_admins']                    = [];           //额外的 Telegram 管理员 ID，格式为 PHP 数组
$_ENV['enable_not_admin_reply']             = true;         //非管理员操作管理员功能是否回复
$_ENV['not_admin_reply_msg']                = '!';          //非管理员操作管理员功能的回复内容
$_ENV['no_user_found']                      = '!';          //管理员操作时，找不到用户的回复
$_ENV['no_search_value_provided']           = '!';          //管理员操作时，没有提供用户搜索值的回复
$_ENV['data_method_not_found']              = '!';          //管理员操作时，修改数据的字段没有找到的回复
$_ENV['delete_message_time']                = 180;          //在以下时间后删除用户命令触发的 bot 回复，单位：秒，删除时间可能会因为定时任务而有差异，为 0 代表不开启此功能
$_ENV['delete_admin_message_time']          = 86400;        //在以下时间后删除管理命令触发的 bot 回复，单位：秒，删除时间可能会因为定时任务而有差异，为 0 代表不开启此功能
$_ENV['enable_delete_user_cmd']             = false;        //自动删除群组中用户发送的命令，使用 delete_message_time 配置的时间，删除时间可能会因为定时任务而有差异
$_ENV['help_any_command']                   = false;        //允许任意未知的命令触发 /help 的回复

$_ENV['remark_user_search_email']           = ['邮箱'];                     //用户搜索字段 email 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_search_port']            = ['端口'];                     //用户搜索字段 port 的别名，可多个，格式为 PHP 数组

$_ENV['remark_user_option_is_admin']        = ['管理员'];                   //用户搜索字段 is_admin 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_enable']          = ['用户启用'];                  //用户搜索字段 enable 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_money']           = ['金钱', '余额'];             //用户搜索字段 money 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_port']            = ['端口'];                     //用户搜索字段 port 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_transfer_enable'] = ['流量'];                     //用户搜索字段 transfer_enable 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_passwd']          = ['连接密码'];                 //用户搜索字段 passwd 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_method']          = ['加密'];                     //用户搜索字段 method 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_protocol']        = ['协议'];                     //用户搜索字段 protocol 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_protocol_param']  = ['协参', '协议参数'];         //用户搜索字段 protocol_param 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_obfs']            = ['混淆'];                     //用户搜索字段 obfs 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_obfs_param']      = ['混参', '混淆参数'];         //用户搜索字段 obfs_param 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_invite_num']      = ['邀请数量'];                 //用户搜索字段 invite_num 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_node_group']      = ['用户组', '用户分组'];       //用户搜索字段 node_group 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_class']           = ['等级'];                     //用户搜索字段 class 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_class_expire']    = ['等级过期时间'];             //用户搜索字段 class_expire 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_expire_in']       = ['账号过期时间'];             //用户搜索字段 expire_in 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_node_speedlimit'] = ['限速'];                    //用户搜索字段 node_speedlimit 的别名，可多个，格式为 PHP 数组
$_ENV['remark_user_option_node_connector']  = ['连接数', '客户端'];         //用户搜索字段 node_connector 的别名，可多个，格式为 PHP 数组

$_ENV['enable_user_email_group_show']       = false;                      //开启在群组搜寻用户信息时显示用户完整邮箱，关闭则会对邮箱中间内容打码，如 g****@gmail.com
$_ENV['user_not_bind_reply']                = '您未绑定本站账号，您可以进入网站的 **资料编辑**，在右下方绑定您的账号.';                      //未绑定账户的回复
$_ENV['telegram_general_pricing']           = '产品介绍.';                  //面向游客的产品介绍
$_ENV['telegram_general_terms']             = '服务条款.';                  //面向游客的服务条款

//社交登录设置
#Telegram
$_ENV['enable_telegram_login']              = false;   //开启这个设置前请先配置 Telegram bot 否则不会生效


#工单系统设置
$_ENV['enable_ticket']        = true;        //是否开启工单系统
$_ENV['mail_ticket']          = true;        //是否开启工单邮件提醒

# Server酱 用户提交新工单或者回复工单时用微信提醒机场主 https://sct.ftqq.com/
$_ENV['useScFtqq']            = false;        //是否开启工单Server酱提醒
$_ENV['ScFtqq_SCKEY']         = '';           //请填写您在Server酱获取的SCKEY  请仔细检查勿粘贴错


#后台商品列表 销量统计
$_ENV['sales_period']         = 30;             //统计指定周期内的销量，值为【expire/任意大于0的整数】

#国旗
$_ENV['enable_flag']          = true;            //启用该项之前务必先仔细阅读教程
$_ENV['flag_regex']           = '/.*?(?=\s)/';   //从站点全名中匹配【国家/地区】的正则表达式(php版)

#捐赠
$_ENV['enable_donate']        = true;          //是否显示用户捐赠（所有收入将被公开）

#iOS账户显示
$_ENV['display_ios_class']    = -1;        //至少等级为多少的用户可以看见，小于0时关闭此功能
$_ENV['display_ios_topup']    = 0;         //满足等级要求后，累计充值高于多少的用户可以看见
$_ENV['ios_account']          = '';        //iOS账户
$_ENV['ios_password']         = '';        //iOS密码

#用户中心首页添加其他客户端的支持，可配合 subconverter 等 Api
$_ENV['userCenterClient']     = [
    'iOS'     => [
        [
            'name'           => 'Loon',
            'support'        => 'SS/SSR/VMess',
            'download_urls'  => [
                [
                    'name' => '本站下载',
                    'url'  => 'https://google.com',
                ],
                [
                    'name' => '官方下载',
                    'url'  => 'https://baidu.com',
                ]
            ],
            'tutorial_url'   => '/doc/#/iOS/Loon',
            'description'    => '其他说明.',
            'subscribe_urls' => [
                [
                    'name' => 'SS 订阅',
                    'type' => 'href',
                    'url'  => '%userUrl%?sub=2',
                ],
                [
                    'name' => 'SSR 订阅',
                    'type' => 'href',
                    'url'  => '%userUrl%?sub=1',
                ],
                [
                    'name' => 'V2Ray 订阅',
                    'type' => 'copy',
                    'url'  => '%userUrl%?sub=3',
                ]
            ]
        ]
    ],
    'macOS'   => [],
    'Linux'   => [],
    'Router'  => [],
    'Android' => [],
    'Windows' => [
        [
            'name'           => 'Netch',
            'support'        => 'SS/SSR/VMess',
            'download_urls'  => [
                [
                    'name' => '官方下载',
                    'url'  => 'https://github.com/NetchX/Netch/releases',
                ]
            ],
            'tutorial_url'   => '/doc/#/Windows/Netch',
            'description'    => '其他说明.',
            'subscribe_urls' => [
                [
                    'name' => 'SS 订阅',
                    'type' => 'href',
                    'url'  => '%userUrl%?sub=2',
                ],
                [
                    'name' => 'SSR 订阅',
                    'type' => 'href',
                    'url'  => '%userUrl%?sub=1',
                ],
                [
                    'name' => 'V2Ray 订阅',
                    'type' => 'copy',
                    'url'  => '%userUrl%?sub=3',
                ]
            ]
        ]
    ]
];

//节点检测-----------------------------------------------------------------------------------------------
#GFW检测，请通过crontab进行【开启/关闭】
$_ENV['detect_gfw_interval']             = 3600;                                                               //检测间隔，单位：秒，低于推荐值会爆炸
$_ENV['detect_gfw_port']                 = 22;                                                                 //所有节点服务器都打开的TCP端口，常用的为22（SSH端口）
$_ENV['detect_gfw_url']                  = 'http://cn-sh-tcping.sspanel.org:8080/tcping?ip={ip}&port={port}'; //检测节点是否被gfw墙了的API的URL
$_ENV['detect_gfw_judge']                = '$json_tcping[\'status\']=="true"';                                 //判断是否被墙的依据，json_tcping为上方URL返回的json数组
$_ENV['detect_gfw_count']                = '3';                                                                //尝试次数

#离线检测
$_ENV['enable_detect_offline']           = true;
#离线检测是否推送到Server酱 请配置好上文的Server配置
$_ENV['enable_detect_offline_useScFtqq'] = false;

//V2Ray相关设置------------------------------------------------------------------------------------------
$_ENV['v2ray_port']     = 443;                  //V2Ray端口
$_ENV['v2ray_protocol'] = 'HTTP/2 + TLS';       //V2Ray协议
$_ENV['v2ray_alter_id'] = 32;
$_ENV['v2ray_level']    = 0;

//以下所有均为高级设置（一般用不上，不用改---------------------------------------------------------------------

// 主站是否提供 WebAPI
// - 为了安全性，推荐使用 WebAPI 模式对接节点并关闭公网数据库连接。
// - 如果您全部节点使用数据库连接或者拥有独立的 WebAPI 站点或 Seed，则可设为 false。
$_ENV['WebAPI']     = true;

#杂项
$_ENV['authDriver']             = 'cookie';            //不能更改此项
$_ENV['pwdMethod']              = 'md5';               //密码加密 可选 md5, sha256, bcrypt, argon2i, argon2id（argon2i需要至少php7.2）
$_ENV['salt']                   = '';                  //推荐配合 md5/sha256， bcrypt/argon2i/argon2id 会忽略此项
$_ENV['sessionDriver']          = 'cookie';            //可选: cookie
$_ENV['cacheDriver']            = 'cookie';            //可选: cookie
$_ENV['tokenDriver']            = 'db';                //可选: db

$_ENV['enable_login_bind_ip']   = false;        //是否将登陆线程和IP绑定
$_ENV['rememberMeDuration']     = 7;           //登录时记住账号时长天数

$_ENV['timeZone']               = 'PRC';                 //PRC 天朝时间  UTC 格林时间
$_ENV['theme']                  = 'material';            //默认主题
$_ENV['jump_delay']             = 1200;                  //跳转延时，单位ms，不建议太长

$_ENV['checkNodeIp']            = true;                 //是否webapi验证节点ip
$_ENV['muKeyList']              = [];                   //多 key 列表
$_ENV['keep_connect']           = false;               // 流量耗尽用户限速至 1Mbps
$_ENV['money_from_admin']       = false;            //是否开启管理员修改用户余额时创建充值记录

#Cloudflare
$_ENV['cloudflare_enable']      = false;         //是否开启 Cloudflare 解析
$_ENV['cloudflare_email']       = '';            //Cloudflare 邮箱地址
$_ENV['cloudflare_key']         = '';            //Cloudflare API Key
$_ENV['cloudflare_name']        = '';            //域名

#是否夹带统计代码，自己在 resources/views/{主题名} 下创建一个 analytics.tpl ，如果有必要就用 literal 界定符
$_ENV['enable_analytics_code']  = false;

#在套了CDN之后获取用户真实ip，如果您不知道这是什么，请不要乱动
$_ENV['cdn_forwarded_ip'] = array('HTTP_X_FORWARDED_FOR', 'HTTP_ALI_CDN_REAL_IP', 'X-Real-IP', 'True-Client-Ip');
foreach ($_ENV['cdn_forwarded_ip'] as $cdn_forwarded_ip) {
    if (isset($_SERVER[$cdn_forwarded_ip])) {
        $list = explode(',', $_SERVER[$cdn_forwarded_ip]);
        $_SERVER['REMOTE_ADDR'] = $list[0];
        break;
    }
}

// https://sentry.io for production debugging
$_ENV['sentry_dsn'] = '';

// ClientDownload 命令解决 API 访问频率高而被限制使用的 Github access token
$_ENV['github_access_token'] = '';

$_ENV['php_user_group'] = 'www:www';