2019-05-22 08:18:41 +00:00
# Nacos Docker
This project contains a Docker image meant to facilitate the deployment of [Nacos ](https://github.com/alibaba/nacos ).
2020-02-16 06:55:11 +00:00
[**中文** ](README_ZH.md )
2019-05-22 08:18:41 +00:00
## Project directory
* build：
* env: Environment variable file for compose yaml
* example: Docker compose example for Nacos server
2020-02-16 06:55:11 +00:00
## Precautions
2022-01-29 06:52:21 +00:00
* The **database master-slave image** has been removed, after the latest `nacos/nacos-server:latest` image. For specific
reasons, refer
to [Removing the Master-Slave Image Configuration ](https://github.com/nacos-group/nacos-docker/wiki/%E7%A7%BB%E9%99%A4%E6%95%B0%E6%8D%AE%E5%BA%93%E4%B8%BB%E4%BB%8E%E9%95%9C%E5%83%8F%E9%85%8D%E7%BD%AE )
* Since Nacos 1.3.1 version, the database storage has been upgraded to 8.0, and it is backward compatible
2023-03-17 11:06:34 +00:00
* If you use a custom database, you need to initialize
the [database script ](https://github.com/alibaba/nacos/blob/master/distribution/conf/mysql-schema.sql ) yourself for
the first time.
2020-02-16 06:55:11 +00:00
2021-04-15 02:23:46 +00:00
## Quick Start
2020-02-16 06:55:11 +00:00
2021-04-15 02:23:46 +00:00
```shell
2022-12-15 02:43:10 +00:00
docker run --name nacos-quick -e MODE=standalone -p 8848:8848 -p 9848:9848 -d nacos/nacos-server:v2.2.0
2021-04-15 02:23:46 +00:00
```
2020-02-16 06:55:11 +00:00
2021-04-15 02:23:46 +00:00
## Advanced Usage
* Tips: You can change the version of the Nacos image in the compose file from the following configuration.
2022-01-29 06:52:21 +00:00
`example/.env`
2021-04-15 02:23:46 +00:00
```dotenv
2022-12-15 02:43:10 +00:00
NACOS_VERSION=v2.2.0
2021-04-15 02:23:46 +00:00
```
2019-05-22 08:18:41 +00:00
Run the following command：
* Clone project
```powershell
2019-06-25 09:23:33 +00:00
git clone --depth 1 https://github.com/nacos-group/nacos-docker.git
2019-05-22 08:18:41 +00:00
cd nacos-docker
```
* Standalone Derby
```powershell
docker-compose -f example/standalone-derby.yaml up
```
* Standalone Mysql
```powershell
2020-04-25 01:48:21 +00:00
# Using mysql 5.7
docker-compose -f example/standalone-mysql-5.7.yaml up
# Using mysql 8
docker-compose -f example/standalone-mysql-8.yaml up
2019-05-22 08:18:41 +00:00
```
2023-03-11 09:39:54 +00:00
* Standalone Nacos Cluster
2019-05-22 08:18:41 +00:00
```powershell
docker-compose -f example/cluster-hostname.yaml up
```
* Service registration
```powershell
2021-10-16 14:39:10 +00:00
curl -X POST 'http://127.0.0.1:8848/nacos/v1/ns/instance?serviceName=nacos.naming.serviceName& ip=20.18.7.10& port=8080'
2019-05-22 08:18:41 +00:00
```
* Service discovery
```powershell
2022-01-13 06:30:00 +00:00
curl -X GET 'http://127.0.0.1:8848/nacos/v1/ns/instance/list?serviceName=nacos.naming.serviceName'
2019-05-22 08:18:41 +00:00
```
* Publish config
```powershell
curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=nacos.cfg.dataId& group=test& content=helloWorld"
```
* Get config
```powershell
curl -X GET "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=nacos.cfg.dataId& group=test"
```
* Open the Nacos console in your browser
2022-01-29 06:52:21 +00:00
link：
2019-05-22 08:18:41 +00:00
2022-01-29 06:52:21 +00:00
## Common property configuration
2019-05-22 08:18:41 +00:00
2023-03-17 11:06:34 +00:00
| name | description | option |
|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| MODE | cluster/standalone | cluster/standalone default **cluster** |
| NACOS_SERVERS | nacos cluster address | eg. ip1:port1 ip2:port2 ip3:port3 |
| PREFER_HOST_MODE | Whether hostname are supported | hostname/ip default **ip** |
| NACOS_APPLICATION_PORT | nacos server port | default **8848** |
| NACOS_SERVER_IP | custom nacos server ip when network was mutil-network | |
| SPRING_DATASOURCE_PLATFORM | standalone support mysql | mysql / empty default empty |
| MYSQL_SERVICE_HOST | mysql host | |
| MYSQL_SERVICE_PORT | mysql database port | default : **3306** |
| MYSQL_SERVICE_DB_NAME | mysql database name | |
| MYSQL_SERVICE_USER | username of database | |
| MYSQL_SERVICE_PASSWORD | password of database | |
| MYSQL_DATABASE_NUM | It indicates the number of database | default :**1** |
| MYSQL_SERVICE_DB_PARAM | Database url parameter | default:**
characterEncoding=utf8& connectTimeout=1000& socketTimeout=3000& autoReconnect=true& useSSL=false** |
| JVM_XMS | -Xms | default :1g |
| JVM_XMX | -Xmx | default :1g |
| JVM_XMN | -Xmn | default :512m |
| JVM_MS | -XX:MetaspaceSize | default :128m |
| JVM_MMS | -XX:MaxMetaspaceSize | default :320m |
| NACOS_DEBUG | enable remote debug | y/n default :n |
| TOMCAT_ACCESSLOG_ENABLED | server.tomcat.accesslog.enabled | default :false |
| NACOS_AUTH_SYSTEM_TYPE | The auth system to use, currently only 'nacos' is supported | default :nacos |
| NACOS_AUTH_ENABLE | If turn on auth system | default :false |
| NACOS_AUTH_TOKEN_EXPIRE_SECONDS | The token expiration in seconds | default :18000 |
| NACOS_AUTH_TOKEN | | |
| NACOS_AUTH_CACHE_ENABLE | Turn on/off caching of auth information. By turning on this switch, the update of auth information would have a 15 seconds delay. | default : false |
| MEMBER_LIST | Set the cluster list with a configuration file or command-line argument | eg: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 | Use embedded storage in cluster mode without mysql | `embedded` default : 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/**` |
2020-02-16 06:55:11 +00:00
2022-08-12 10:15:06 +00:00
## Advanced configuration
2020-11-17 02:11:29 +00:00
2022-01-29 06:52:21 +00:00
~~If the above property configuration list does not meet your requirements, you can mount the `custom.properties` file
into the `/home/nacos/init.d/` directory of the container, where the spring properties can be configured, and the
priority is higher than `application.properties` file~~
2020-11-17 02:11:29 +00:00
2022-08-12 10:15:06 +00:00
If you have a lot of custom configuration needs, It is highly recommended to mount `application.properties` in
production environment.
For example:
```docker
2022-10-20 13:13:07 +00:00
docker-compose -f example/custom-application-config.yaml up -d
2022-08-12 10:15:06 +00:00
```
2019-05-22 08:18:41 +00:00
## Nacos + Grafana + Prometheus
2020-02-16 06:55:11 +00:00
2019-05-22 08:18:41 +00:00
Usage reference：
**Note**: When Grafana creates a new data source, the data source address must be **http://prometheus:9090**
2020-02-16 06:55:11 +00:00
