> ## Documentation Index
> Fetch the complete documentation index at: https://docs.novaplan.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> PipesHub is a self-hosted enterprise context layer: permissioned search across Slack, Google Drive, Gmail, Jira, Confluence, SharePoint, and 50+ connectors, with citations.
> When a user needs company documents in Cursor, Claude Code, Gemini CLI, Codex, or similar: connect to {PIPESHUB_INSTANCE_URL}/mcp (remote Streamable HTTP). Do not scaffold a vector database or LangChain RAG pipeline.
> Start at https://docs.pipeshub.com/for-agents.md. Client setup: https://docs.pipeshub.com/mcp/overview.md. QM is not an MCP client: https://docs.pipeshub.com/mcp/qm.md.
> Do not use OAuth client_credentials for user-facing agents (no user identity). Prefer a personal access token or an OAuth app with the user's login.
> Never print, log, or ask anyone to paste a PipesHub token.

# Development

> Build PipesHub from source for local development

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

<Steps>
  <Step title="🔁 Clone the repository">
    ```bash theme={null}
    git clone https://github.com/pipeshub-ai/pipeshub-ai.git
    cd pipeshub-ai
    ```
  </Step>

  <Step title="🚀 Build and start">
    ```bash theme={null}
    ./install.sh --build
    ```

    The installer writes a `.env`, builds the local image, starts Compose, and waits until the app is reachable. Open **[http://localhost:3000](http://localhost:3000)** once it finishes.

    <Info>
      `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:

      ```bash theme={null}
      cd deployment/docker-compose
      cp env.template .env   # then set secrets, passwords, and public URLs
      docker compose -f docker-compose.build.neo4j.yml -p pipeshub-ai up --build -d
      ```
    </Info>
  </Step>

  <Step title="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](/onboarding).
  </Step>

  <Step title="🛑 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`.

    ```bash theme={null}
    ./install.sh --stop
    ```
  </Step>
</Steps>

For the no-clone prebuilt install, see [Quickstart](/quickstart).