Getting Started

Getting Binaries

Binaries and dependency information for Maven, Ivy, Gradle and others can be found at http://search.maven.org.

Example for Maven:

<dependency>
    <groupId>com.netflix.zuul</groupId>
    <artifactId>zuul-core</artifactId>
    <version>1.0.0</version>
</dependency>

and for Ivy:

<dependency org="com.netflix.zuul" name="zuul-core" rev="1.0.0" />

If you need to download the jars instead of using a build system, create a Maven pom file like this with the desired version:

<?xml version="1.0"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.netflix.zuul.download</groupId>
	<artifactId>zuul-download</artifactId>
	<version>1.0-SNAPSHOT</version>
	<name>Simple POM to download zuul-core and dependencies</name>
	<url>http://github.com/Netflix/zuul</url>
	<dependencies>
		<dependency>
			<groupId>com.netflix.zuul</groupId>
			<artifactId>zuul-core</artifactId>
			<version>1.0.0</version>
			<scope/>
		</dependency>
	</dependencies>
</project>

Then execute:

mvn -f download-zuul-pom.xml dependency:copy-dependencies

It will download zuul-core-*.jar and its dependencies into ./target/dependency/.

You need Java 6 or later.

Usage examples can be found in the How To Use section.

Building

To checkout the source and build:

$ git clone git@github.com:Netflix/zuul.git
$ cd zuul/
$ ./gradlew build

To do a clean build:

$ ./gradlew clean build

Running

We suggest that you run our simple example webapp first: zuul-simple-webapp