Skip to main content

​
Requirements

  • Git
  • Docker with Compose v2

​
Setup

​
📦 Developer Build

Use this path when you want to run images built from your checkout instead of pulling prebuilt images from Docker Hub.
1

🔁 Clone the repository

2

🚀 Build and start

The installer writes a .env, builds the local image, starts Compose, and waits until the app is reachable. Open http://localhost:3000 once it finishes.
docker-compose.build.neo4j.yml is a legacy standalone build file, not what ./install.sh --build drives. It hardcodes DATA_STORE=neo4j and has no ArangoDB or etcd profiles, builds pipeshub-ai:latest, and pins port 3000. (Kafka is available in it as an opt-in profile; the broker still defaults to Redis.) Do not run it against a stack the installer already started — that builds a second image into the same Compose project.It does not generate .env. Copy and edit one first, or Mongo/Neo4j start with empty passwords:
3

Onboarding Setup

  1. After the installer reports PipesHub is healthy, open the UI via localhost:3000 (if running on the same system) or the Frontend Public URL / port you configured.
  2. If you’re an individual, select the “Individual” account type. For businesses, choose “Enterprise” and complete your account setup by filling in the basic details.
  3. You will then be redirected to the onboarding page. Please fill in all the required information carefully. You can always update these details later under the “Profile” tab in the Settings page.
For more information, refer to our Onboarding Guide.
4

🛑 To stop the services

The success banner prints this directory. Run --stop, --upgrade, --reconfigure, and --uninstall from the repository root, not from deployment/docker-compose.
For the no-clone prebuilt install, see Quickstart.