2018-07-21 00:27:23 +08:00
2018-11-05 19:38:32 +08:00
< img src = "doc/Nacos_Logo.png" width = "50%" height = "50%" / >
# Nacos: Dynamic *Na*ming and *Co*nfiguration *S*ervice
2018-07-21 00:27:23 +08:00
[](https://gitter.im/alibaba/nacos?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge) [](https://www.apache.org/licenses/LICENSE-2.0.html)
[](https://travis-ci.org/alibaba/nacos)
-------
2018-11-05 19:38:32 +08:00
## What does it do
2018-11-05 20:44:58 +08:00
Nacos (official site: [http://nacos.io ](http://nacos.io )) is an easy-to-use platform designed for dynamic service discovery and configuration and service management. It helps you to build cloud native applications and microservices platform easily.
2018-07-21 00:27:23 +08:00
2018-09-16 19:22:53 +08:00
Service is a first-class citizen in Nacos. Nacos supports almost all type of services， ， Kubernetes service ](https://nacos.io/en-us/docs/use-nacos-with-kubernetes.html ).
2018-07-21 00:27:23 +08:00
2018-08-27 00:33:30 +08:00
Nacos provides four major functions.
2018-07-21 00:27:23 +08:00
* **Service Discovery and Service Health Check**
Nacos makes it simple for services to register themselves and to discover other services via a DNS or HTTP interface. Nacos also provides real-time healthchecks of services to prevent sending requests to unhealthy hosts or service instance.
* **Dynamic Configuration Management**
Dynamic Configuration Service allows you to manage configurations of all services in a centralized and dynamic manner across all environments. Nacos eliminates the need to redeploy applications and services when configurations are updated，
* **Dynamic DNS Service**
Nacos supports weighted routing, making it easier for you to implement mid-tier load balancing, flexible routing policies, flow control, and simple DNS resolution services in the production environment within your data center. It helps you to implement DNS-based service discovery easily and prevent applications from coupling to vendor-specific service discovery APIs.
* **Service and MetaData Management**
Nacos provides an easy-to-use service dashboard to help you manage your services metadata, configuration, kubernetes DNS, service health and metrics statistics.
2018-11-05 19:38:32 +08:00
## Quick Start
2018-07-21 00:27:23 +08:00
It is super easy to get started with your first project.
2018-11-05 19:38:32 +08:00
#### Step 1: Download the binary package
You can download the package from the [latest stable release ](https://github.com/alibaba/nacos/releases ).
2018-07-21 02:12:52 +08:00
2019-07-12 16:25:24 +08:00
Take release nacos-server-1.0.0.zip for example.
2018-07-21 02:12:52 +08:00
```
2019-07-12 16:25:24 +08:00
unzip nacos-server-1.0.0.zip
2018-07-21 02:12:52 +08:00
cd nacos/bin
```
2018-07-21 13:50:42 +08:00
2018-11-05 19:38:32 +08:00
#### Step 2: Start Server
2018-07-21 01:19:48 +08:00
2018-11-05 19:38:32 +08:00
On the **Linux/Unix/Mac** platform, run the following command to start server with standalone mode:
2018-09-02 23:16:05 +08:00
```
sh startup.sh -m standalone
```
2018-07-21 01:19:48 +08:00
2018-11-05 19:38:32 +08:00
On the **Windows** platform, run the following command to start server with standalone mode. Alternatively, you can also double-click the startup.cmd to run NacosServer.
2018-09-02 23:16:05 +08:00
```
2018-11-05 19:38:32 +08:00
cmd startup.cmd -m standalone
2018-09-02 23:16:05 +08:00
```
2018-07-21 01:19:48 +08:00
2018-09-16 19:22:53 +08:00
For more details, see [quick-start. ](https://nacos.io/en-us/docs/quick-start.html )
2018-07-21 00:27:23 +08:00
2018-11-05 19:38:32 +08:00
## Quick start for other open-source projects:
* [Quick start with Nacos command and console ](https://nacos.io/en-us/docs/quick-start.html )
2018-07-21 00:27:23 +08:00
2018-11-05 19:38:32 +08:00
* [Quick start with dubbo ](https://nacos.io/en-us/docs/use-nacos-with-dubbo.html )
2018-07-21 02:11:06 +08:00
2018-11-07 20:53:12 +08:00
* [Quick start with spring cloud ](https://nacos.io/en-us/docs/quick-start-spring-cloud.html )
2018-07-21 02:11:06 +08:00
2018-11-05 19:38:32 +08:00
* [Quick start with kubernetes ](https://nacos.io/en-us/docs/use-nacos-with-kubernetes.html )
2018-07-21 00:27:23 +08:00
2018-11-05 19:38:32 +08:00
## Documentation
2018-07-21 00:27:23 +08:00
2018-11-05 19:38:32 +08:00
You can view the full documentation from the [Nacos website ](https://nacos.io/en-us/docs/what-is-nacos.html ).
2018-07-21 01:19:48 +08:00
2018-11-16 16:17:35 +08:00
All the latest and long-term notice can also be found here from [Github notice issue ](https://github.com/alibaba/nacos/labels/notice )
2018-10-25 11:30:23 +08:00
2018-11-07 20:53:12 +08:00
## Contributing
2018-10-25 11:30:23 +08:00
2018-11-07 23:03:36 +08:00
Contributors are welcomed to join Nacos project. Please check [CONTRIBUTING ](./CONTRIBUTING.md ) about how to contribute to this project.
2018-07-21 02:11:06 +08:00
2018-11-07 20:53:12 +08:00
## Other Related Project Repositories
* [nacos-spring-project ](https://github.com/nacos-group/nacos-spring-project ) provides the integration functionality for Spring.
* [nacos-group ](https://github.com/nacos-group ) is the reposity that hosts the eco tools for Nacos, such as SDK, synchronization tool, etc.
* [spring-cloud-alibaba ](https://github.com/spring-cloud-incubator/spring-cloud-alibaba ) provides the one-stop solution for application development over Alibaba middleware which includes Nacos.
2018-07-21 02:11:06 +08:00
2018-11-07 20:53:12 +08:00
## Contact
2018-07-21 01:19:48 +08:00
2018-11-07 20:53:12 +08:00
* [Gitter ](https://gitter.im/alibaba/nacos ): Nacos's IM tool for community messaging, collaboration and discovery.
* [Twitter ](https://twitter.com/nacos2 ): Follow along for latest nacos news on Twitter.
* [Weibo ](https://weibo.com/u/6574374908 ): Follow along for latest nacos news on Weibo (Twitter of China version).
* [Nacos Segmentfault ](https://segmentfault.com/t/nacos ): Get latest notice and prompt help from Segmentfault.
2018-11-07 22:56:06 +08:00
* Email Group:
* users-nacos@googlegroups.com: Nacos usage general discussion.
* dev-nacos@googlegroups.com: Nacos developer discussion (APIs, feature design, etc).
* commits-nacos@googlegroups.com: Commits notice, very high frequency.
2019-04-09 15:09:52 +08:00
* Join us from DingDing.
2018-11-14 22:28:07 +08:00
2019-04-09 15:09:52 +08:00
2019-01-29 20:24:46 +08:00
## Who is using
These are only part of the companies using Nacos, for reference only. If you are using Nacos, please [add your company here ](https://github.com/alibaba/nacos/issues/273 ) to tell us your scenario to make Nacos better.
2019-02-22 11:35:24 +08:00
2019-01-29 20:24:46 +08:00
2019-01-30 17:09:59 +08:00
2019-01-29 20:24:46 +08:00
2019-03-22 00:37:14 +08:00
2019-03-22 00:45:10 +08:00
2019-03-22 00:37:14 +08:00
2019-03-22 00:45:10 +08:00
2019-03-22 00:47:12 +08:00
2019-01-29 20:24:46 +08:00
2019-01-30 17:09:59 +08:00
2019-01-29 20:24:46 +08:00
2019-03-22 00:37:14 +08:00
