• 2.8, 2.8.11 (jessie/2.8.11/Dockerfile)
• 3.2, 3.2.1, latest (jessie/3.2.1/Dockerfile)

• Where to get help:
  the Docker Community Forums, the Docker Community Slack, or Stack Overflow

• Where to file issues:
  https://github.com/arangodb/arangodb-docker/issues

• Maintained by:
  ArangoDB

• Published image artifact details:
  repo-info repo's repos/arangodb/ directory (history)
  (image metadata, transfer size, etc)

• Image updates:
  official-images PRs with label library/arangodb
  official-images repo's library/arangodb file (history)

• Source of this description:
  docs repo's arangodb/ directory (history)

• Supported Docker versions:
  the latest release (down to 1.6 on a best-effort basis)

ArangoDB is a multi-model, open-source database with flexible data models for documents, graphs, and key-values. Build high performance applications using a convenient SQL-like query language or JavaScript extensions. Use ACID transactions if you require them. Scale horizontally and vertically with a few mouse clicks.

The supported data models can be mixed in queries and allow ArangoDB to be the aggregation point for the data request you have in mind.

arangodb.com

Multi-Model Documents, graphs and key-value pairs — model your data as you see fit for your application.

Joins Conveniently join what belongs together for flexible ad-hoc querying, less data redundancy.

Transactions Easy application development keeping your data consistent and safe. No hassle in your client.

Joins and Transactions are key features for flexible, secure data designs, widely used in RDBMSs that you won't want to miss in NoSQL products. You decide how and when to use Joins and strong consistency guarantees, keeping all the power for scaling and performance as choice.

Furthermore, ArangoDB offers a microservice framework called Foxx to build your own Rest API with a few lines of code.

• ArangoDB Documentation
• ArangoDB Tutorials

In order to start an ArangoDB instance run

unix> docker run -e ARANGO_RANDOM_ROOT_PASSWORD=1 -d --name arangodb-instance arangodb

Will create and launch the arangodb docker instance as background process. The Identifier of the process is printed. By default ArangoDB listen on port 8529 for request and the image includes EXPOSE 8529. If you link an application container it is automatically available in the linked container. See the following examples.

In order to get the IP arango listens on run:

unix> docker inspect --format '{{ .NetworkSettings.IPAddress }}' arangodb-instance

In order to use the running instance from an application, link the container

unix> docker run -e ARANGO_RANDOM_ROOT_PASSWORD=1 --name my-app --link arangodb-instance:db-link arangodb

This will use the instance with the name arangodb-instance and link it into the application container. The application container will contain environment variables

DB_LINK_PORT_8529_TCP=tcp://172.17.0.17:8529
DB_LINK_PORT_8529_TCP_ADDR=172.17.0.17
DB_LINK_PORT_8529_TCP_PORT=8529
DB_LINK_PORT_8529_TCP_PROTO=tcp
DB_LINK_NAME=/naughty_ardinghelli/db-link

These can be used to access the database.

If you want to expose the port to the outside world, run

unix> docker run -e ARANGO_RANDOM_ROOT_PASSWORD=1 -p 8529:8529 -d arangodb

ArangoDB listen on port 8529 for request and the image includes EXPOSE 8529. The -p 8529:8529 exposes this port on the host.

The ArangoDB image provides several authentication methods which can be specified via environment variables (-e) when using docker run

1. ARANGO_RANDOM_ROOT_PASSWORD=1

   Generate a random root password when starting. The password will be printed to stdout (may be inspected later using docker logs)

2. ARANGO_NO_AUTH=1

   Disable authentication. Useful for testing.

   WARNING Doing so in production will expose all your data. Make sure that ArangoDB is not diretcly accessible from the internet!

3. ARANGO_ROOT_PASSWORD=somepassword

   Specify your own root password.

In order to get a list of supported options, run

unix> docker run -e ARANGO_RANDOM_ROOT_PASSWORD=1 arangodb arangod --help

ArangoDB use the volume /var/lib/arangodb3 as database directory to store the collection data and the volume /var/lib/arangodb3-apps as apps directory to store any extensions. These directories are marked as docker volumes.

Please note that the old version 2.x used /var/lib/arangodb and /var/lib/arangodb-apps. We will refer to the 3.x variant in this document. In case you are starting a 2.x image just replace it with the 2.x variant.

See docker inspect --format "{{ .Config.Volumes}}" arangodb for all volumes.

A good explanation about persistence and docker container can be found here: Docker In-depth: Volumes, Why Docker Data Containers are Good

You can map the container's volumes to a directory on the host, so that the data is kept between runs of the container. This path /tmp/arangodb is in general not the correct place to store you persistent files - it is just an example!

unix> mkdir /tmp/arangodb
unix> docker run -e ARANGO_RANDOM_ROOT_PASSWORD=1 -p 8529:8529 -d \
          -v /tmp/arangodb:/var/lib/arangodb3 \
          arangodb

This will use the /tmp/arangodb directory of the host as database directory for ArangoDB inside the container.

Alternatively you can create a container holding the data.

unix> docker create --name arangodb-persist arangodb true

And use this data container in your ArangoDB container.

unix> docker run -e ARANGO_RANDOM_ROOT_PASSWORD=1 --volumes-from arangodb-persist -p 8529:8529 arangodb

If want to save a few bytes you can alternatively use busybox or alpine for creating the volume only containers. Please note that you need to provide the used volumes in this case. For example

unix> docker run -d --name arangodb-persist -v /var/lib/arangodb3 busybox true

If you are using the image as a base image please make sure to wrap any CMD in the exec form. Otherwise the default entrypoint will not do its bootstrapping work.

Arangodb itself is licensed under the Apache License, but it contains software of third parties under their respective licenses.