From 14d08acf964093276b711a2fc88f6f545a3afb68 Mon Sep 17 00:00:00 2001 From: pader Date: Tue, 21 Mar 2023 20:03:28 +0800 Subject: [PATCH] update README.md --- README.md | 10 +++++++ README_ZH.md | 76 +++++++++++++++++++++++++++++----------------------- 2 files changed, 52 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 5f15901..51af8bf 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,16 @@ This project contains a Docker image meant to facilitate the deployment of [Naco [**中文**](README_ZH.md) +## Note + +The following environment variables have been **removed** from the default values in the new version(**Nacos 2.2.1**) +for the sake of **system security**, please add them yourself when starting up, otherwise an error will be reported at +startup. + +1. ~~NACOS_AUTH_IDENTITY_KEY~~ +2. ~~NACOS_AUTH_IDENTITY_VALUE~~ +3. ~~NACOS_AUTH_TOKEN~~ + ## Project directory * build：Nacos makes the source code of the docker image diff --git a/README_ZH.md b/README_ZH.md index 7ea84ea..debff9a 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -2,6 +2,14 @@ 本项目是 [Nacos](https://github.com/alibaba/nacos) Server的docker镜像的build源码,以及Nacos server 在docker的单机和集群的运行例子. +## 注意 + +从Nacos 2.2.1开始为了系统安全考虑**移除**了以下环境变量的默认值,启动时请自行添加,否则会启动报错. + +1. ~~NACOS_AUTH_IDENTITY_KEY~~ +2. ~~NACOS_AUTH_IDENTITY_VALUE~~ +3. ~~NACOS_AUTH_TOKEN~~ + ## 项目目录 * build：nacos 镜像制作的源码 @@ -128,40 +136,40 @@ ## 属性配置列表 -| 属性名称 | 描述 | 选项 | -| --------------------------------------- | -------------------------------------------------- | ------------------------------------------------------------ | -| MODE | 系统启动方式: 集群/单机 | cluster/standalone 默认 **cluster** | -| NACOS_SERVERS | 集群地址 | p1:port1空格ip2:port2 空格ip3:port3 | -| PREFER_HOST_MODE | 支持IP还是域名模式 | hostname/ip 默认**IP** | -| NACOS_SERVER_PORT | Nacos 运行端口 | 默认**8848** | -| NACOS_SERVER_IP | 多网卡模式下可以指定IP | | -| SPRING_DATASOURCE_PLATFORM | 单机模式下支持MYSQL数据库 | mysql / 空 默认:空 | -| MYSQL_SERVICE_HOST | 数据库 连接地址 | | -| MYSQL_SERVICE_PORT | 数据库端口 | 默认 : **3306** | -| MYSQL_SERVICE_DB_NAME | 数据库库名 | | -| MYSQL_SERVICE_USER | 数据库用户名 | | -| MYSQL_SERVICE_PASSWORD | 数据库用户密码 | | -| MYSQL_SERVICE_DB_PARAM | 数据库连接参数 | 默认:**characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useSSL=false** | -| MYSQL_DATABASE_NUM | 数据库个数 | 默认:**1** | -| JVM_XMS | -Xms | 默认 :1g | -| JVM_XMX | -Xmx | 默认 :1g | -| JVM_XMN | -Xmn | 512m | -| JVM_MS | - XX:MetaspaceSize | 默认 :128m | -| JVM_MMS | -XX:MaxMetaspaceSize | 默认 :320m | -| NACOS_DEBUG | 是否开启远程DEBUG | y/n 默认 :n | -| TOMCAT_ACCESSLOG_ENABLED | server.tomcat.accesslog.enabled | 默认 :false | -| NACOS_AUTH_SYSTEM_TYPE | 权限系统类型选择,目前只支持nacos类型 | 默认 :nacos | -| NACOS_AUTH_ENABLE | 是否开启权限系统 | 默认 :false | -| NACOS_AUTH_TOKEN_EXPIRE_SECONDS | token 失效时间 | 默认 :18000 | -| NACOS_AUTH_TOKEN | token | | -| NACOS_AUTH_CACHE_ENABLE | 权限缓存开关 ,开启后权限缓存的更新默认有15秒的延迟 | 默认 : false | -| MEMBER_LIST | 通过环境变量的方式设置集群地址 | 例子:192.168.16.101:8847?raft_port=8807,192.168.16.101?raft_port=8808,192.168.16.101:8849?raft_port=8809 | -| EMBEDDED_STORAGE | 是否开启集群嵌入式存储模式 | `embedded` 默认 : none | -| NACOS_AUTH_CACHE_ENABLE | nacos.core.auth.caching.enabled | default : false | -| NACOS_AUTH_USER_AGENT_AUTH_WHITE_ENABLE | nacos.core.auth.enable.userAgentAuthWhite | default : false | -| NACOS_AUTH_IDENTITY_KEY | nacos.core.auth.server.identity.key | | -| NACOS_AUTH_IDENTITY_VALUE | nacos.core.auth.server.identity.value | | -| NACOS_SECURITY_IGNORE_URLS | nacos.security.ignore.urls | default : `/,/error,/**/*.css,/**/*.js,/**/*.html,/**/*.map,/**/*.svg,/**/*.png,/**/*.ico,/console-fe/public/**,/v1/auth/**,/v1/console/health/**,/actuator/**,/v1/console/server/**` | +| 属性名称 | 描述 | 选项 | +|-----------------------------------------|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MODE | 系统启动方式: 集群/单机 | cluster/standalone 默认 **cluster** | +| NACOS_SERVERS | 集群地址 | p1:port1空格ip2:port2 空格ip3:port3 | +| PREFER_HOST_MODE | 支持IP还是域名模式 | hostname/ip 默认**IP** | +| NACOS_SERVER_PORT | Nacos 运行端口 | 默认**8848** | +| NACOS_SERVER_IP | 多网卡模式下可以指定IP | | +| SPRING_DATASOURCE_PLATFORM | 单机模式下支持MYSQL数据库 | mysql / 空 默认:空 | +| MYSQL_SERVICE_HOST | 数据库 连接地址 | | +| MYSQL_SERVICE_PORT | 数据库端口 | 默认 : **3306** | +| MYSQL_SERVICE_DB_NAME | 数据库库名 | | +| MYSQL_SERVICE_USER | 数据库用户名 | | +| MYSQL_SERVICE_PASSWORD | 数据库用户密码 | | +| MYSQL_SERVICE_DB_PARAM | 数据库连接参数 | 默认:**characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useSSL=false** | +| MYSQL_DATABASE_NUM | 数据库个数 | 默认:**1** | +| JVM_XMS | -Xms | 默认 :1g | +| JVM_XMX | -Xmx | 默认 :1g | +| JVM_XMN | -Xmn | 512m | +| JVM_MS | - XX:MetaspaceSize | 默认 :128m | +| JVM_MMS | -XX:MaxMetaspaceSize | 默认 :320m | +| NACOS_DEBUG | 是否开启远程DEBUG | y/n 默认 :n | +| TOMCAT_ACCESSLOG_ENABLED | server.tomcat.accesslog.enabled | 默认 :false | +| NACOS_AUTH_SYSTEM_TYPE | 权限系统类型选择,目前只支持nacos类型 | 默认 :nacos | +| NACOS_AUTH_ENABLE | 是否开启权限系统 | 默认 :false | +| NACOS_AUTH_TOKEN_EXPIRE_SECONDS | token 失效时间 | 默认 :18000 | +| NACOS_AUTH_TOKEN | token | | +| NACOS_AUTH_CACHE_ENABLE | 权限缓存开关 ,开启后权限缓存的更新默认有15秒的延迟 | 默认 : false | +| MEMBER_LIST | 通过环境变量的方式设置集群地址 | 例子:192.168.16.101:8847?raft_port=8807,192.168.16.101?raft_port=8808,192.168.16.101:8849?raft_port=8809 | +| EMBEDDED_STORAGE | 是否开启集群嵌入式存储模式 | `embedded` 默认 : none | +| NACOS_AUTH_CACHE_ENABLE | nacos.core.auth.caching.enabled | default : false | +| NACOS_AUTH_USER_AGENT_AUTH_WHITE_ENABLE | nacos.core.auth.enable.userAgentAuthWhite | default : false | +| NACOS_AUTH_IDENTITY_KEY | nacos.core.auth.server.identity.key | | +| NACOS_AUTH_IDENTITY_VALUE | nacos.core.auth.server.identity.value | | +| NACOS_SECURITY_IGNORE_URLS | nacos.security.ignore.urls | default : `/,/error,/**/*.css,/**/*.js,/**/*.html,/**/*.map,/**/*.svg,/**/*.png,/**/*.ico,/console-fe/public/**,/v1/auth/**,/v1/console/health/**,/actuator/**,/v1/console/server/**` | ## 高级配置