diff --git a/neutrino-proxy-client/src/main/resources/app.yml b/neutrino-proxy-client/src/main/resources/app.yml index 01a69240..86eb7ef3 100644 --- a/neutrino-proxy-client/src/main/resources/app.yml +++ b/neutrino-proxy-client/src/main/resources/app.yml @@ -3,8 +3,6 @@ neutrino: name: neutrino-proxy-client proxy: - logger: - level: ${LOG_LEVEL:info} protocol: max-frame-length: 2097152 length-field-offset: 0 @@ -14,17 +12,30 @@ neutrino: read-idle-time: 8 write-idle-time: 3 all-idle-time-seconds: 8 + logger: + # 日志级别 + level: ${LOG_LEVEL:info} client: + # 线程池相关配置,用于技术调优,可忽略 thread-count: 50 + # 隧道SSL证书配置 key-store-password: ${STORE_PASS:123456} jks-path: ${JKS_PATH:classpath:/test.jks} + # 服务端IP server-ip: ${SERVER_IP:localhost} + # 服务端端口(对应服务端app.yml中的tunnel.port、tunnel.ssl-port) server-port: ${SERVER_PORT:9002} + # 是否启用SSL(注意:该配置必须和server-port对应上) ssl-enable: ${SSL_ENABLE:true} - obtain-license-interval: 5 + # 客户端连接唯一凭证 license-key: ${LICENSE_KEY:} + # 客户端唯一身份标识(可忽略,若不设置首次启动会自动生成) client-id: ${CLIENT_ID:} + # 是否开启隧道传输报文日志(日志级别为debug时开启才有效) transfer-log-enable: ${CLIENT_LOG:false} + # 重连设置 reconnection: + # 重连间隔(秒) interval-seconds: 10 + # 是否开启无限重连(未开启时,客户端license不合法会自动停止应用,开启了则不会,请谨慎开启) unlimited: false diff --git a/neutrino-proxy-server/src/main/resources/app.yml b/neutrino-proxy-server/src/main/resources/app.yml index a2b4ec2c..8da747a5 100644 --- a/neutrino-proxy-server/src/main/resources/app.yml +++ b/neutrino-proxy-server/src/main/resources/app.yml @@ -1,10 +1,9 @@ server: + # 服务端web端口,用于支持HTTP接口,管理后台页面访问 port: ${WEB_PORT:8888} neutrino: proxy: - logger: - level: ${LOG_LEVEL:info} protocol: max-frame-length: ${MAX_FRAME_LENGTH:2097152} length-field-offset: 0 @@ -14,30 +13,48 @@ neutrino: read-idle-time: 30 write-idle-time: 5 all-idle-time-seconds: 0 + logger: + # 日志级别 + level: ${LOG_LEVEL:info} + # 隧道相关配置-用于维持服务端与客户端的通信 tunnel: + # 线程池相关配置,用于技术调优,可忽略 boss-thread-count: 2 work-thread-count: 10 + # 隧道非SSL端口 port: ${OPEN_PORT:9000} + # 隧道SSL端口 ssl-port: ${SSL_PORT:9002} + # 隧道SSL证书配置 key-store-password: ${STORE_PASS:123456} key-manager-password: ${MGR_PASS:123456} jks-path: ${JKS_PATH:classpath:/test.jks} + # 是否开启隧道传输报文日志(日志级别为debug时开启才有效) transfer-log-enable: ${TUNNEL_LOG:false} server: + # 线程池相关配置,用于技术调优,可忽略 boss-thread-count: 5 work-thread-count: 20 + # http代理端口,默认80 http-proxy-port: ${HTTP_PROXY_PORT:80} + # https代理端口,默认443 (需要配置域名、证书) https-proxy-port: ${HTTPS_PROXY_PORT:443} # 如果不配置,则不支持域名映射 domain-name: ${DOMAIN_NAME:} + # https证书配置 key-store-password: ${HTTPS_STORE_PASS:} jks-path: ${HTTPS_JKS_PATH:} + # 是否开启代理服务报文日志(日志级别为debug时开启才有效) transfer-log-enable: ${SERVER_LOG:false} data: db: + # 数据库类型,目前支持sqlite、mysql、mariadb type: ${DB_TYPE:sqlite} + # 数据库连接URL url: ${DB_URL:jdbc:sqlite:data.db} + # 数据库用户名 username: ${DB_USER:} + # 数据库密码 password: ${DB_PASSWORD:} #添加MIME印射(如果有需要?) diff --git a/neutrino-proxy-vuepress/docs/01.使用教程/01.开始使用/06.服务端配置.md b/neutrino-proxy-vuepress/docs/01.使用教程/01.开始使用/06.服务端配置.md index 5f4c249b..dafff141 100644 --- a/neutrino-proxy-vuepress/docs/01.使用教程/01.开始使用/06.服务端配置.md +++ b/neutrino-proxy-vuepress/docs/01.使用教程/01.开始使用/06.服务端配置.md @@ -19,6 +19,9 @@ server: neutrino: proxy: + logger: + # 日志级别 + level: ${LOG_LEVEL:info} # 隧道相关配置-用于维持服务端与客户端的通信 tunnel: # 线程池相关配置,用于技术调优,可忽略 @@ -32,7 +35,8 @@ neutrino: key-store-password: ${STORE_PASS:123456} key-manager-password: ${MGR_PASS:123456} jks-path: ${JKS_PATH:classpath:/test.jks} - # 代理服务相关配置 + # 是否开启隧道传输报文日志(日志级别为debug时开启才有效) + transfer-log-enable: ${TUNNEL_LOG:false} server: # 线程池相关配置,用于技术调优,可忽略 boss-thread-count: 5 @@ -46,9 +50,11 @@ neutrino: # https证书配置 key-store-password: ${HTTPS_STORE_PASS:} jks-path: ${HTTPS_JKS_PATH:} + # 是否开启代理服务报文日志(日志级别为debug时开启才有效) + transfer-log-enable: ${SERVER_LOG:false} data: db: - # 数据库类型,目前支持sqlite、mysql两种 + # 数据库类型,目前支持sqlite、mysql、mariadb type: ${DB_TYPE:sqlite} # 数据库连接URL url: ${DB_URL:jdbc:sqlite:data.db} diff --git a/neutrino-proxy-vuepress/docs/01.使用教程/01.开始使用/07.客户端配置.md b/neutrino-proxy-vuepress/docs/01.使用教程/01.开始使用/07.客户端配置.md new file mode 100644 index 00000000..c9514f00 --- /dev/null +++ b/neutrino-proxy-vuepress/docs/01.使用教程/01.开始使用/07.客户端配置.md @@ -0,0 +1,38 @@ +--- +title: 客户端配置 +date: 2023-06-09 21:15:35 +permalink: /pages/50ce10/ +--- + +# 以下是最新的客户端配置格式(app.yml) +```yml +neutrino: + proxy: + logger: + # 日志级别 + level: ${LOG_LEVEL:info} + client: + # 线程池相关配置,用于技术调优,可忽略 + thread-count: 50 + # 隧道SSL证书配置 + key-store-password: ${STORE_PASS:123456} + jks-path: ${JKS_PATH:classpath:/test.jks} + # 服务端IP + server-ip: ${SERVER_IP:localhost} + # 服务端端口(对应服务端app.yml中的tunnel.port、tunnel.ssl-port) + server-port: ${SERVER_PORT:9002} + # 是否启用SSL(注意:该配置必须和server-port对应上) + ssl-enable: ${SSL_ENABLE:true} + # 客户端连接唯一凭证 + license-key: ${LICENSE_KEY:} + # 客户端唯一身份标识(可忽略,若不设置首次启动会自动生成) + client-id: ${CLIENT_ID:} + # 是否开启隧道传输报文日志(日志级别为debug时开启才有效) + transfer-log-enable: ${CLIENT_LOG:false} + # 重连设置 + reconnection: + # 重连间隔(秒) + interval-seconds: 10 + # 是否开启无限重连(未开启时,客户端license不合法会自动停止应用,开启了则不会,请谨慎开启) + unlimited: false +```