.env.example 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. #####################################################################
  2. # 注意事项
  3. #
  4. # - 环境变量的格式为“键=值”,顶格写,注意等号两边不能有空格,值可以用单引号或者双引号引起来,不引也行(下面的特殊情况必须引起来)
  5. # - 因为环境变量中“#”代表注释,若密码中存在“#”字符的,一定要使用单引号将整个密码引起来,否则解析会在“#”字符前截止,如果密码中存在单双引号的,
  6. # 需要在单双引号前加“\”转义
  7. # - 配置多账户不可省略单引号,且多个账户和密码的格式必须是“<账户1>@<密码1>|<账户2>@<密码2>|<账户3>@<密码3>”,不要有空格,就算有程序也会给你干掉
  8. # e.g. MULTIPLE_ACCOUNTS='<账户1>@<密码1>|<账户2>@<密码2>|<账户3>@<密码3>'
  9. # 注意不要省略“<>”符号,否则无法正确匹配
  10. # - 若你只有单个账户,只配置 FREENOM_USERNAME 和FREENOM_PASSWORD 就够了
  11. # - 单账户和多账户的配置会被合并在一起读取并去重
  12. #####################################################################
  13. # .env 文件版本
  14. ENV_FILE_VERSION='v2.6'
  15. ###################### 账户配置 Account config #########################
  16. # Freenom 账户 Freenom Account
  17. FREENOM_USERNAME=''
  18. # Freenom 密码 Freenom password
  19. FREENOM_PASSWORD=''
  20. # 多账户支持 Support for multiple accounts
  21. MULTIPLE_ACCOUNTS=''
  22. # 【可选】 Freenom 代理 [Optional] Freenom proxy e.g. http://127.0.0.1:1081 or socks5://127.0.0.1:1080
  23. FREENOM_PROXY=''
  24. ###################### end 账户配置 #########################
  25. ###################### 通知邮件配置 Email config #########################
  26. # 机器人邮箱账户 Email of robot
  27. MAIL_USERNAME=''
  28. # 机器人邮箱密码(Gmail 填应用专用密码,QQ 邮箱或 163 邮箱填授权码) Password of the robot email
  29. MAIL_PASSWORD=''
  30. # 用于接收通知的邮箱 Email address used to receive notifications
  31. TO=''
  32. # 是否启用邮件推送功能 1:启用 0:不启用 Whether to enable email push features 1: enabled 0: not enabled
  33. MAIL_ENABLE=0
  34. # 【可选】 自定义邮箱配置 [Optional] Custom email config
  35. # 如果你想使用除“QQ邮箱、163邮箱、Gmail、Outlook邮箱”以外的邮箱或者自建邮箱服务作为机器人邮箱,可以自定义邮箱配置,否则请不要配置这些项
  36. # If you want to use mailboxes other than "QQ mailbox, 163 mailbox, Gmail, Outlook mailbox" or self-built mailbox service as robot mailbox, you can customize mailbox configuration, otherwise, please don't configure these items.
  37. # 【可选】 SMTP 服务器 [Optional] SMTP server e.g. smtp.gmail.com
  38. MAIL_HOST=''
  39. # 【可选】 SMTP 端口号,一般是 587 或者 465 [Optional] SMTP port number, usually 587 or 465
  40. MAIL_PORT=''
  41. # 【可选】 邮件加密方式,一般是 tls 或者 ssl 或者 starttls [Optional] Mail encryption method, usually tls or ssl or starttls
  42. MAIL_ENCRYPTION=''
  43. # end 自定义邮箱配置 end of custom email config
  44. ###################### end 通知邮件配置 #########################
  45. ###################### Telegram bot #########################
  46. # 通过 Telegram bot 发送通知消息 Send messages via Telegram bot
  47. # 你的 chat_id,通过发送“/start”给 @userinfobot 可以获取自己的 id Your chat_id, you can get your own id by sending "/start" to @userinfobot
  48. TELEGRAM_CHAT_ID=''
  49. # 你的 Telegram bot 的 token Token for your Telegram bot
  50. TELEGRAM_BOT_TOKEN=''
  51. # 【可选】 Telegram 代理 [Optional] Telegram proxy e.g. http://127.0.0.1:1081 or socks5://127.0.0.1:1080
  52. TELEGRAM_PROXY=''
  53. # 【可选】 自建 Telegram 反向代理地址,不明白则请忽略此配置项,保持默认即可 [Optional] Please do not modify this item
  54. # 参考:https://web.archive.org/web/20220221035315/https://hostloc.com/thread-805441-1-1.html
  55. # 只要是一个合法的网址即可,程式会自动提取网址的主机部分。例如 https://xxx.xx.workers.dev/ or xxx.xx.xx
  56. CUSTOM_TELEGRAM_HOST='api.telegram.org'
  57. # 是否启用 Telegram Bot 功能 1:启用 0:不启用 Whether to enable Telegram Bot features 1: enabled 0: not enabled
  58. TELEGRAM_BOT_ENABLE=0
  59. ###################### end Telegram bot #########################
  60. ###################### 企业微信 #########################
  61. # 企业 ID Corporate ID
  62. WECHAT_CORP_ID=''
  63. # 应用的凭证密钥 Credential keys for enterprise WeChat applications
  64. WECHAT_CORP_SECRET=''
  65. # 应用 ID
  66. WECHAT_AGENT_ID=''
  67. # 是否启用企业微信送信功能 1:启用 0:不启用 Whether to enable the enterprise WeChat message push function 1: Enable 0: Do not enable
  68. WECHAT_ENABLE=0
  69. ###################### end 企业微信 #########################
  70. ###################### Server 酱 #########################
  71. # Server 酱的 SendKey
  72. SCT_SEND_KEY=''
  73. # 是否启用 Server 酱 送信功能 1:启用 0:不启用 Whether to enable the ServerChan message function 1: enabled 0: not enabled
  74. SCT_ENABLE=0
  75. ###################### end Server 酱 #########################
  76. ###################### Bark 送信 #########################
  77. # Bark key 打开 Bark App,注册设备后看到的 key Open the Bark App, register the device and see the key
  78. # 支持直接粘贴 “https://api.day.app/xxx/这里改成你自己的推送内容” 这类文本,程序会自动从中提取有效的 Bark key Support direct paste "https://api.day.app/xxx/这里改成你自己的推送内容" type of text, the program will automatically extract the valid Bark key from it
  79. BARK_KEY=''
  80. # Bark 域名 默认是 Bark 作者提供的服务,建议自建 The Bark URL defaults to the server provided by the Bark author, and it is recommended to build your own
  81. BARK_URL='https://api.day.app'
  82. # Bark 其它相关参数(保持默认即可)
  83. BARK_IS_ARCHIVE=''
  84. BARK_GROUP='FreeNom'
  85. BARK_LEVEL='active'
  86. BARK_ICON='https://q2.qlogo.cn/headimg_dl?dst_uin=593198779&spec=100'
  87. BARK_JUMP_URL=''
  88. BARK_SOUND='gotosleep'
  89. # 是否启用 Bark 推送消息 1:启用 0:不启用 Whether to enable Bark push messaging 1: Enable 0: Do not enable
  90. BARK_ENABLE=0
  91. ###################### end Bark 送信 #########################
  92. # 通知频率 0:仅当有续期操作的时候 1:每次执行 Notification frequency 0: Only when there is a renewal operation 1: Each execution
  93. NOTICE_FREQ=1
  94. # 是否验证服务器证书 1:验证 0:不验证 Whether to verify the server certificate 1: verify 0: no verification
  95. VERIFY_SSL=0
  96. # 是否开启 Debug 模式 1:开启 0:关闭 Whether to turn on Debug mode 1: On 0: Off
  97. DEBUG=0
  98. # 检测是否有新版本可用,发现新版本时推送消息通知 1:开启 0:关闭 Automatically detects if a new version is available and pushes a message notification when a new version is found 1: On 0: Off
  99. NEW_VERSION_DETECTION=1
  100. # 应用语言配置 Application language configuration, the supported values are zh or en, zh means Chinese, en means English
  101. CUSTOM_LANGUAGE=zh
  102. # 送信时是否显示服务器信息 1:显示 0:不显示 Whether to display server information when sending messages 1: Display 0: Do not display
  103. SHOW_SERVER_INFO=0
  104. # 是否给敏感信息打码 1:启用 0:不启用 Whether to enable the obfuscation of sensitive information 1: Enabled 0: Not enabled
  105. MOSAIC_SENSITIVE_INFO=0