Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

There are unnecessary options in the .env.sample for self-hosting #26578

Open
XIYO opened this issue May 20, 2024 · 3 comments
Open

There are unnecessary options in the .env.sample for self-hosting #26578

XIYO opened this issue May 20, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers self-hosted Issues related to self hosting

Comments

@XIYO
Copy link

XIYO commented May 20, 2024

Improve documentation

Link

/docker/.env.sample

Describe the problem

Self-hosting does not support the use of Studio. However, the sample includes this option.

Describe the improvement

Remove settings related to Studio.

Additional context

Since Studio cannot be used in self-hosting, it is necessary to remove the description to prevent confusion among users. Alternatively, a detailed explanation should be provided.

## General
-SITE_URL=http://localhost:3000
ADDITIONAL_REDIRECT_URLS=
JWT_EXPIRY=3600
DISABLE_SIGNUP=false
API_EXTERNAL_URL=http://localhost

...


-############
-# Studio - Configuration for the Dashboard
-############

-STUDIO_DEFAULT_ORGANIZATION=Default Organization
-STUDIO_DEFAULT_PROJECT=Default Project

-STUDIO_PORT=3000
@XIYO XIYO added the documentation Improvements or additions to documentation label May 20, 2024
@cyluss
Copy link
Contributor

cyluss commented May 21, 2024

Self hosting does support Studio but without hosted Supabase features such as project management. What leads you to conclude that the self-hosted version cannot be used with Studio?
image

@XIYO
Copy link
Author

XIYO commented May 21, 2024

In the provided Docker Compose example, I noticed that the studio has no exposed ports. When I force the connection through port 3000, it ultimately redirects to the same screen as the web interface on port 8000, which is specified under kong.

I understood that the studio is a tool for creating and managing multiple instances (with self-hosting not supporting multi-instance management), and kong is a tool for using these instances.

If the studio refers to a web UI, then I have misunderstood its concept. The Docker Compose configuration seems somewhat confusing for first-time users.

The options related to the studio mentioned above intrigue me and prompt experimentation. However, it is not documented that self-hosting does not support the studio (here referring to the multi-instance management functionality). This information can only be inferred from discussions, indicating that the feature's documentation is not clear.

#4907

@cyluss
Copy link
Contributor

cyluss commented May 21, 2024

I understood. Currently one docker-compose.yaml deploys one Supabase instance, not management plane of Supabase.

I guess Self hosting guide can be improved in two ways:

  1. Present deployment diagram: to clarify what resources will reader get after deployment
  2. Clarify the scope of self-hosted dashboard: Self-hosted dashboard is deployed at instance level, which implies the following.
  • User cannot perform deployment tasks using Dashboard
  • Each Supabase instances must be deployed separately

Studio readme does mention point 2, but it is better to notice readers the limitations upfront instead of expecting them to do their own experiments.

@Hallidayo Hallidayo added the good first issue Good for newcomers label May 21, 2024
@encima encima added the self-hosted Issues related to self hosting label May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers self-hosted Issues related to self hosting
Projects
Status: No status
Status: No status
Development

No branches or pull requests

4 participants