cli icon indicating copy to clipboard operation
cli copied to clipboard

`supabase start` doc should mention what each docker service does

Open kjrocker opened this issue 3 years ago • 0 comments

Improve documentation

Link

CLI Reference

Describe the problem

The docs for supabase start list all the docker services we can exclude, but lacks any context. If I'm not using Storage, which can I drop? Ditto for functions.

If I just want Auth and the Database, which do I need?

Describe the improvement

Going into depth on which docker services map to which features is probably too much to put under a CLI command (but we should do it elsewhere!), so just for supabase start I'd suggest listing a few services/features alongside their docker services.

We should also call out that anyone running supabase start in a CI environment can probably exclude studio (and anything else that's only needed for the WebUI)

This example is just the format, I have no idea which services actually map to which features.

Database - postgrest, pgadmin-schema-diff, migra, postgres-meta
Auth - postgrest, pgadmin-schema-diff, migra, postgres-meta
Storage - storage-api, gotrue
Web UI - studio

Additional context

Add any other context or screenshots that help clarify your question.

kjrocker avatar Jan 18 '23 10:01 kjrocker