浏览代码

chore(config): cleanup & fix typo & re-document

Anankke 5 年之前
父节点
当前提交
950849053b

+ 23 - 31
config/.config.example.php

@@ -16,24 +16,17 @@ $_ENV['version'] = 2;    //仅当涉及【需要修改config以外的文件】
 //基本设置--------------------------------------------------------------------------------------------
 $_ENV['key']        = '1145141919810';                //!!! 瞎 jb 修改此key为随机字符串确保网站安全 !!!
 $_ENV['debug']      = false;                          //正式环境请确保为 false
-$_ENV['appName']    = 'sspanel';                      //站点名称
-$_ENV['baseUrl']    = 'http://url.com';               //站点地址
+$_ENV['appName']    = 'SSPanel-UIM';                      //站点名称
+$_ENV['baseUrl']    = 'https://sspanel.host/';               //站点地址
 $_ENV['muKey']      = 'NimaQu';                       //用于校验魔改后端请求,可以随意修改,但请保持前后端一致,否则节点不能工作!
 
-// 主站是否提供 WEBAPI
-// - 如果您全部节点使用数据库连接,则保持为 false
-// - 如果您拥有独立的 Webapi 站点或 Seed 等,则保持为 false
-// - 如果您不使用数据库连接并且无独立 Webapi 站点或 Seed 等,请更改为 true
-$_ENV['Webapi']     = false;
-
 
 //数据库设置--------------------------------------------------------------------------------------------
-$_ENV['db_driver']    = 'mysql';             //数据库程序
-// 数据库网络地址(在本机上推荐用 Unix Socket, 与下面二选一, 不用则留空)
-// 例: localhost(可解析主机名), 127.0.0.1(IP 地址), 127.0.0.1:4406(含端口)
+// 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']      = '';
-// 数据库 Unix Socket 地址(优先级高于网络地址, 与上面二选一, 不用则留空)
-// 例: /var/run/mysqld/mysqld.sock(绝对地址)
 $_ENV['db_socket']    = '';
 $_ENV['db_database']  = 'sspanel';           //数据库名
 $_ENV['db_username']  = 'root';              //数据库用户名
@@ -54,14 +47,14 @@ $_ENV['mailgun_domain']  = '';
 $_ENV['mailgun_sender']  = '';
 
 # smtp
-$_ENV['smtp_host']          = '';                          // smtp 邮局服务器域
-$_ENV['smtp_username']      = '';                          // smtp 账户名
-$_ENV['smtp_port']          = 465;                         // smtp 端口(常见端口 25, 587 465)
-$_ENV['smtp_name']          = '';
-$_ENV['smtp_sender']        = '';                          // smtp 账户自定义显示名
-$_ENV['smtp_passsword']     = '';                          // stmp 账户密码
-$_ENV['smtp_ssl']           = true;                        // 支持 TLS/SSL 发信
-$_ENV['smtp_reply_to']      = $_ENV['smtp_username'];      // 当用户回复通知邮件时回复改地址
+$_ENV['smtp_host']          = '';                          // SMTP 邮局服务器域名
+$_ENV['smtp_username']      = '';                          // SMTP 账户名
+$_ENV['smtp_password']     = '';                           // SMTP 账户密码
+$_ENV['smtp_port']          = 465;                         // SMTP 端口(常见端口 25, 587 465)
+$_ENV['smtp_name']          = '';                          // SMTP 发信名称
+$_ENV['smtp_sender']        = '';                          // SMTP 账户发信地址
+$_ENV['smtp_ssl']           = true;                        // 是否使用 TLS/SSL 发信
+$_ENV['smtp_reply_to']      = $_ENV['smtp_username'];      // 用户回复邮件的接受地址
 $_ENV['smtp_reply_to_name'] = $_ENV['smtp_sender'];        // 回复地址显示名
 
 # sendgrid
