diff --git a/README.md b/README.md index 4ed2a3d..8f9527b 100644 --- a/README.md +++ b/README.md @@ -17,27 +17,33 @@ --- ## 主站(免费使用) + https://mixio.mixly.cn ## 私有部署发行版-v1.10.1 ### Windows-x64发行版(win10及以上) + https://gitee.com/bnu_mixly/mixio-win32-x86-dist/blob/master/mixio.exe ### Windows-x64发行版(win7) + https://gitee.com/bnu_mixly/mixio-win32-x86-dist/blob/win7/mixio.exe ### Linux-x64发行版 + https://gitee.com/bnu_mixly/mixio-linux-x86-dist/blob/master/mixio ### Linux-arm64发行版 + https://gitee.com/bnu_mixly/mixio-linux-arm64-dist/blob/master/mixio ### MacOS-x64发行版 + https://gitee.com/bnu_mixly/mixio-linux-x86-dist/blob/darwin/mixio - ## 指令说明 + 1. mixio start 启动服务器(默认在8080端口) 2. mixio stop 关闭服务器 3. mixio help 查看更多指令 @@ -45,14 +51,17 @@ https://gitee.com/bnu_mixly/mixio-linux-x86-dist/blob/darwin/mixio 5. Linux/MacOS版 可mixio install将mixio添加到systemctl中 ## 从源码运行(debug模式) + 1. git clone https://gitee.com/mixly2/mixio.git 2. node mixio.js debug ## 从源码构建 + 1. 编译脚本见pkg_tools/ 2. 基本环境:node16(windows7为node12), python3, cmake, pkg. ## 安卓端运行服务器(experimental) + 1. 安装termux(https://termux.dev/en/) 2. apt update 3. apt upgrade @@ -66,24 +75,28 @@ https://gitee.com/bnu_mixly/mixio-linux-x86-dist/blob/darwin/mixio 11. node mixio.js debug ## 服务器配置文件(config/config.json) + 1. 首次运行服务器后,会在相对应位置的config文件夹生成config.json 2. config.json内容可修改,重启服务器后生效 3. MIXIO_HTTP_PORT - int,HTTP端口,默认为8080 4. MIXIO_HTTPS_PORT - int,HTTP端口,默认为8443 -5. MAX_PROJECT_NUM_PER_USER - int,每个用户的最大项目数,默认为20 -6. MAX_MESSAGE_PER_USER - int,每个用户的最大离线消息存储数,默认为1000 -7. MAX_MESSAGE_PER_SECOND - int,每个用户每秒的最大消息数,默认为5 -8. ALLOW_REGISTER - bool,是否允许自主注册,默认为true -9. ALLOW_HOOK - bool,是否允许离线存储消息,默认为true -10. OFFLINE_MODE - bool,是否禁用天气/地图数据,默认为true -11. BAIDU_MAP_AK - string,百度地图客户端应用AK(OFFLINE_MODE=false时必须配置),默认为"" -12. BAIDU_MAP_SERVER_AK - string,百度地图服务端应用AK(OFFLINE_MODE=false时必须配置),默认为"" -13. ADMIN_USERNAME - string,管理后台用户名,默认为"admin" -14. ADMIN_PASSWORD - string,管理后台密码,默认为"public" -15. STORAGE_ENGINE - string,数据库引擎,默认为"sqlite" -16. MYSQL_HOST - string,MySQL地址(STORAGE_ENGINE="mysql"时必须配置),默认为"localhost" -17. MYSQL_PORT - int,MySQL地址(STORAGE_ENGINE="mysql"时必须配置),默认为3306 -18. MYSQL_USER - string,MySQL用户名(STORAGE_ENGINE="mysql"时必须配置),默认为"" -19. MYSQL_PASS - string,MySQL密码(STORAGE_ENGINE="mysql"时必须配置),默认为"" -20. MYSQL_DB - string,MySQL数据库名(STORAGE_ENGINE="mysql"时必须配置),默认为"mixio", -21. FOOTER - string,显示在首页的备案信息,公网部署时请务必配置此项(支持HTML语言,请注意为双引号添加转义字符\\),默认为"" \ No newline at end of file +5. MIXIO_MQTT_PORT - int, MQTT端口, 默认为1883 +6. MIXIO_WS_PORT - int, MQTT over WebSocket端口, 默认为8083 +7. MIXIO_WSS_PORT - int, MQTT over WebSocketS端口, 默认为8084 +8. MAX_PROJECT_NUM_PER_USER - int,每个用户的最大项目数,默认为20 +9. MAX_MESSAGE_PER_USER - int,每个用户的最大离线消息存储数,默认为1000 +10. MAX_MESSAGE_PER_SECOND - int,每个用户每秒的最大消息数,默认为5 +11. ALLOW_REGISTER - bool,是否允许自主注册,默认为true +12. ALLOW_HOOK - bool,是否允许离线存储消息,默认为true +13. OFFLINE_MODE - bool,是否禁用天气/地图数据,默认为true +14. BAIDU_MAP_AK - string,百度地图客户端应用AK(OFFLINE_MODE=false时必须配置),默认为"" +15. BAIDU_MAP_SERVER_AK - string,百度地图服务端应用AK(OFFLINE_MODE=false时必须配置),默认为"" +16. ADMIN_USERNAME - string,管理后台用户名,默认为"admin" +17. ADMIN_PASSWORD - string,管理后台密码,默认为"public" +18. STORAGE_ENGINE - string,数据库引擎,默认为"sqlite" +19. MYSQL_HOST - string,MySQL地址(STORAGE_ENGINE="mysql"时必须配置),默认为"localhost" +20. MYSQL_PORT - int,MySQL地址(STORAGE_ENGINE="mysql"时必须配置),默认为3306 +21. MYSQL_USER - string,MySQL用户名(STORAGE_ENGINE="mysql"时必须配置),默认为"" +22. MYSQL_PASS - string,MySQL密码(STORAGE_ENGINE="mysql"时必须配置),默认为"" +23. MYSQL_DB - string,MySQL数据库名(STORAGE_ENGINE="mysql"时必须配置),默认为"mixio", +24. FOOTER - string,显示在首页的备案信息,公网部署时请务必配置此项(支持HTML语言,请注意为双引号添加转义字符\\),默认为"" diff --git a/ejs/manage.ejs b/ejs/manage.ejs index 6353086..24adaa7 100644 --- a/ejs/manage.ejs +++ b/ejs/manage.ejs @@ -183,6 +183,30 @@ +