.config.example.php 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. <?php
  2. //基本设置--------------------------------------------------------------------------------------------
  3. $_ENV['key'] = 'ChangeMe'; //Cookie加密密钥,请务必修改此key为随机字符串
  4. $_ENV['pwdMethod'] = 'bcrypt'; //密码加密 可选 bcrypt, argon2i, argon2id
  5. $_ENV['salt'] = ''; //bcrypt/argon2i/argon2id 会忽略此项
  6. $_ENV['debug'] = false; //debug模式开关,生产环境请保持为false
  7. $_ENV['appName'] = 'SSPanel-UIM'; //站点名称
  8. $_ENV['baseUrl'] = 'https://example.com'; //站点地址,必须以https://开头,不要以/结尾
  9. // WebAPI
  10. $_ENV['webAPI'] = true; //是否开启WebAPI功能
  11. $_ENV['webAPIUrl'] = $_ENV['baseUrl']; //WebAPI地址,如需和站点地址相同,请不要修改
  12. $_ENV['muKey'] = 'ChangeMe'; //WebAPI密钥,用于节点服务端与面板通信,请务必修改此key为随机字符串
  13. $_ENV['checkNodeIp'] = true; //是否webapi验证节点ip
  14. //数据库设置-------------------------------------------------------------------------------------------
  15. // db_host|db_socket 二选一,若设置 db_socket 则 db_host 会被忽略,不用请留空。若数据库在本机上推荐用 db_socket。
  16. // db_host 例: localhost(可解析的主机名), 127.0.0.1(IP 地址), 10.0.0.2:4406(含端口)
  17. // db_socket 例:/var/run/mysqld/mysqld.sock(需使用绝对地址)
  18. $_ENV['db_driver'] = 'mysql';
  19. $_ENV['db_host'] = '';
  20. $_ENV['db_socket'] = '';
  21. $_ENV['db_database'] = 'sspanel'; //数据库名
  22. $_ENV['db_username'] = 'root'; //数据库用户名
  23. $_ENV['db_password'] = 'sspanel'; //用户名对应的密码
  24. $_ENV['db_port'] = '3306'; //端口
  25. #高级
  26. $_ENV['db_charset'] = 'utf8mb4';
  27. $_ENV['db_collation'] = 'utf8mb4_unicode_ci';
  28. $_ENV['db_prefix'] = '';
  29. //Redis设置-------------------------------------------------------------------------------------------
  30. $_ENV['redis_host'] = '127.0.0.1'; //Redis地址,使用unix domain socket时填写文件路径
  31. $_ENV['redis_port'] = 6379; //Redis端口,使用unix domain socket时填写-1
  32. $_ENV['redis_connect_timeout'] = 2.0; //Redis连接超时时间,单位秒
  33. $_ENV['redis_read_timeout'] = 8.0; //Redis读取超时时间,单位秒
  34. $_ENV['redis_username'] = ''; //Redis用户名,留空则不使用用户名连接
  35. $_ENV['redis_password'] = ''; //Redis密码,留空则无密码
  36. $_ENV['redis_ssl'] = false; //是否使用SSL连接Redis,如果使用了SSL,那么Redis端口应为Redis实例的TLS端口
  37. $_ENV['redis_ssl_context'] = []; //使用SSL时的上下文选项,参考 https://www.php.net/manual/zh/context.ssl.php
  38. //Rate Limit设置--------------------------------------------------------------------------------------------
  39. $_ENV['enable_rate_limit'] = true; //是否开启请求限制
  40. $_ENV['rate_limit_ip'] = 120; //每分钟每个IP的全局请求限制
  41. $_ENV['rate_limit_sub'] = 30; //每分钟每个用户的订阅链接请求限制
  42. $_ENV['rate_limit_webapi'] = 600; //每分钟每个节点WebAPI密钥请求限制
  43. $_ENV['rate_limit_user_api'] = 60; //每分钟每个用户的API请求限制
  44. $_ENV['rate_limit_admin_api'] = 60; //每分钟每个管理员的API请求限制
  45. //邮件设置--------------------------------------------------------------------------------------------
  46. $_ENV['mail_filter'] = 0; //0: 关闭; 1: 白名单模式; 2; 黑名单模式;
  47. $_ENV['mail_filter_list'] = [];
  48. //已注册用户设置---------------------------------------------------------------------------------------
  49. #基础
  50. $_ENV['enable_checkin'] = true; //是否啓用簽到功能
  51. $_ENV['checkinMin'] = 1; //用户签到最少流量 单位MB
  52. $_ENV['checkinMax'] = 50; //用户签到最多流量
  53. #高级
  54. $_ENV['class_expire_reset_traffic'] = 0; //等级到期时重置为的流量值,单位GB,小于0时不重置
  55. $_ENV['enable_kill'] = true; //是否允许用户注销账户
  56. $_ENV['enable_change_email'] = true; //是否允许用户更改賬戶郵箱
  57. #用户流量余量不足邮件提醒
  58. $_ENV['notify_limit_mode'] = false; //false为关闭,per为按照百分比提醒,mb为按照固定剩余流量提醒
  59. $_ENV['notify_limit_value'] = 500; //当上一项为per时,此处填写百分比;当上一项为mb时,此处填写流量
  60. //订阅设置---------------------------------------------------------------------------------------
  61. $_ENV['Subscribe'] = true; //本站是否提供订阅功能
  62. $_ENV['subUrl'] = $_ENV['baseUrl']; //订阅地址,如需和站点名称相同,请不要修改
  63. $_ENV['sub_token_len'] = 16; //订阅token长度
  64. //审计自动封禁设置--------------------------------------------------------------------------------------------
  65. $_ENV['auto_detect_ban_allow_admin'] = true; // 管理员不受审计限制
  66. $_ENV['auto_detect_ban_allow_users'] = []; // 审计封禁的例外用户 ID
  67. $_ENV['auto_detect_ban_number'] = 30; // 每次执行封禁所需的触发次数
  68. $_ENV['auto_detect_ban_time'] = 60; // 每次封禁的时长 (分钟)
  69. //节点检测-----------------------------------------------------------------------------------------------
  70. #GFW检测
  71. $_ENV['detect_gfw_port'] = 443; //所有节点服务器都打开的TCP端口
  72. $_ENV['detect_gfw_url'] = 'http://example.com:8080/v1/tcping?ip={ip}&port={port}'; //检测节点是否被gfw墙了的API的URL
  73. #离线检测
  74. $_ENV['enable_detect_offline'] = true;
  75. //高级设置-----------------------------------------------------------------------------------------------
  76. $_ENV['enable_login_bind_ip'] = true; //是否将登陆线程和IP绑定
  77. $_ENV['enable_login_bind_device'] = true; //是否将登陆线程和设备绑定
  78. $_ENV['rememberMeDuration'] = 7; //登录时记住账号时长天数
  79. $_ENV['timeZone'] = 'Asia/Taipei'; //需使用 PHP 兼容的时区格式
  80. $_ENV['theme'] = 'tabler'; //默认主题
  81. $_ENV['locale'] = 'zh-TW'; //默认语言
  82. $_ENV['jump_delay'] = 1200; //跳转延时,单位ms
  83. $_ENV['keep_connect'] = false; // 流量耗尽用户限速至 1Mbps
  84. // cdn.jsdelivr.net / fastly.jsdelivr.net / gcore.jsdelivr.net / testingcf.jsdelivr.net
  85. $_ENV['jsdelivr_url'] = 'fastly.jsdelivr.net';
  86. // https://sentry.io for production debugging
  87. $_ENV['sentry_dsn'] = '';
  88. // Maxmind GeoIP2 database
  89. $_ENV['maxmind_license_key'] = '';
  90. $_ENV['geoip_locale'] = 'en';
  91. // Large language model powered ticket reply and more
  92. $_ENV['llm_backend'] = 'openai'; // openai/palm/huggingface/cf-workers-ai
  93. // OpenAI ChatGPT
  94. $_ENV['openai_api_key'] = '';
  95. $_ENV['openai_model'] = 'gpt-3.5-turbo-1106';
  96. // Google PaLM API
  97. $_ENV['palm_api_key'] = '';
  98. $_ENV['palm_text_model'] = 'text-bison-001';
  99. // Hugging Face Inference API
  100. $_ENV['huggingface_api_key'] = '';
  101. $_ENV['huggingface_endpoint_url'] = '';
  102. // Cloudflare Workers AI
  103. $_ENV['cf_workers_ai_account_id'] = '';
  104. $_ENV['cf_workers_ai_api_token'] = '';
  105. $_ENV['cf_workers_ai_model_id'] = '@cf/meta/llama-2-7b-chat-int8';
  106. // ClientDownload 命令解决 API 访问频率高而被限制使用的 Github access token
  107. $_ENV['github_access_token'] = '';
  108. // use Cloudflare R2 for clients download
  109. $_ENV['enable_r2_client_download'] = false;
  110. $_ENV['r2_bucket_name'] = '';
  111. $_ENV['r2_account_id'] = '';
  112. $_ENV['r2_access_key_id'] = '';
  113. $_ENV['r2_access_key_secret'] = '';
  114. $_ENV['r2_client_download_timeout'] = 10;