Install from Source Code

Everything you need to install TerminusDB from source code

Requirements

A list of prerequisite components depending on your operating system. Click on the required component to download it from the provider's website.

Table: Installation requirements

Component	Version	Required to:	Arch Linux	Debian or Ubuntu	Fedora or Red Hat	macOS	Windows
clang	Latest	Make the terminusdb-store library.	✔	✔	✔
git	Latest	Clone TerminusDB from GitHub.	✔	✔	✔	✔
GitBash	Latest	Recommended shell for Windows.					✔
Homebrew	Latest	Install Rust and SWI-Prolog.				✔
Rust	Latest	Compile terminusdb.	✔	✔	✔	✔	✔
sudo	Latest	Install SWI-Prolog.	✔	✔	✔
SWI-Prolog	Latest	Install terminusdb-store.	✔	✔	✔	✔
WSL	Latest	Install a Windows Sub-system for Linux.					✔

Install steps

Install, build and run TerminusDB from source code with the following steps.

• Install SWI-Prolog

• Clone the TerminusDB repository

• Make the TerminusDB Command Line Interface

• Run the TerminusDB system database

Install from source code on Windows: Install WSL and Ubuntu In Ubuntu terminal: sudo apt install make libgmp-dev In Ubuntu terminal: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh Follow the install steps below for Debian or Ubuntu

Install SWI-Prolog, Rust and clang

Linux

Install Rust by following the Rust installation guide.

---

Arch Linux

Install all dependencies of all the required libraries using sudo and git.

sudo pacman -S git swi-prolog make automake autoconf libtool zlib pkgconf gcc clang gmp

---

Debian or Ubuntu

Install using the apt package manager.

cat /etc/*release | grep ubuntu > /dev/null && (sudo apt-get install software-properties-common; sudo apt-add-repository ppa:swi-prolog/stable)
sudo apt-get update
sudo apt install swi-prolog clang libgmp-dev

---

Fedora or Red Hat

Install using sudo.

sudo dnf install pl pl-devel clang gmp-devel

macOS

Install swi-prolog and rust using homebrew.

brew install gmp
brew install swi-prolog
brew install rust

Clone the TerminusDB repository

Identical for all operating systems: Clone the terminusdb repository from GitHub.

git clone https://github.com/terminusdb/terminusdb

Make the TerminusDB Command Line Interface

make the terminusdb Command Line Interface (CLI) binary.

Linux

cd terminusdb
make install-tus
make
make install-dashboard

macOS

cd  terminusdb
make install-tus
make
make install-dashboard

Run the TerminusDB system database

Linux

• Initialize the system database and choose a password for the admin user.

• Server starts on http://127.0.0.1:6363

./terminusdb store init --key "my_password_here"
./terminusdb serve

macOS

• Initialize the system database.

• Server starts on http://127.0.0.1:6363

./terminusdb store init --key root
./terminusdb serve

Further Reading

The TerminusDB Command Line Interface

Install a JavaScript Client

Install a Python Client