Skip to content

Commit

Permalink
quickstart: add brew instructions (#178)
Browse files Browse the repository at this point in the history
Signed-off-by: Adrian Cole <[email protected]>
  • Loading branch information
codefromthecrypt authored Jan 15, 2024
1 parent a90d1e1 commit 499212e
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions pages/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

0 comments on commit 499212e

Please sign in to comment.