015ca3f899
The page was 2,883 words across seven H2 groups, and the intro listed seven paths. Grouping by information type on one page wasn't enough. The explainer and reference material move to their own page, and the troubleshooting group moves to troubleshooting entries, which are auto-indexed and need no navigation entry. The guide is now 1,180 words and lists three paths. - Add "Connection pooling and limits" as a child page: how pooling works, shared against dedicated poolers, pool size, connection limits, and monitoring. - Move the endpoint and IP version table up beside the connection strings it explains, rather than leaving it in a separate reference group. - Replace the troubleshooting group with two new troubleshooting entries, "Tenant or user not found" and "FATAL: Password authentication failed", and links to the existing entries for connection refused and too many connections. The existing connection-refused entry is stronger than what was here: it names the IP ban and gives the unban procedure. - Cut the pool size worked example. It said a pool size of 30 is a shared ceiling across session and transaction mode, while the Supavisor FAQ and the terminology entry both say pool size is per user, database, and mode combination. The text came from master, so the contradiction is pre-existing. Link the FAQ as the authority rather than picking a side. - Drop the duplicate pg_stat_ssl query. It already exists in connection-management and monitor-supavisor-postgres-connections, both with column tables this page lacked. Keep the one query that is unique. - Trim the application-side and server-side pooler sections, which were near-duplicates of the Supavisor FAQ down to the same three example libraries. Add the subsection to the navigation, which also adopts connecting-to-postgres/serverless-drivers. That page existed on disk and was referenced nowhere in the navigation constants. Repoint every inbound anchor, including six files in apps/www that no previous pass in this stack checked. Most of those were already broken on master.
Supabase Studio
A dashboard for managing your self-hosted Supabase project, and used on our hosted platform. Built with:
What's included
Studio is designed to work with existing deployments - either the local hosted, docker setup, or our CLI. It is not intended for managing the deployment and administration of projects - that's out of scope.
As such, the features exposed on Studio for existing deployments are limited to those which manage your database:
- Table & SQL editors
- Saved queries are unavailable
- Database management
- Policies, roles, extensions, replication
- API documentation
Managing Project Settings
Project settings are managed outside of the Dashboard. If you use docker compose, you should manage the settings in your docker-compose file. If you're deploying Supabase to your own cloud, you should store your secrets and env vars in a vault or secrets manager.
How to contribute?
- Branch from
masterand name your branches with the following structure{type}/{branch_name}- Type:
chore | fix | feature - The branch name is arbitrary — just make sure it summarizes the work.
- Type:
- When you send a PR to
master, it will automatically tag members of the frontend team for review. - Review the main contributing guide to help test your feature before sending a PR.
- The Dashboard is under active development. You should run
git pullfrequently to make sure you're up to date.
Developer Quickstart
Note
Supabase internal use: To develop on Studio locally with the backend services, see the instructions in the internal
infrastructurerepo.
# You'll need to be on Node v22
# in /studio
## For external contributors
pnpm install # install dependencies
pnpm run dev # start dev server
## For internal contributors
## First clone the private supabase/platform repo and follow instructions for setting up mise
mise studio # Run from supabase/platform alongside `mise infra`
## For all
pnpm run test # run tests
pnpm run test -- --watch # run tests in watch mode
Running within a self-hosted environment
Follow the self-hosting guide to get started.
cd ..
cd docker
docker compose -f docker-compose.yml -f ./dev/docker-compose.dev.yml up
Once you've got that set up, update .env in the studio folder with the corresponding values.
POSTGRES_PASSWORD=
SUPABASE_ANON_KEY=
SUPABASE_SERVICE_KEY=
Then run the following commands to install dependencies and start the dashboard.
npm install
npm run dev
If you would like to configure different defaults for "Default Organization" and "Default Project", you will need to update the .env in the studio folder with the corresponding values.
DEFAULT_ORGANIZATION_NAME=
DEFAULT_PROJECT_NAME=