How to Install OrientDB: A Step-by-Step Tutorial

OrientDB is a powerful multi-model NoSQL database that combines the strengths of document and graph databases. It is widely used for complex data models, including graph-based relationships. In this tutorial, we will walk through the process of installing OrientDB on your local machine or server and get you started with your database setup.

Prerequisites

A computer running Windows, macOS, or Linux
Java Runtime Environment (JRE) or Java Development Kit (JDK) version 8 or higher installed
(OrientDB requires Java to run)
Basic command line knowledge
Internet connection to download files
Administrative privileges to install software (on some systems)

Step 1: Verify Java Installation

Before installing OrientDB, make sure you have Java installed and properly configured.

java -version

If Java is not installed, download and install the latest stable version of Eclipse Temurin JDK (Official site) or Oracle JDK.

Step 2: Download OrientDB

Go to the official OrientDB website at https://orientdb.org/ (Official site) and navigate to the Download section. Choose the Community Edition if you want a free, open-source version.

Download the latest stable version in ZIP or TAR.GZ format based on your OS.

Step 3: Extract the Package

After the download completes, extract the archive to a preferred location on your computer. For example, on Linux/macOS, open a terminal and run:

tar -xzf orientdb-x.x.x.tar.gz -C /opt/

On Windows, right-click the ZIP file and choose ‘Extract All…’ to your desired folder.

Step 4: Configure Environment Variables (Optional but Recommended)

To simplify running OrientDB commands, add the OrientDB bin directory to your system’s PATH environment variable.

On Linux/macOS, add this line to your ~/.bashrc or ~/.zshrc file:

export PATH=/opt/orientdb-x.x.x/bin:$PATH

On Windows, add the full path to orientdb\bin to system environment variables via the Settings panel.

Step 5: Start OrientDB Server

Navigate to the bin directory inside your OrientDB installation folder using a terminal or command prompt and run the server start script:

Linux/macOS:

./server.sh

Windows:

server.bat

The server will start, and you should see the log output indicating that OrientDB is running.

Step 6: Access OrientDB Studio

OrientDB comes with a web-based interface called OrientDB Studio. Once the server is running:

Open your web browser and go to http://localhost:2480
The login screen appears. The default credentials are root for username and the password you set during the first startup (or root if prompted to set initially).

Step 7: Create Your First Database

After logging into Studio:

Click on Create Database
Enter the database name and choose the type (plocal for persistent local database or memory for in-memory testing)
Click Create

Your new OrientDB database is ready for use!

Troubleshooting

Java Not Found: Ensure Java is installed and your PATH is set correctly.
Port 2480 Busy: Another service might be using the default OrientDB port. Stop the conflicting service or change the port in the orientdb-server-config.xml file.
Permission Issues: Run the server with appropriate privileges or adjust file permissions on Linux/Mac.

Summary Checklist

Verify Java installation and version
Download OrientDB Community Edition
Extract package to appropriate directory
Optionally add OrientDB bin folder to PATH
Start the OrientDB server using the proper script
Access OrientDB Studio via web browser
Create your first database from Studio
Troubleshoot common issues if they arise

For more NoSQL database tutorials like this one, check out our detailed guide on How to Install ArangoDB which covers a similar multi-model NoSQL database.