@@ -72,14 +65,14 @@ $_ENV['sendgrid_name']   = '';       //发件人名称
 
 //备份设置--------------------------------------------------------------------------------------------
 $_ENV['auto_backup_email']  = '';                               //接收备份的邮箱
-$_ENV['auto_backup_passwd'] = '';                               //备份的压缩密码
+$_ENV['auto_backup_password'] = '';                               //备份的压缩密码
 $_ENV['backup_notify']      = false;                            //备份通知到TG群中
 
 
 //用户注册设置-----------------------------------------------------------------------------------------
 $_ENV['reg_auto_reset_day']        = 0;                         //注册时的流量重置日,0为不重置
 $_ENV['reg_auto_reset_bandwidth']  = 0;                         //需要重置的流量,0为不重置
-$_ENV['ramdom_group']              = '0';                       //注册时随机分组,注册时随机分配到的分组,多个分组请用英文半角逗号分隔
+$_ENV['random_group']              = '0';                       //注册时随机分组,注册时随机分配到的分组,多个分组请用英文半角逗号分隔
 
 $_ENV['reg_forbidden_ip']          = '127.0.0.0/8,::1/128';     //注册时默认禁止访问IP列表,半角英文逗号分割
 $_ENV['min_port']                  = 10000;                     //用户端口池最小值
@@ -125,29 +118,24 @@ $_ENV['notify_limit_value']         = 20;           //当上一项为per时,
 
 //订阅设置---------------------------------------------------------------------------------------
 $_ENV['Subscribe']                  = true;                         //本站是否提供订阅功能
-
 $_ENV['subUrl']                     = $_ENV['baseUrl'] . '/link/';  //订阅地址,如需和站点名称相同,请不要修改
 $_ENV['mergeSub']                   = true;                         //合并订阅设置 可选项 false / true
 $_ENV['enable_sub_extend']          = true;                         // 是否开启订阅中默认显示流量剩余以及账户到期时间以及 sub_message 中的信息
 
+
 // 订阅中的营销信息
 // 使用数组形式,将会添加在订阅列表的顶端
 // 可用于为用户推送最新地址等信息,尽可能简短且数量不宜太多
 $_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 默认配置方案
@@ -164,7 +152,6 @@ $_ENV['auto_detect_ban_allow_users'] = [];          // 审计封禁的例外用
 //   - 1 = 仁慈模式,每触碰多少次封禁一次
 //   - 2 = 疯狂模式,累计触碰次数按阶梯进行不同时长的封禁
 $_ENV['auto_detect_ban_type']        = 1;
-
 $_ENV['auto_detect_ban_number']      = 30;             // 仁慈模式每次执行封禁所需的触发次数
 $_ENV['auto_detect_ban_time']        = 60;             // 仁慈模式每次封禁的时长 (分钟)
 
@@ -195,7 +182,6 @@ $_ENV['auto_detect_ban'] = [
 //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 一下即可得到
@@ -480,6 +466,12 @@ $_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)

+ 1 - 1
src/Command/Backup.php

@@ -61,7 +61,7 @@ class Backup extends Command
 
         system('cp ' . BASE_PATH . '/config/.config.php /tmp/ssmodbackup/configbak.php', $ret);
         echo $ret;
-        $backup_passwd = $_ENV["auto_backup_passwd"] == "" ? "" : " -P " . $_ENV["auto_backup_passwd"];
+        $backup_passwd = $_ENV["auto_backup_password"] == "" ? "" : " -P " . $_ENV["auto_backup_password"];
         system('zip -r /tmp/ssmodbackup.zip /tmp/ssmodbackup/* ' . $backup_passwd, $ret);
         $subject = $_ENV['appName'] . '-备份成功';
         $text = '您好,系统已经为您自动备份,请查看附件,用您设定的密码解压。';

+ 1 - 1
src/Controllers/Admin/UserController.php

