{% include fields.md %}
First time user? The [getting started]({{ site.url }}/use/guide/quickstart/index.html) guide will walk you through downloading Brooklyn, setup of your brooklyn.properties and catalog.xml files, and then trying the examples.
The distribution archive contains Brooklyn as a standalone executable package.
{% if site.brooklyn-version contains ‘SNAPSHOT’ %} Please note: You are reading the documentation for a snapshot version of Brooklyn. You should always confirm that the source and date for snapshot artifacts. {% endif %}
This is a single JAR containing all of Brooklyn and its dependencies, for developing Brooklyn into your own applications. Just download your preferred flavour and add it to your classpath.
{% if SNAPSHOT %}{% else %}
{% if site.brooklyn-version contains ‘SNAPSHOT’ %} Again, check the source and date for SNAPSHOT JARs. {% endif %}
Release notes can be found [here]({{ site.url }}/start/release-notes.html).
{% if SNAPSHOT %} As this is a snapshot version of Brooklyn, please find the examples in the main Brooklyn codebase (in the /examples directory).
When this version is released, the brooklyn-examples git repository will be updated and instructions for use will be included here.
{% else %}
You can checkout the examples from the brooklyn-examples git repository.
Maven (v3) is required to build them, as described [here]({{ site.url }}/dev/build/). The examples for this version ({{ site.brooklyn-version }}) are in the branch {% if SNAPSHOT %}{{ site.brooklyn-snapshot-git-branch }}{% else %}{{ site.brooklyn-version }}{% endif %}, so if you have git and mvn already, you can simply:
{% highlight bash %} % git clone https://github.com/brooklyncentral/brooklyn-examples.git % cd brooklyn-examples {% if brooklyn_examples_branch == ‘master’ %}{% else %}% git checkout {{ brooklyn_examples_branch }} {% endif %}% mvn clean install {% endhighlight %}
If you don't use git, you can download the projects as a tarball instead from [this link](https://github.com/brooklyncentral/brooklyn-examples/tarball/{{ brooklyn_examples_branch }}). These commands should do the trick:
{% highlight bash %} % curl -L -o brooklyn-examples-{{ brooklyn_examples_branch }}.tgz
https://github.com/brooklyncentral/brooklyn-examples/tarball/{{ brooklyn_examples_branch }} % tar xvfz brooklyn-examples-{{ brooklyn_examples_branch }}.tgz % mv brooklyncentral-brooklyn-examples-* brooklyn-examples-{{ brooklyn_examples_branch }}
# change the strange name which github assigns in the tarball % mvn clean install {% endhighlight %}
A good example to start with is the Elastic Web Cluster.
{% endif %}
If you use Maven, you can add Brooklyn with the following in your pom:
{% highlight xml %} io.brooklyn brooklyn-all {{ site.brooklyn-version }} {% endhighlight %}
brooklyn-all (used above) brings in all dependencies, including jclouds. If you prefer a smaller repo you might want just brooklyn-core, brooklyn-policies, and some of brooklyn-software-webapp, brooklyn-software-database, brooklyn-software-messaging, or others (browse the full list [here]({{ this_anything_url_search }})).
If you wish to use the Apache and/or Cloudsoft repositories (particularly for snapshots), you can add some of the following sections:
{% highlight xml %} cloudsoft-cloudfront-releases-repo http://developers.cloudsoftcorp.com/maven/releases/ apache-nexus-snapshots Apache Nexus Snapshots https://repository.apache.org/content/repositories/snapshots false true cloudsoft-cloudfront-snapshots-repo http://developers.cloudsoftcorp.com/maven/snapshots/ true never fail {% endhighlight %}
{% if SNAPSHOT %} Please note: to use a snapshot version of Brooklyn, you must either have Brooklyn built locally or one of the additional snapshot repositories above. {% endif %}
Full source is at github.com/brooklyncentral/brooklyn. Information on working with the source is [here]({{ site.url }}/dev/code).
Alternatively you can download archives of the source directly: