Installing Soom Connect

This guide will walk you through installing and setting up Soom Connect in your environment.

Prerequisites

Before installing Soom Connect, ensure you have:

System Requirements

Operating System: Windows 10+, macOS 10.15+, or Linux (Ubuntu 18.04+)
Memory: Minimum 4GB RAM (8GB recommended)
Storage: At least 2GB free disk space
Network: Internet connection for downloading and updates

Software Requirements

Node.js: Version 18.17.0 or higher
npm/pnpm/yarn: Package manager
Docker: For containerized deployment (optional)
Git: For version control (optional)

Installation Methods

Method 1: Direct Installation

Download the Soom Connect installer from the official website
Run the installer and follow the setup wizard
Configure your environment variables
Start the Soom Connect service

Method 2: Package Manager

# Using npm
npm install -g @soom/connect

# Using pnpm
pnpm install -g @soom/connect

# Using yarn
yarn global add @soom/connect

Method 3: Docker Installation

# Pull the Docker image
docker pull soom/connect:latest

# Run the container
docker run -d --name soom-connect -p 3000:3000 soom/connect:latest

Configuration

Environment Variables

Set up the following environment variables:

# Core configuration
SOOM_CONNECT_PORT=3000
SOOM_CONNECT_ENV=development

# Database configuration
SOOM_CONNECT_DB_URL=postgresql://localhost:5432/soom_connect

# Authentication
SOOM_CONNECT_JWT_SECRET=your-secret-key

# External services
SOOM_CONNECT_REDIS_URL=redis://localhost:6379

Initial Setup

Create Admin Account: Set up your administrator account
Configure Database: Set up your database connection
Set Up Authentication: Configure authentication settings
Install Connectors: Install the connectors you need

Verification

After installation, verify that Soom Connect is running correctly:

Check Service Status: Ensure the service is running
Access Web Interface: Open the web interface in your browser
Test Connections: Test basic connectivity
Review Logs: Check installation logs for any issues

Next Steps

Key Concepts - Understand core concepts
Create Flow - Build your first integration
Available Apps - Explore supported applications

Installing Soom Connect

On this page