Skip to content

docs:clarify prerequisites and external Zookeper setup #1275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zrlw merged 2 commits into from
Jan 8, 2026
Merged

docs:clarify prerequisites and external Zookeper setup #1275

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1884a5
docs:clarify prerequisites and external Zookeper setup
ishankhemani Dec 19, 2025
beb607e
Correct formatting in README.md
zrlw Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 31 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,46 @@ Samples for Apache Dubbo.
![Build Status](https://github.com/apache/dubbo-samples/workflows/Dubbo%203.3/badge.svg)
![license](https://img.shields.io/github/license/apache/dubbo-samples.svg)

This repository contains a number of projects to illustrate various usages of Dubbo from basic to advanced, pls. check README in each individual sub projects. It is also helpful to cross reference to [Dubbo User Manual](https://dubbo.apache.org/zh-cn/overview/tasks/) to understand the features demoed in this project.
This repository contains a number of projects to illustrate various usages of Dubbo from basic to advanced.
All samples are standard Java, Spring, or Spring Boot applications, and can be built and run in the same way as normal applications.
Please check the README in each individual sub-project for detailed instructions.
It is also helpful to cross reference to [Dubbo User Manual](https://dubbo.apache.org/zh-cn/overview/tasks/) to understand the features demoed in this project.

What's more, [dubbo-go](https://github.com/apache/dubbo-go) samples are moved to [dubbo-go-samples](https://github.com/apache/dubbo-go-samples).
## Prerequisites

Before running most samples, make sure you have the following installed:

- JDK 8 or later
- Maven 3.6+
- ZooKeeper (external)

### ZooKeeper Setup

Samples do not rely on an embedded ZooKeeper by default.

Please download and run a standard ZooKeeper distribution:

1. Download ZooKeeper from https://zookeeper.apache.org/releases.html
2. Extract the package
3. Start ZooKeeper:

```bash
bin/zkServer.sh start
```

## Build and Run Samples

To compile all samples, run the following command in the top directory of this project, or step into the sub directories to compile one single sample:
**It is highly NOT recommended to build the entire project from the root directory**, as building all samples can take a long time.

Each sample is designed to be independent. You should navigate to the demo directory you are interested in and then build and run the sample.

**It is highly not recommend to build the entire project from the root directory, as building the entire samples can take a long time. Each module in Samples is designed independently so you can first go to the demo directory you care about, then execute the build and run the demo.**

For example,

```bash
$ cd 1-basic/dubbo-samples-spring-boot
$ mvn clean package
cd 1-basic/dubbo-samples-spring-boot
mvn clean package
```

You may need to read each individual README under the sub directories if you have to understand how to build and run.
Expand Down Expand Up @@ -61,7 +86,7 @@ Then we use the `run-tests.sh` script to run the test cases.

For example, run the `dubbo-samples-annotation` test case:

```
```bash
./test/run-tests.sh 2-advanced/dubbo-samples-annotation
```

Expand Down
Loading