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

# Quickstart

> How to deploy PipesHub Workplace AI platform on your local machine

## Requirements

* Git
* Docker with Compose

## Setup

### Production Deployment

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

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

    # Navigate to the deployment folder
    cd pipeshub-ai/deployment/docker-compose

    # Copy and update the environment file
    cp env.template .env

    # 👉 Edit the .env file to set secrets, passwords, and the public URLs
    # of the Frontend and Connector services (required for webhook notifications and real-time updates)

    # Start the production deployment
    docker compose -f docker-compose.prod.yml -p pipeshub-ai up -d



    ```
  </Step>

  <Step title="Onboarding Setup">
    1. After docker build is up and running, **open the UI** via localhost:3000 (if running on same system) or Frontend Public Url or Port that you entered in your .env.
    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">
    ```bash theme={null}
    docker compose -f docker-compose.prod.yml -p pipeshub-ai down
    ```
  </Step>
</Steps>

```
```