Supabase Docker

A simple Docker setup for Supabase.

Features

• Remove unnecessary services (realtime, storage, function) to improve performance.
• Add support for OAuth(github, twitter) providers.
• Add support for EMail Template.
• Add SSL support.
• Enable deploy in dokploy.

Getting started

Prerequisites

• Docker
• Docker Compose
• Git

Installation

git clone https://github.com/alex-guoba/supabase-docker.git
cd supabase-docker
cp .env.example .env
# Edit .env file to your needs

# Start Supabase
docker compose up -d

# Stop Supabase
docker compose down

Usage

After running docker compose up -d, you can access Supabase at http://127.0.0.1:8000.

Configuration

You can configure Supabase by editing the .env file.

Basic Configuration

• SITE_URL: The URL of your Application.
• API_EXTERNAL_URL: The URL of your Supabase Instance.
• ADDITIONAL_REDIRECT_URLS: Additional redirect URLs for OAuth providers.

Auth Provider

Add OAuth provider to auth section of docker-compose file. For example, to add Github OAuth provider:

# Github OAuth config in auth.enviroment
# Comment to disable this
GOTRUE_EXTERNAL_GITHUB_ENABLED: true
GOTRUE_EXTERNAL_GITHUB_CLIENT_ID: ${GITHUB_CLIENT_ID}
GOTRUE_EXTERNAL_GITHUB_SECRET: ${GITHUB_CLIENT_SECRET}
GOTRUE_EXTERNAL_GITHUB_REDIRECT_URI: ${AUTH_REDIRECT_URL}

Note that you need to set GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET in your .env file.

After adding the provider, You can use the API to verify the configuration of your OAuth providers:

curl 'https://<PROJECT_REF>.supabase.co/auth/v1/settings' \
-H "apikey: <ANON_KEY>" \
-H "Authorization: Bearer <ANON_KEY>"

or you can input the Auth Providers in Commmand Menu of Supabase to check the configuration.

SMTP

Use SMTP to send emails. In your .env file, add the following to configure your SMTP server:

SMTP_ADMIN_EMAIL=admin@example.com
SMTP_HOST=supabase-mail
SMTP_PORT=2500
SMTP_USER=fake_mail_user
SMTP_PASS=fake_mail_password
SMTP_SENDER_NAME=fake_sender

See Supabase SMTP for more details.

Email Templates

You can customize the email templates by editing the files in ./docker-compose.yml.

GOTRUE_MAILER_TEMPLATES_RECOVERY: ${MAILER_TEMPLATES_RECOVERY}
GOTRUE_MAILER_TEMPLATES_INVITE: ${MAILER_TEMPLATES_INVITE}
GOTRUE_MAILER_TEMPLATES_CONFIRMATION: ${MAILER_TEMPLATES_CONFIRMATION}
GOTRUE_MAILER_TEMPLATES_MAGIC_LINK: ${MAILER_TEMPLATES_MAGIC_LINK}
GOTRUE_MAILER_TEMPLATES_EMAIL_CHANGE: ${MAILER_TEMPLATES_EMAIL_CHANGE}

Set your environment value in .env:

MAILER_TEMPLATES_INVITE="https://example.com/templates/invite.html"
MAILER_TEMPLATES_CONFIRMATION="https://example.com/templates/confirm.html"
MAILER_TEMPLATES_RECOVERY="https://example.com/templates/recovery.html"
MAILER_TEMPLATES_MAGIC_LINK="https://example.com/templates/magic-link.html"
MAILER_TEMPLATES_EMAIL_CHANGE="https://example.com/templates/email-change.html"

The email templates are written in HTML and can be customized to fit your needs. See Supabase Email Templates for more details.

SSL Configuration

To enable SSL, you need to generate your own certificate and key files for Kong instance in supabase. Generate your cert and key files and copy it to ./volumns/ssl/ directory. In your .env file, add the following:

SSL_CERT="example.crt"
KONG_SSL_CERT_KEY="example.key"

Uncomment the following line in docker-compose.yml:

KONG_SSL_CERT: /mnt/ssl/${SSL_CERT_FILENAME}
KONG_SSL_CERT_KEY: /mnt/ssl/${SSL_CERT_KEY_FILENAME}

If you want to use a different way to maintain your certificate, like use Nginx as web-server and Let's Encrypt to generate and auto renew your certificate, you can uncomment it in docker-compose.yml.

Other Configuration

API Keys, Secrets, and other configurations can be found in the official Supabase documentation. Make sure to update your .env file accordingly.

See Docker Configuration for more details.

Development

All development is done in the main branch. There is a develop docker file for development. You can override the docker-compose.yml file to use it:

docker compose -f docker-compose.yml -f ./dev/docker-compose.dev.yml up

Deploy in Dokploy

Dokploy is a stable deployment platform for Docker applications. It is a simple way to deploy your Docker application to the cloud.

Dokploy provide some templates for all sort of Docker applications. we can use it to deploy Supabase.

If you want some customization, you can deploy through your docker-compose.yml file. Here is an example.

Here is the process to deploy Supabase from docker-compose.yml file.

1. Create a new project in Dokploy.
2. Create a Compose service in project.
3. Configure the deployment.

• Provider: set your github repo in github provider. or you can paste the contents of ./docker-compose.dokploy.yml in raw provider.
• Environment: paste the contents of ./.env in environment.
• Volumes: add all of volume files in volumes setting. for example:
  • Content: content of vector.sql
  • Path: set to /volumes/logs/vector.yml
• Docker links: enable Isolate Deployment in Utilities configuration.
• Domains: set your domain in domains.

4. Deploy.

License

MIT

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.