Quickstart

How to deploy PipesHub Workplace AI platform on your local machine

Requirements

• Docker with Compose v2

Coding agent standing this up for a user who has no PipesHub yet? Follow Local Docker demo. Do not scaffold LangChain. First-run (account + LLM) stays in the browser.

Setup

Quickstart (Recommended)

Note: If you are deploying PipesHub on a cloud server, make sure you are using an HTTPS endpoint. PipesHub enforces stricter security checks, and browsers will block certain requests when the application is served over HTTP.

You can use a reverse proxy like Cloudflare, Nginx, or Traefik to terminate SSL/TLS and provide a valid HTTPS certificate.

If you see a white screen after deploying PipesHub while accessing it over HTTP, this is likely the cause. The frontend will refuse to load due to stricter security checks.

1. ⚡ Run the one-command installer

   curl -fsSL https://get.pipeshub.com/install | bash
   

   This downloads the deployment files for the latest GitHub release into ./pipeshub (falling back to main if the unauthenticated GitHub API lookup fails — 60 requests/hour per IP) and launches the interactive installer. Open http://localhost:3000 once it finishes.

   get.pipeshub.com/install is a 302 to the root install.sh on GitHub (https://raw.githubusercontent.com/pipeshub-ai/pipeshub-ai/main/install.sh). The wrapper then fetches docker-compose.yml and the in-tree installer for that resolved ref.

   Prefer to read before running?

   curl -fsSL https://get.pipeshub.com/install -o pipeshub-install.sh
   less pipeshub-install.sh        # review it
   bash pipeshub-install.sh
   

   The installer will:

   • Check Docker, RAM, and disk prerequisites
   • Ask whether you want a slim or full deployment
   • Let you optionally customize the graph DB, message broker, and KV store
   • Generate randomized secrets and write a .env file
   • Pull images and start the stack
   • Wait for PipesHub to become healthy, verify it is reachable, and print the URL

   When prompted for a Public HTTPS URL, enter the URL you’ll use to access PipesHub (e.g. https://pipeshub.yourdomain.com). This is written to .env as FRONTEND_PUBLIC_URL and is required for OAuth callbacks, email invites, and to avoid the HTTP white-screen issue described above. Leave it blank only for local, localhost-only access. You can update it later by editing .env and running ./install.sh --reconfigure from the directory the installer prints, or by setting PIPESHUB_PUBLIC_URL for a non-interactive install.

   Installer options

   Flag	Description
   -y / --yes	Accept all defaults; skip interactive prompts (CI-friendly)
   --version TAG	Pin the Docker image tag only, e.g. --version 0.7.0. Does not pin compose/installer files — use PIPESHUB_REF for that
   --no-pull	Keep the locally cached images (do not refresh)
   --reconfigure	Re-run the wizard and overwrite an existing .env
   --print-env-only	Write .env and print the compose command without starting containers
   --upgrade	Pull/rebuild images and recreate containers using the existing .env
   --stop	Stop the running stack (data preserved)
   --uninstall	Stop the stack and remove all data volumes
   --build	Build the image locally instead of pulling from Docker Hub (clone only)

   Standalone curl | bash uses prebuilt Hub images only. --build needs a git clone — see From a cloned repository.

   Standalone-only environment overrides (set them on the bash side of the pipe):

   Variable	Description
   PIPESHUB_REF	Branch, tag, or commit SHA for docker-compose.yml and the in-tree installer. Default: latest GitHub release, else main
   PIPESHUB_DIR	Directory to download deployment files into. Default: ./pipeshub

   Advanced options such as CI environment variables, slim vs. full deployment types, a second instance on the same host, and manual Compose profile usage are covered in Advanced Deployment Options.

2. 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.

3. 🛑 To stop the services

   curl | bash does not cd your shell. The success banner prints the directory for later commands — ./pipeshub by default, or PIPESHUB_DIR if you set it. --stop, --upgrade, --reconfigure, and --uninstall all run from there.

   cd pipeshub
   ./install.sh --stop
   

From a cloned repository (developers)

Requires Git. To build from source, contribute, or pin the installer to your checkout:

git clone https://github.com/pipeshub-ai/pipeshub-ai.git
cd pipeshub-ai

# Same installer, run from the repo root
./install.sh

Building local images from source requires this cloned-repo path (./install.sh --build). The one-command installer above always uses prebuilt images. From a clone, run --stop, --upgrade, --reconfigure, and --uninstall from this same repository root.