> For the complete documentation index, see [llms.txt](https://rhiot.gitbook.io/rhiotdocumentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rhiot.gitbook.io/rhiotdocumentation/index-7.md).

# Building

All you need to build the project is Maven 3 and Java 8 JDK

```
git clone https://github.com/rhiot/rhiot.git
cd rhiot
mvn install
```

## Building project using Docker

If you don't want to install Java and Maven on your machine, you can use our Docker building image.

### 1st step (once)

```
git clone https://github.com/rhiot/rhiot.git
cd rhiot
docker build -t rhiot build
```

### 2nd step

```
cd rhiot
docker run -v `pwd`:/rhiot --privileged -i -t rhiot
```

## Releasing the project

If you are interested in cutting a release of the project follow steps described below:

### Before you start

You have to had a DockerHub account setting configured in your `~/.m2/settings.xml`:

rhiotsecretregistry.hub.docker.com

### Cutting the release

Execute the following command in the project main directory:

```
mvn release:prepare release:perform
```

### After the release

* update the version on the main page of the project ([website](http://rhiot.github.io/) and [readme.md](https://github.com/rhiot/rhiot/blob/master/readme.md))
* update release guide [Releases Notes](https://github.com/rhiot/rhiotdocumentation/tree/8c31a9d7d4bee1680d83639cefa800bec2a1f8df/building/releases_notes/index.md) using GitHub tickets marked as done in the given version
* upgrade version in Rhiot command line (`tooling/bash/rhiot.sh`). Look up for a line similar to `RHIOT_VERSION=x.y.z`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://rhiot.gitbook.io/rhiotdocumentation/index-7.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.