@@ -133,7 +133,7 @@ class UserController extends AdminController
         $user->plan                 = 'A';
         $user->theme                = $_ENV['theme'];
 
-        $groups = explode(',', $_ENV['ramdom_group']);
+        $groups = explode(',', $_ENV['random_group']);
 
         $user->node_group = $groups[array_rand($groups)];
 

+ 1 - 1
src/Controllers/AuthController.php

@@ -418,7 +418,7 @@ class AuthController extends BaseController
         $user->plan             = 'A';
         $user->theme            = $_ENV['theme'];
 
-        $groups                 = explode(',', $_ENV['ramdom_group']);
+        $groups                 = explode(',', $_ENV['random_group']);
 
         $user->node_group       = $groups[array_rand($groups)];
 

+ 2 - 2
src/Middleware/Mod_Mu.php

@@ -33,8 +33,8 @@ class Mod_Mu
             ]);
         }
 
-        if ($_ENV['Webapi'] === false) {
-            // 主站不提供 Webapi
+        if ($_ENV['WebAPI'] === false) {
+            // 主站不提供 WebAPI
             return $response->withJson([
                 'ret'  => 0,
                 'data' => 'We regret this service is temporarily unavailable'

+ 1 - 1
src/Services/Mail/Smtp.php

@@ -39,7 +39,7 @@ class Smtp extends Base
             'port' => $_ENV['smtp_port'],
             'sender' => $_ENV['smtp_sender'],
             'name' => $_ENV['smtp_name'],
-            'passsword' => $_ENV['smtp_passsword'],
+            'passsword' => $_ENV['smtp_password'],
             'reply_to' => $_ENV['smtp_reply_to'],
             'reply_to_name' => $_ENV['smtp_reply_to_name']
         ];

+ 3 - 3
test/config.php

@@ -59,7 +59,7 @@ $_ENV['smtp_host']          = '';                          // smtp 邮局服务
 $_ENV['smtp_username']      = '';                          // smtp 账户名
 $_ENV['smtp_port']          = 465;                         // smtp 端口(常见端口 25, 587 465)
 $_ENV['smtp_sender']        = '';                          // smtp 账户自定义显示名
-$_ENV['smtp_passsword']     = '';                          // stmp 账户密码
+$_ENV['smtp_password']     = '';                          // stmp 账户密码
 $_ENV['smtp_ssl']           = true;                        // 支持 TLS/SSL 发信
 $_ENV['smtp_reply_to']      = $_ENV['smtp_username'];      // 当用户回复通知邮件时回复改地址
 $_ENV['smtp_reply_to_name'] = $_ENV['smtp_sender'];        // 回复地址显示名
@@ -72,14 +72,14 @@ $_ENV['sendgrid_name']   = '';       //发件人名称
 
 //备份设置--------------------------------------------------------------------------------------------
 $_ENV['auto_backup_email']  = '';                               //接收备份的邮箱
-$_ENV['auto_backup_passwd'] = '';                               //备份的压缩密码
+$_ENV['auto_backup_password'] = '';                               //备份的压缩密码
 $_ENV['backup_notify']      = false;                            //备份通知到TG群中
 
 
 //用户注册设置-----------------------------------------------------------------------------------------
 $_ENV['reg_auto_reset_day']        = 0;                         //注册时的流量重置日,0为不重置
 $_ENV['reg_auto_reset_bandwidth']  = 0;                         //需要重置的流量,0为不重置
-$_ENV['ramdom_group']              = '0';                       //注册时随机分组,注册时随机分配到的分组,多个分组请用英文半角逗号分隔
+$_ENV['random_group']              = '0';                       //注册时随机分组,注册时随机分配到的分组,多个分组请用英文半角逗号分隔
 
 $_ENV['reg_forbidden_ip']          = '127.0.0.0/8,::1/128';     //注册时默认禁止访问IP列表,半角英文逗号分割
 $_ENV['min_port']                  = 10000;                     //用户端口池最小值