Skip to main content
The first time an admin signs in, setup has three steps: an AI model, an embedding model and storage. The AI model and embedding model steps must be completed. Storage is optional and defaults to local storage. Email (SMTP), connectors and the rest are configured afterwards in Workspace settings.

Step 1: Configure AI Model (Required)

Before proceeding with the setup, configuring an AI model is mandatory. Enter Pipeshub stays disabled until this step is saved.
  1. Select the AI provider.
  2. Provide the fields the provider asks for (for example the API key and the model name).
  3. Save the model, then click Next.
Onboarding AI model step with the list of model providersOnboarding AI model step with the list of model providers

For more info, refer to AI models Configuration Guide.

AI model configuration is required to enable AI-powered features.

Step 2: Configure Embeddings Model (Required)

The Embeddings Configuration section is part of the System Setup workflow for enabling semantic search and document retrieval features in your application. This configuration step allows you to define the embedding provider and specify the model used for generating vector representations of textual content.
  1. Select the embedding provider.
  2. Provide the fields the provider asks for (for example the endpoint, API key and model name).
  3. Save the model, then click Next.
Onboarding embedding model step with the list of embedding providersOnboarding embedding model step with the list of embedding providers
Next stays disabled until an embedding model is saved. If your deployment offers a system-provided default, Skip opens its setup; press Add model there to save it. You can change the embedding model later in workspace settings.

Step 3: Configure Storage (Optional)

Setting up storage allows the system to save and retrieve data efficiently. By default, local storage (local machine) will be used to store the files.
  1. Under Provider type, choose Local (system default) or Amazon S3.
  2. Enter the corresponding configuration.
  • Mount name and Base URL (both optional) for Local (system default).
  • Bucket and Region, plus an optional Access key and Secret key, for Amazon S3. Leave both keys blank to use the server’s IAM role.
Click Save, then Enter Pipeshub.
Onboarding storage step with Local storage selectedOnboarding storage step with Local storage selected

For more info, refer to Storage Service documentation.

You can skip this step. By default Local storage will be chosen.

After onboarding

Click Enter Pipeshub to finish. Then, in Workspace settings:
  • Set up email (SMTP) under Workspace > Mail. See the SMTP guide.
  • Add connectors under Connectors. See Connectors.