Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

supabase start doc should mention what each docker service does #857

Open
kjrocker opened this issue Jan 18, 2023 · 0 comments
Open

supabase start doc should mention what each docker service does #857

kjrocker opened this issue Jan 18, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@kjrocker
Copy link

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 kjrocker added the documentation Improvements or additions to documentation label Jan 18, 2023
@kiwicopple kiwicopple transferred this issue from supabase/supabase Feb 10, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants