Self-managed deployments
TypeDB Community Edition can be installed in several ways: using the Docker image, via a package manager, or by manual installation. For TypeDB Enterprise installation and setup, see the TypeDB Enterprise page.
Package manager
-
macOS
-
Linux
-
Windows
To install TypeDB via Homebrew:
brew tap typedb/tap
brew install typedb/tap/typedb
-
Add the TypeDB repository:
sudo apt install software-properties-common apt-transport-https gpg gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-key 17507562824cfdcc gpg --export 17507562824cfdcc | sudo tee /etc/apt/trusted.gpg.d/typedb.gpg > /dev/null echo "deb https://repo.typedb.com/public/public-release/deb/ubuntu trusty main" | sudo tee /etc/apt/sources.list.d/typedb.list > /dev/null sudo apt update
-
Ensure Java 11+ is installed:
sudo apt install default-jre
TypeDB supports OpenJDK and Oracle JDK.
-
Install TypeDB:
sudo apt install typedb
If you had an older version (≤
2.25.5
) of TypeDB installed, you might first need to uninstall older packages to avoid conflicts:sudo apt remove typedb-server typedb-bin typedb-console
No package manager option is available for Windows. See the Manual install section below.
Docker
To pull the latest TypeDB Docker image:
docker pull vaticle/typedb:latest
You can replace latest
with a version number to get a specific version of TypeDB Core.
To check the list of available versions,
see the Releases page.
Run
To create a new Docker container with TypeDB Core server:
docker volume create typedb-data
docker create --name typedb -v typedb-data:/opt/typedb-all-linux-x86_64/server/data -p 1729:1729 --platform linux/amd64 vaticle/typedb:latest
Where typedb
is the name of the container, and typedb-data
is the name of the volume to persist data. The --platform linux/amd64
parameter is required to run the TypeDB container on macOS with the arm64
architecture.
To stop a running Docker container:
docker stop typedb
To start the created Docker container, or restart a stopped container:
docker start typedb
Manual install
Download the latest version of TypeDB from the table below.
Release notes | macOS | Linux | Windows |
---|---|---|---|
For all versions, see the Packages page.
-
macOS
-
Linux
-
Windows
-
Ensure Java 11+ is installed. TypeDB supports OpenJDK and Oracle JDK.
To check the Java SDK version:
/usr/libexec/java_home -V
TypeDB runs natively on both
arm64
andx86_64
architectures. For the best performance, make sure both TypeDB and Java SDK match your native architecture and are not using Rosetta. -
Extract the archive with TypeDB into a new directory:
sudo mkdir /opt/typedb unzip ~/Downloads/<filename>.zip -d /opt/typedb
Where
<filename>
is the name of the archive. -
Add a symlink to the TypeDB executable in the
/usr/local/bin
directory:ln -s /opt/typedb/<filename>/typedb /usr/local/bin/typedb
-
Ensure Java 11+ is installed. TypeDB supports OpenJDK and Oracle JDK.
-
Extract the archive with TypeDB into a new directory:
mkdir /opt/typedb tar -xzf ~/Downloads/<filename>.tar.gz -C /opt/typedb
Where
<filename>
is the name of the archive. -
Add a symlink to the TypeDB executable in the
/usr/local/bin
directory:ln -s /opt/typedb/<filename>/typedb /usr/local/bin/typedb
-
Ensure Java 11+ is installed. TypeDB supports OpenJDK and Oracle JDK.
-
Extract the archive with TypeDB into a new directory:
mkdir "C:\Program Files\TypeDB" tar xvf "C:\Users\username\Downloads\<filename>.zip" -C "C:\Program Files\TypeDB"
Where
<filename>
is the name of the archive. -
Update the
PATH
environment variable:setx /M PATH "%path%;C:\Program Files\TypeDB\<filename>"
Restart the terminal window for the changes to environment variables to take effect.