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

# Building a Release

Use

```
make rel
```

to build a release.

It can be found under `_build/default/rel/antidote`.

## Using a Release

After building a release with `make rel`, Antidote can be started with the generated executable file. The release executable is located at `_build/default/bin/rel/antidote/releases/bin/antidote`. It should be started with the node name and cookie configured. Setting the cookie is optional, setting the node name is mandatory.

```
# start antidote with given short node name as a foreground process
NODE_NAME=testing ./antidote foreground

# start antidote with given long node name with an erlang interactive console attached
NODE_NAME=testing ./antidote console
```

## Dynamic Release Configuration

The release executable is dynamically configurable with OS environment variables. The default configuration can be found in the config file folder `config`. Only `NODE_NAME`, `COOKIE`, `ROOT_DIR_PREFIX`, `LOGGER_DIR_PREFIX` and `DATA_DIR_PREFIX` are expected to be provided via OS environment variables. All other configuration has to be set via [erlang application environment arguments](http://erlang.org/doc/man/erl.html#flags) `-Application Par Val`, where variable expansion can be used in the `Val` part.

Example:

```
# start antidote with a unified directory, set logging level to warning
# assume NODE_NAME, ROOT_PREFIX_DIR (`antidote/`), P1, P2, P3, P4, and P5 OS variables 
# have been exported before
# modify appliation configurations (see sys.config.src and other .config files for options)
# logging level and all ports
# disable certification checks for concurrent transactions
./antidote foreground \
-kernel logging_level warning \
-riak_core handoff_port $P1 \
-ranch pb_port $P2 \
-antidote pubsub_port $P3 \
-antidote logreader_port $P4 \
-antidote_stats metrics_port $P5 \
-antidote txn_check false
```


---

# 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://antidotedb.gitbook.io/documentation/development/building-a-release.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.
