Supabase

Overview

Supabase provides a comprehensive interface to manage your Supabase installation. It allows you to monitor service status, access the Supabase Studio dashboard, view API Gateway information, and link Supabase to a custom domain with SSL.

Installation

To enable the Supabase menu, you must first install the application on your server.

1. Go to the Applications section of your server.
2. Scroll down to the Uninstalled section.
3. Locate Supabase in the list.
4. Click the Install button.
5. Enter a Password for the Supabase Studio dashboard and a Port (default: 8000).
6. Click Install to begin the installation process. Docker will be automatically installed if not already present.

Usage Guide

Status

The Status card displays key information about your Supabase instance:

• Version: The currently installed version of Supabase.
• Port: The port on which Supabase is running.

Accessing the Dashboard

Supabase Studio Dashboard

The Access Links card provides the URL to access Supabase Studio. Use the buttons to:

• Copy: Copy the Studio URL to your clipboard.
• Open: Open Studio in a new browser tab.

Basic Auth Credentials

When accessing Supabase Studio, the browser will prompt you to log in:

• Username: supabase
• Password: The password you entered during installation.

You can change the password by editing DASHBOARD_PASSWORD in /opt/supabase/.env and restarting Supabase.

API Gateway

The API Gateway URL is used by your applications to connect to Supabase services (REST API, Auth, Storage, Realtime). Copy this URL and use it in your application configuration.

Access via Domain

You can link Supabase to a website to access it via a custom domain name with SSL, instead of using the IP address and port directly.

Linking to a Website

1. Click the Link to Website button.
2. Choose one of two options:
   • Select Existing Website: Pick a website already created on this server from the dropdown, then click Link.
   • Create New Website: Fill in the details to create a new website that will act as a reverse proxy to Supabase.
3. Once linked, the Studio Dashboard and API Gateway URLs will automatically update to use the linked domain.

Managing Linked Websites

After linking, the Access via Domain section displays all linked websites with the following actions:

• Manage: Navigate to the website management page.
• Access: Open the website in a new browser tab.
• Unlink: Remove the link between the website and Supabase.

You can link multiple websites to Supabase by clicking Link another Website.

Service Management

Located at the top right of the page:

• Service Status: View if the service is Running or Stopped.
• Actions:
  • Use the Restart, Stop, or Start buttons to control the service.
  • Click Update (if visible) to upgrade to the latest version.
  • Click Uninstall to remove Supabase from your server.

Notes & Warnings

• Warning: Exposing Supabase via a public domain makes it accessible from the internet. Ensure your Basic Auth password is strong.
• Note: Supabase requires Docker to run. Docker will be automatically installed during the Supabase installation process.
• Note: The default port is 8000. Make sure this port is not already in use by another application.