Skip to content

Instantly share code, notes, and snippets.

@larson-carter
Created November 4, 2024 18:15
Show Gist options
  • Save larson-carter/19d721b16ad531dcc1311afd78a9b1cd to your computer and use it in GitHub Desktop.
Save larson-carter/19d721b16ad531dcc1311afd78a9b1cd to your computer and use it in GitHub Desktop.

Supabase Self-Hosting Documentation Feedback

Overview

I've reviewed the Supabase Self-Hosting Guide and have several suggestions to improve clarity and user experience.

Hosting Options

Current Options

  • Docker
  • BYO Cloud

Suggested Addition

  • We Host It (Starting Free)

Recommendation:

  • Add a "We Host It" option starting at a free tier.
  • Place this option alongside Docker and BYO Cloud for better visibility.

Rationale:

  • Users may prefer Supabase hosting if it's free up to a certain limit, increasing adoption.
  • This will provide visibility reminding that users are not forced to self-host or BYO Cloud being only enterprise.

Installation Methods

Current Options

  • Docker
  • BYO Cloud (includes Kubernetes, Terraform, Traefik, AWS - Community supported)

Suggestions

  1. Raw Installation:

    • Is it possible to have raw installations? If so,
    • Provide a method to install Supabase directly on a machine without using Docker.
  2. Community Links:

    • Redirect: Kubernetes, Terraform, Traefik, and AWS options to their respective community-supported sites instead of the pricing page.

Documentation Enhancements

Installing and Running Supabase

  • General vs Advanced Tabs:

    • Clarify the differences between General and Advanced installation options.
    • Ensure explanations are beginner-friendly.
  • Interactive Setup Script:

    • Create a simple bash script to automate installation.
    • Features to include:
      • Dependency checks
      • Setting secure keys
      • Configuring authentication
      • Interactive setup prompts
    • I think this will be great for beginners

Accessing Supabase Studio

  • IP Binding Explanation:

    • Clearly explain which IP Supabase Studio is bound to.
    • Differentiate between internal vs external IPs.
    • Provide examples for various environments:
      • Digital Ocean
      • Local PC containerized setups
  • Current Issue:

    • The IP explanation is only shown in the “Demo using Digital Ocean” section, which can confuse new developers.

Accessing Postgres

  • Connection Types:
    • Explain the difference between pooled vs session-based connections.
    • Provide guidance on which type a new developer should choose.

Updating Your Services

  • Automated Updates:
    • Develop a script to handle service updates.
    • Make the script compatible with cron jobs for automation.

Additional Suggestions

  • User Experience:

    • Enhance the overall clarity for beginners.
    • Ensure advanced options are well-explained for experienced users.
  • Community Support:

    • Highlight community-supported installation methods with direct links to relevant resources.

Links Referenced


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment