From 499212e85a6aa473abd7911f7356613ca88adabe Mon Sep 17 00:00:00 2001 From: Crypt Keeper <64215+codefromthecrypt@users.noreply.github.com> Date: Mon, 15 Jan 2024 13:51:47 +0700 Subject: [PATCH] quickstart: add brew instructions (#178) Signed-off-by: Adrian Cole --- pages/quickstart.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/pages/quickstart.md b/pages/quickstart.md index b56a7b7..0c5e857 100644 --- a/pages/quickstart.md +++ b/pages/quickstart.md @@ -23,25 +23,41 @@ docker run -d -p 9411:9411 openzipkin/zipkin ## Java -If you have Java 8 or higher installed, the quickest way to get started is to fetch the [latest release](https://search.maven.org/remote_content?g=io.zipkin&a=zipkin-server&v=LATEST&c=exec) as a self-contained executable jar: +If you have Java 17 or higher installed, the quickest way to get started is to fetch the [latest release](https://search.maven.org/remote_content?g=io.zipkin&a=zipkin-server&v=LATEST&c=exec) as a self-contained executable jar: ~~~ bash curl -sSL https://zipkin.io/quickstart.sh | bash -s java -jar zipkin.jar ~~~ +## Homebrew + +If you have [Homebrew](https://brew.sh/) installed, the quickest way to get started is to install +the [zipkin formula](https://formulae.brew.sh/formula/zipkin). + +~~~ bash +brew install zipkin +# to run in foreground +zipkin +# to run in background +brew services start zipkin +~~~ + ## Running from Source -Zipkin can be run from source if you are developing new features. To achieve this, you'll need to get [Zipkin's source](https://github.com/openzipkin/zipkin) and build it. +Zipkin can be run from source if you are developing new features. To achieve this, you'll need to +get [Zipkin's source](https://github.com/openzipkin/zipkin) and build it. ~~~ bash # get the latest source git clone https://github.com/openzipkin/zipkin cd zipkin # Build the server and also make its dependencies -./mvnw -DskipTests --also-make -pl zipkin-server clean install +./mvnw -T1C -q --batch-mode -DskipTests --also-make -pl zipkin-server clean package # Run the server java -jar ./zipkin-server/target/zipkin-server-*exec.jar +# or Run the slim server +java -jar ./zipkin-server/target/zipkin-server-*slim.jar ~~~ Stop by and socialize with us on [gitter](https://gitter.im/openzipkin/zipkin), if you end up making something interesting!