Skip to main content
Version: 2.X

Quick Start for Nacos

This topic is about how to set up and use Nacos.

0.Choose Version​

You can see the introduction of each version at release notes or blog, the current recommended version is 2.2.3.

1.Prerequisites​

Before you begin, install the following:

  1. 64bit OS: Linux/Unix/Mac/Windows supported, Linux/Unix/Mac recommended.
  2. 64bit JDK 1.8+: downloads, JAVA_HOME settings.
  3. Maven 3.2.x+: downloads, settings.

2.Download & Build from Release​

There are two ways to get Nacos.

1)Download source code from Github​

git clone https://github.com/alibaba/nacos.git
cd nacos/
mvn -Prelease-nacos -Dmaven.test.skip=true clean install -U 
ls -al distribution/target/

// change the $version to your actual path
cd distribution/target/nacos-server-$version/nacos/bin

2)Download run package​

Select the latest stable version from https://github.com/alibaba/nacos/releases

  unzip nacos-server-$version.zip  OR tar -xvf nacos-server-$version.tar.gz
  cd nacos/bin

3.Setting Configuration​

Must do this setting in 2.2.0.1 and 2.2.1, otherwise fail to start.

Setting configuration file application.properties under conf.

Setting nacos.core.auth.plugin.nacos.token.secret.key parameter，detail see Authentication-Custom SecretKey.

Attention，Default value in Document SecretKey012345678901234567890123456789012345678901234567890123456789 and VGhpc0lzTXlDdXN0b21TZWNyZXRLZXkwMTIzNDU2Nzg= is a public default, only should use in test temporary. Please make sure to replace it with another valid value when you actually deploy.

4.Start Server​

Linux/Unix/Mac​

Run the following command to start(standalone means non-cluster mode):

sh startup.sh -m standalone

If you are using a ubuntu system, or encounter this error message [[symbol not found, try running as follows:

bash startup.sh -m standalone

Windows​

Run the following command to start(standalone means non-cluster mode):

cmd startup.cmd -m standalone

5.Service & Configuration Management​

Service registration​

curl -X POST 'http://127.0.0.1:8848/nacos/v1/ns/instance?serviceName=nacos.naming.serviceName&ip=20.18.7.10&port=8080'

Service discovery​

curl -X GET 'http://127.0.0.1:8848/nacos/v1/ns/instance/list?serviceName=nacos.naming.serviceName'

Publish config​

curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=nacos.cfg.dataId&group=test&content=helloWorld"

Get config​

curl -X GET "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=nacos.cfg.dataId&group=test"

6.Shutdown Servers​

Linux/Unix/Mac​

sh shutdown.sh

Windows​

cmd shutdown.cmd

Or click the shutdown.cmd file operation.