Requirements
- Docker with Compose 2.20 or later
- 4 CPU cores, a 16 GB-class machine (8 GB for the
evaltype) and 20 GB of free disk. See System Requirements.
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
./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?
- Check Docker, RAM, and disk prerequisites
- Ask whether you want a slim, full or eval deployment
- Let you optionally customize the graph DB, message broker, and KV store
- Generate randomized secrets and write a
.envfile - Pull images and start the stack
- Wait for PipesHub to become healthy, verify it is reachable, and print the URL
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. To change it later, edit FRONTEND_PUBLIC_URL in .env and run ./install.sh from the directory the installer prints. It reuses .env and recreates the containers. ./install.sh --reconfigure rewrites .env and asks for the URL again. For a non-interactive install, set PIPESHUB_PUBLIC_URL.Installer options
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):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
- 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.
- On the sign-up page, enter your first and last name, workspace name, email and password, and choose a preferred language. There is no account type to choose.
- You will then be redirected to the onboarding page, where you set up an AI model and an embedding model (both required) and storage (optional). You can change these later in Workspace settings.
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.From a cloned repository (developers)
Requires Git. To build from source, contribute, or pin the installer to your checkout:./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.