Setting up hgres

Copy link to this sectionIntroductionCopy link to this section

hgres is the multi-temporal graph engine that powers HASH — the type system and entity store, usable on its own without the rest of the application. To learn more about hgres and its unique capabilities, visit hgres.org

Copy link to this sectionWhy self-host hgres?Copy link to this section

If you're looking for a headless, multi-temporal, SemType-compatible property graph… hgres is for you.

If you want a graphical user interface on top of hgres, a more fully-functional entity/type management experience, or the ability to integrate data seamlessly from external sources via ready-made integrations and AI extractors, use HASH instead.

Copy link to this sectionLocal setupCopy link to this section

Like HASH itself, hgres can be run locally on a single machine via Docker, enabled via a single Docker Compose file.

Copy link to this section1. PrerequisitesCopy link to this section

To get started, you'll need the following installed:

• Git (≥ 2.17)
• Docker (≥ 20.10) with Docker Compose (≥ 2.17) and Docker Buildx (≥ 0.10)
• At least 8 GB RAM allocated to Docker (Preferences → Resources)
• Around 15 GB free disk space for images and volumes

Copy link to this section2. Start hgresCopy link to this section

git clone https://github.com/hashintel/hash.git
cd hash/infra/compose
docker compose --profile hgres up -d

This starts hash-graph together with only its dependencies (Postgres and Temporal).