diff --git a/README.md b/README.md index 87d6bfe97e0..8f6223dd870 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,11 @@ Demo Environment: - User/Password: apollo/admin # Screenshots + ![Screenshot](https://cdn.jsdelivr.net/gh/apolloconfig/apollo@master/docs/en/images/apollo-home-screenshot.jpg) # Features + * **Unified management of the configurations of different environments and different clusters** * Apollo provides a unified interface to centrally manage the configurations of different environments, different clusters, and different namespaces * The same codebase could have different configurations when deployed in different clusters @@ -71,55 +73,73 @@ Demo Environment: * Apollo also provides a packaging script, which can generate all required installation packages with just one click, and supports customization of runtime parameters # Usage - 1. [Apollo User Guide](https://www.apolloconfig.com/#/zh/portal/apollo-user-guide) - 2. [Java SDK User Guide](https://www.apolloconfig.com/#/zh/client/java-sdk-user-guide) - 3. [.Net SDK user Guide](https://www.apolloconfig.com/#/zh/client/java-sdk-user-guide) - 4. [Third Party SDK User Guide](https://www.apolloconfig.com/#/zh/client/third-party-sdks-user-guide) - 5. [Other Language Client User Guide](https://www.apolloconfig.com/#/zh/client/other-language-client-user-guide) - 6. [Apollo Open APIs](https://www.apolloconfig.com/#/zh/portal/apollo-open-api-platform) - 7. [Apollo Use Cases](https://github.com/apolloconfig/apollo-use-cases) - 8. [Apollo User Practices](https://www.apolloconfig.com/#/zh/portal/apollo-user-practices) - 9. [Apollo Security Best Practices](https://www.apolloconfig.com/#/zh/portal/apollo-user-guide?id=_71-%e5%ae%89%e5%85%a8%e7%9b%b8%e5%85%b3) + +* [Apollo User Guide](https://www.apolloconfig.com/#/zh/portal/apollo-user-guide) +* [Apollo Open APIs](https://www.apolloconfig.com/#/zh/portal/apollo-open-api-platform) +* [Apollo Use Cases](https://github.com/apolloconfig/apollo-use-cases) +* [Apollo User Practices](https://www.apolloconfig.com/#/zh/portal/apollo-user-practices) +* [Apollo Security Best Practices](https://www.apolloconfig.com/#/zh/portal/apollo-user-guide?id=_71-%e5%ae%89%e5%85%a8%e7%9b%b8%e5%85%b3) + +# SDK + +* [Java SDK User Guide](https://www.apolloconfig.com/#/zh/client/java-sdk-user-guide) +* [.Net SDK user Guide](https://www.apolloconfig.com/#/zh/client/java-sdk-user-guide) +* [Golang SDK User Guide](https://www.apolloconfig.com/#/zh/client/goland-sdks-user-guide) +* [Python SDK User Guide](https://www.apolloconfig.com/#/zh/client/python-sdks-user-guide) +* [NodeJS SDK User Guide](https://www.apolloconfig.com/#/zh/client/nodejs-sdks-user-guide) +* [PHP SDK User Guide](https://www.apolloconfig.com/#/zh/client/php-sdks-user-guide) +* [C SDK User Guide](https://www.apolloconfig.com/#/zh/client/c-sdks-user-guide) +* [Rust SDK User Guide](https://www.apolloconfig.com/#/zh/client/rust-sdks-user-guide) +* [HTTP API Guide](https://www.apolloconfig.com/#/zh/client/other-language-client-user-guide) # Design - * [Apollo Design](https://www.apolloconfig.com/#/zh/design/apollo-design) - * [Apollo Core Concept - Namespace](https://www.apolloconfig.com/#/zh/design/apollo-core-concept-namespace) - * [Apollo Architecture Analysis](https://mp.weixin.qq.com/s/-hUaQPzfsl9Lm3IqQW3VDQ) - * [Apollo Source Code Explanation](http://www.iocoder.cn/categories/Apollo/) + +* [Apollo Design](https://www.apolloconfig.com/#/zh/design/apollo-design) +* [Apollo Core Concept - Namespace](https://www.apolloconfig.com/#/zh/design/apollo-core-concept-namespace) +* [Apollo Architecture Analysis](https://mp.weixin.qq.com/s/-hUaQPzfsl9Lm3IqQW3VDQ) +* [Apollo Source Code Explanation](http://www.iocoder.cn/categories/Apollo/) # Development - * [Apollo Development Guide](https://www.apolloconfig.com/#/zh/contribution/apollo-development-guide) - * Code Styles - * [Eclipse Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml) - * [Intellij Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/intellij-java-google-style.xml) + +* [Apollo Development Guide](https://www.apolloconfig.com/#/zh/contribution/apollo-development-guide) +* Code Styles + * [Eclipse Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml) + * [Intellij Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/intellij-java-google-style.xml) # Deployment - * [Quick Start](https://www.apolloconfig.com/#/zh/deployment/quick-start) - * [Distributed Deployment Guide](https://www.apolloconfig.com/#/zh/deployment/distributed-deployment-guide) + +* [Quick Start](https://www.apolloconfig.com/#/zh/deployment/quick-start) +* [Distributed Deployment Guide](https://www.apolloconfig.com/#/zh/deployment/distributed-deployment-guide) # Release Notes - * [Releases](https://github.com/apolloconfig/apollo/releases) + +* [Releases](https://github.com/apolloconfig/apollo/releases) # FAQ - * [FAQ](https://www.apolloconfig.com/#/zh/faq/faq) - * [Common Issues in Deployment & Development Phase](https://www.apolloconfig.com/#/zh/faq/common-issues-in-deployment-and-development-phase) + +* [FAQ](https://www.apolloconfig.com/#/zh/faq/faq) +* [Common Issues in Deployment & Development Phase](https://www.apolloconfig.com/#/zh/faq/common-issues-in-deployment-and-development-phase) # Presentation - * [Design and Implementation Details of Apollo](http://www.itdks.com/dakalive/detail/3420) - * [Slides](https://github.com/apolloconfig/apollo-community/blob/master/slides/design-and-implementation-of-apollo.pdf) - * [Configuration Center Makes Microservices Smart](https://2018.qconshanghai.com/presentation/799) - * [Slides](https://github.com/apolloconfig/apollo-community/blob/master/slides/configuration-center-makes-microservices-smart.pdf) + +* [Design and Implementation Details of Apollo](http://www.itdks.com/dakalive/detail/3420) + * [Slides](https://github.com/apolloconfig/apollo-community/blob/master/slides/design-and-implementation-of-apollo.pdf) +* [Configuration Center Makes Microservices Smart](https://2018.qconshanghai.com/presentation/799) + * [Slides](https://github.com/apolloconfig/apollo-community/blob/master/slides/configuration-center-makes-microservices-smart.pdf) # Publication - * [Design and Implementation Details of Apollo](https://www.infoq.cn/article/open-source-configuration-center-apollo) - * [Configuration Center Makes Microservices Smart](https://mp.weixin.qq.com/s/iDmYJre_ULEIxuliu1EbIQ) + +* [Design and Implementation Details of Apollo](https://www.infoq.cn/article/open-source-configuration-center-apollo) +* [Configuration Center Makes Microservices Smart](https://mp.weixin.qq.com/s/iDmYJre_ULEIxuliu1EbIQ) # Community - * [Apollo Team](https://www.apolloconfig.com/#/en/community/team) - * [Community Governance](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md) - * [Contributing Guide](https://github.com/apolloconfig/apollo/blob/master/CONTRIBUTING.md) + +* [Apollo Team](https://www.apolloconfig.com/#/en/community/team) +* [Community Governance](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md) +* [Contributing Guide](https://github.com/apolloconfig/apollo/blob/master/CONTRIBUTING.md) # License + The project is licensed under the [Apache 2 license](https://github.com/apolloconfig/apollo/blob/master/LICENSE). # Known Users diff --git a/docs/en/README.md b/docs/en/README.md index 1cd03b0e016..46fb251756f 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -62,40 +62,9 @@ Demo Environment: * Currently, the only external dependency is MySQL, so the deployment is very simple. Apollo can run as long as Java and MySQL are installed * Apollo also provides a packaging script, which can generate all required installation packages with just one click, and supports customization of runtime parameters -# Usage -1. [Apollo User Guide](en/portal/apollo-user-guide) -2. [Java SDK User Guide](en/client/java-sdk-user-guide) -3. [.Net SDK user Guide](en/client/dotnet-sdk-user-guide) -4. [Third Party SDK User Guide](en/client/third-party-sdks-user-guide) -5. [Other Language Client User Guide](en/client/other-language-client-user-guide) -6. [Apollo Open APIs](en/portal/apollo-open-api-platform) -7. [Apollo Use Cases](https://github.com/ctripcorp/apollo-use-cases) -8. [Apollo User Practices](en/portal/apollo-user-practices) -9. [Apollo Security Best Practices](en/portal/apollo-user-guide?id=_71-security-related) - -# Design -* [Apollo Design](en/design/apollo-design) -* [Apollo Core Concept - Namespace](en/design/apollo-core-concept-namespace) -* [Apollo Architecture Analysis](https://mp.weixin.qq.com/s/-hUaQPzfsl9Lm3IqQW3VDQ) -* [Apollo Source Code Explanation](http://www.iocoder.cn/categories/Apollo/) - -# Development -* [Apollo Development Guide](en/contribution/apollo-development-guide) -* Code Styles - * [Eclipse Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml) - * [Intellij Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/intellij-java-google-style.xml) - -# Deployment -* [Quick Start](en/deployment/quick-start) -* [Distributed Deployment Guide](en/deployment/distributed-deployment-guide) - # Release Notes * [Releases](https://github.com/apolloconfig/apollo/releases) -# FAQ -* [FAQ](en/faq/faq) -* [Common Issues in Deployment & Development Phase](en/faq/common-issues-in-deployment-and-development-phase) - # Presentation * [Design and Implementation Details of Apollo](http://www.itdks.com/dakalive/detail/3420) * [Slides](https://github.com/apolloconfig/apollo-community/blob/master/slides/design-and-implementation-of-apollo.pdf) @@ -106,10 +75,5 @@ Demo Environment: * [Design and Implementation Details of Apollo](https://www.infoq.cn/article/open-source-configuration-center-apollo) * [Configuration Center Makes Microservices Smart](https://mp.weixin.qq.com/s/iDmYJre_ULEIxuliu1EbIQ) -# Community - * [Apollo Team](en/community/team) - * [Community Governance](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md) - * [Contributing Guide](https://github.com/apolloconfig/apollo/blob/master/CONTRIBUTING.md) - # License The project is licensed under the [Apache 2 license](https://github.com/apolloconfig/apollo/blob/master/LICENSE). diff --git a/docs/en/client/other-language-client-user-guide.md b/docs/en/client/other-language-client-user-guide.md index 1de4c0b50bf..ec00724c5e2 100644 --- a/docs/en/client/other-language-client-user-guide.md +++ b/docs/en/client/other-language-client-user-guide.md @@ -2,7 +2,7 @@ At present, Apollo team only provides Java and .Net clients due to manpower cons Also, if any team/individual is interested, they are welcome to help us to implement the client in other languages, please contact @nobodyiam and @lepdou for details. ->Note: There are already clients for Go, Python, NodeJS, PHP, C++ contributed by enthusiastic users, for more information you can refer to [Go, Python, NodeJS, PHP and other clients usage guide](en/client/third-party-sdks-user-guide) +>Note: There are already clients for Go, Python, NodeJS, PHP, C++ contributed by enthusiastic users, for more information you can refer to "SDK Guide" ## 1.1 Application access to Apollo diff --git a/docs/en/client/third-party-sdks-user-guide.md b/docs/en/client/third-party-sdks-user-guide.md deleted file mode 100644 index 2d20fc0ba77..00000000000 --- a/docs/en/client/third-party-sdks-user-guide.md +++ /dev/null @@ -1,151 +0,0 @@ -## 1. Go - -### Apollo Go client 1 - -Project address: [apolloconfig/agollo](https://github.com/apolloconfig/agollo) - -> Thanks [@zouyx](https://github.com/zouyx) for providing support for the Go Apollo client - -### Apollo Go client 2 - -Project address: [philchia/agollo](https://github.com/philchia/agollo) - -> Thanks [@philchia](https://github.com/philchia) for providing support for the Go Apollo client - -### Apollo Go client 3 - -Project address: [shima-park/agollo](https://github.com/shima-park/agollo) - -> Thanks [@shima-park](https://github.com/shima-park) for providing support for the Go Apollo client - -### Apollo Go client 4 - -Project address: [go-microservices/php_conf_agent](https://github.com/go-microservices/php_conf_agent) - -> Thanks [@GanymedeNil](https://github.com/GanymedeNil) for providing support for the Go Apollo client - -### Apollo Go client 5 - -Project address: [hyperjiang/lunar](https://github.com/hyperjiang/lunar) - -> Thanks [@hyperjiang](https://github.com/hyperjiang) for providing support for the Go Apollo client - -### Apollo Go client 6 - -Project address: [tagconfig/tagconfig](https://github.com/tagconfig/tagconfig) - -> Thanks [@n0trace](https://github.com/n0trace) for providing support for the Go Apollo client - -### Apollo Go client 7 - -Project address: [go-chassis/go-archaius](https://github.com/go-chassis/go-archaius/tree/master/examples/apollo) - -> Thanks [@tianxiaoliang](https://github.com/tianxiaoliang) and [@Shonminh](https://github.com/Shonminh) for providing support for the Go Apollo client - -### Apollo Go client 8 - -Project address: [xhrg-product/apollo-client-golang](https://github.com/xhrg-product/apollo-client-golang) - -> Thanks [@xhrg](https://github.com/xhrg) for providing support for the Go Apollo client - -### Apollo Go client 9 - -Project address: [xnzone/apollo-go](https://github.com/xnzone/apollo-go) - -> Thanks [@xnzone](https://github.com/xnzone) for providing support for the Go Apollo client - -## 2. Python - -### Apollo Python client 1 - -Project address: [pyapollo](https://github.com/filamoon/pyapollo) - -> Thanks [@filamoon](https://github.com/filamoon) for providing support for the Python Apollo client - -### Apollo Python client 2 - -Project address: [BruceWW-pyapollo](https://github.com/BruceWW/pyapollo) - -> Thanks [@BruceWW](https://github.com/BruceWW) for providing support for the Python Apollo client - -### Apollo Python client 3 - -Project address: [xhrg-product/apollo-client-python](https://github.com/xhrg-product/apollo-client-python) - -> Thanks [@xhrg-product](https://github.com/xhrg-product) for providing support for the Python Apollo client - -## 3. NodeJS - -### Apollo NodeJS client 1 - -Project address: [node-apollo](https://github.com/Quinton/node-apollo) - -> Thanks [@Quinton](https://github.com/Quinton) for providing support for the NodeJS Apollo client - -### Apollo NodeJS client 2 - -Project address: [ctrip-apollo](https://github.com/kaelzhang/ctrip-apollo) - -> Thanks [@kaelzhang](https://github.com/kaelzhang) for providing support for the NodeJS Apollo client - -### Apollo NodeJS client 3 - -Project address: [node-apollo-client](https://github.com/shinux/node-apollo-client) - -> Thanks [@shinux](https://github.com/shinux) for providing support for the NodeJS Apollo client - -### Apollo NodeJS client 4 - -Project address: [ctrip-apollo-client](https://github.com/lvgithub/ctrip-apollo-client) - -> Thanks [@lvgithub](https://github.com/lvgithub) for providing support for the NodeJS Apollo client - -### Apollo NodeJS client 5 - -Project address: [apollo-node](https://github.com/lengyuxuan/apollo-node) - -> Thanks [@lengyuxuan](https://github.com/lengyuxuan) for providing support for the NodeJS Apollo client - -### Apollo NodeJS client 6 - -Project address: [egg-apollo-client](https://github.com/xuezier/egg-apollo-client) - -> Thanks [@xuezier](https://github.com/xuezier) for providing support for the NodeJS Apollo client - -### Apollo NodeJS client 7 - -Project address: [apollo-node-client](https://github.com/zhangxh1023/apollo-node-client) - -> Thanks [@zhangxh1023](https://github.com/zhangxh1023) for providing support for the NodeJS Apollo client - -## 4. PHP - -### Apollo PHP client 1 - -Project address: [apollo-php-client](https://github.com/multilinguals/apollo-php-client) - -> Thanks [@t04041143](https://github.com/t04041143) for providing support for the PHP Apollo client - -### Apollo PHP client 2 - -Project address: [apollo-sdk-config](https://github.com/fengzhibin/apollo-sdk-config) - -Project address: [apollo-sdk-clientd](https://github.com/fengzhibin/apollo-sdk-clientd) - -> Thanks [@fengzhibin](https://github.com/fengzhibin) for providing PHP Apollo client support - -## 5. C - -### Apollo C client - -Project address: [apollo-c-client](https://github.com/lzeqian/apollo) - -> Thanks [@lzeqian](https://github.com/lzeqian) for providing support for the C Apollo client - -## 6. Rust - -### Apollo Rust client - -Project address: [apollo-rust-sdk](https://github.com/liushv0/apollo-rust-sdk) - -> Thanks [@liushv0](https://github.com/liushv0) for providing support for the Rust Apollo client diff --git a/docs/zh/README.md b/docs/zh/README.md index 31b6d254154..e54c216f0a3 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -64,45 +64,9 @@ Java客户端不依赖任何框架，能够运行于所有Java运行时环境， * 目前唯一的外部依赖是MySQL，所以部署非常简单，只要安装好Java和MySQL就可以让Apollo跑起来 * Apollo还提供了打包脚本，一键就可以生成所有需要的安装包，并且支持自定义运行时参数 -# Usage - 1. [应用接入指南](zh/portal/apollo-user-guide) - 2. [Java客户端使用指南](zh/client/java-sdk-user-guide) - 3. [.Net客户端使用指南](zh/client/java-sdk-user-guide) - 4. [Go、Python、NodeJS、PHP等客户端使用指南](zh/client/third-party-sdks-user-guide) - 5. [其它语言客户端接入指南](zh/client/other-language-client-user-guide) - 6. [Apollo开放平台接入指南](zh/portal/apollo-open-api-platform) - 7. [Apollo使用场景和示例代码](https://github.com/ctripcorp/apollo-use-cases) - 8. [Apollo实践案例](zh/portal/apollo-user-practices) - 9. [Apollo安全相关最佳实践](zh/portal/apollo-user-guide?id=_71-%e5%ae%89%e5%85%a8%e7%9b%b8%e5%85%b3) - -# Design - - [Apollo配置中心设计](zh/design/apollo-design.md) - - [Apollo配置中心介绍](zh/design/apollo-introduction.md) - - [Apollo核心概念之“Namespace”](zh/design/apollo-core-concept-namespace.md) - - [Apollo源码解析](http://www.iocoder.cn/categories/Apollo/)（据说Apollo非常适合作为初学者第一个通读源码学习的分布式中间件产品） - -# Development - - [Apollo开发指南](zh/contribution/apollo-development-guide.md) - - Code Styles - - [Eclipse Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/eclipse-java-google-style.xml) - - [Intellij Code Style](https://github.com/apolloconfig/apollo/blob/master/apollo-buildtools/style/intellij-java-google-style.xml) - - [Portal实现用户登录功能](zh/extension/portal-how-to-implement-user-login-function.md) - - [Portal接入邮件服务](zh/extension/portal-how-to-enable-email-service.md) - - [Portal启用webhook通知](zh/extension/portal-how-to-enable-webhook-notification.md) - - [Apollo 版本发布操作手册](zh/contribution/apollo-release-guide.md) - -# Deployment - - [Quick Start](zh/deployment/quick-start.md) - - [Docker方式部署Quick Start](zh/deployment/quick-start-docker.md) - - [分布式部署指南](zh/deployment/distributed-deployment-guide.md) - # Release Notes * [版本发布历史](https://github.com/apolloconfig/apollo/releases) -# FAQ - * [常见问题回答](zh/faq/faq.md) - * [部署&开发遇到的常见问题](zh/faq/common-issues-in-deployment-and-development-phase.md) - # Presentation * [开源配置中心Apollo的设计与实现](http://www.itdks.com/dakalive/detail/3420) * [Slides](https://github.com/apolloconfig/apollo-community/blob/master/slides/design-and-implementation-of-apollo.pdf) @@ -133,10 +97,5 @@ Java客户端不依赖任何框架，能够运行于所有Java运行时环境， -# 社区 - * [团队](zh/community/team) - * [社区治理](https://github.com/apolloconfig/apollo/blob/master/GOVERNANCE.md) - * [贡献指南](https://github.com/apolloconfig/apollo/blob/master/CONTRIBUTING.md) - # License The project is licensed under the [Apache 2 license](https://github.com/apolloconfig/apollo/blob/master/LICENSE). diff --git a/docs/zh/client/other-language-client-user-guide.md b/docs/zh/client/other-language-client-user-guide.md index a3a555af5ce..669134f2db6 100644 --- a/docs/zh/client/other-language-client-user-guide.md +++ b/docs/zh/client/other-language-client-user-guide.md @@ -2,7 +2,7 @@ 另外，如果有团队/个人有兴趣的话，也欢迎帮助我们来实现其它语言的客户端，具体细节可以联系@nobodyiam和@lepdou。 ->注：目前已有热心用户贡献了Go、Python、NodeJS、PHP、C++的客户端，更多信息可以参考[Go、Python、NodeJS、PHP等客户端使用指南](zh/client/third-party-sdks-user-guide) +>注：目前已有热心用户贡献了Go、Python、NodeJS、PHP、C++的客户端，更多信息可以参考"客户端指南" ## 1.1 应用接入Apollo 首先需要在Apollo中接入你的应用，具体步骤可以参考[应用接入文档](zh/portal/apollo-user-guide?id=一、普通应用接入指南)。