https://github.com/rb58853/supabase-connection-tester
A simple tool designed to test connections with Supabase hosted on Docker or a VPS.
https://github.com/rb58853/supabase-connection-tester
docker httpx-client python supabase
Last synced: 10 days ago
JSON representation
A simple tool designed to test connections with Supabase hosted on Docker or a VPS.
- Host: GitHub
- URL: https://github.com/rb58853/supabase-connection-tester
- Owner: rb58853
- Created: 2025-06-19T13:11:32.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-06-22T18:46:40.000Z (10 months ago)
- Last Synced: 2025-06-30T01:02:45.011Z (10 months ago)
- Topics: docker, httpx-client, python, supabase
- Language: Python
- Homepage:
- Size: 75.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Supabase Connection Tester
This project is a simple tool designed to test connections with Supabase hosted on Docker or a VPS. It also integrates with environments like Kong for API gateway management.
## Features
- Test connectivity with Supabase instances.
- Support for Docker and VPS-hosted environments.
## Prerequisites
- Python 3.8 or higher.
- Supabase instance (hosted locally or on a VPS).
## Installation
1. Clone the repository:
```bash
git clone https://github.com/rb58853/supabase-connection-tester.git
cd supabase-connection-tester
```
2. Install dependencies:
```bash
pip install -r requirements.txt
```
3. Set up environment variables:
Create a `.env` file in the root directory and configure the following:
```env
# Required for remote Supabase projects (optional for local development)
SUPABASE_PROJECT_REF=http://HOSTNAME:PORT/ or https://subdomain.domain.ext
SUPABASE_DB_PASSWORD=your-postgres-password
SUPABASE_REGION=us-east-1
# Optional configuration
SUPABASE_ACCESS_TOKEN=your-supabase-access-token
SUPABASE_SERVICE_ROLE_KEY=your-service-role-key
# Docker Container Environment
CONTAINER_EXPOSE_IP=xxx.xx.xx.xx
USER_ACCESS_TOKEN=your-user-access-token
## DATABASE
DATABASE_NAME=postgres
DATABASE_USER=postgres
## POOLER
POOLER_PROXY_PORT_TRANSACTION=6543
POOLER_TENANT_ID=your-tenant-id
```
## Usage
### Running the Connection Tester
To test the connection with your Supabase instance:
```bash
python test_connection.py
```