Getting Started with SharkCluster

Installation

SharkCluster is a self-hosted solution for managing Supabase instances. Follow these steps to get started.

Prerequisites

• Ubuntu 20.04 or later (or compatible Linux distribution)
• Docker and Docker Compose installed
• Node.js 16+ installed
• At least 2GB RAM and 20GB storage

Installation Steps

1. Clone the repository:

   git clone https://github.com/magento-dev2/sharkcluster2026.git
   cd sharkcluster2026

2. Install dependencies:

   npm install

3. Configure environment variables:

   cp .env.example .env
   # Edit .env with your settings

4. Start the services:

   docker-compose up -d
   npm run dev

Quick Start

1. Access SharkCluster Dashboard

Open your browser and navigate to: http://localhost:3000

2. Create a Server

Add your server connection details (SSH credentials, domain, etc.)

3. Deploy Supabase

Click "Install Supabase" and follow the deployment wizard. This will take 5-10 minutes.

4. Access Your Instance

Once deployed, click "Open Studio" to access your Supabase dashboard.

Configuration

Environment Variables

SharkCluster uses the following key environment variables:

Network Configuration

Make sure the following ports are accessible:

• 3000 - Dashboard UI
• 3001 - API Server
• 5432 - PostgreSQL (internal)
• 80/443 - Supabase instances (reverse proxy)

Next Steps

Now that you have SharkCluster set up, explore the following:

• View all features
• Display Supabase Credentials
• Configure Email Templates
• Explore the API