Skip to main content

​
Requirements

  • Git
  • Docker with Compose v2

​
Setup

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

🔁 Clone the repository

2

⚡ Run the interactive installer

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 pass its health check 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, or by setting PIPESHUB_PUBLIC_URL for a non-interactive install.Open http://localhost:3000 once the installer completes.

​
Installer options

Advanced options such as CI environment variables, slim vs. full deployment types, manual Compose profile usage, and local source builds are covered in Advanced Deployment Options.
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