docs: self-hosting guide v1 (#481)

* feat: selfhosting guide v1 #238

* use public env on frontend

* add docker desclaimer
This commit is contained in:
Rotimi Best
2024-09-30 01:20:19 +01:00
committed by GitHub
parent 47823dbf9c
commit 91bd9d4414
8 changed files with 148 additions and 13 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

@@ -6,6 +6,7 @@ import DBPushResult from './images/db-push-result.webp';
import AuthSettings from './images/auth-settings.webp';
import MatchEnvVariables from './images/match-env.webp';
import NewProject from './images/new-project.webp';
import SmtpSettings from './images/smtp-settings.webp';
# Supabase Cloud Setup
@@ -88,10 +89,29 @@ pnpm supabase db push --db-url "URL HERE"
### Configure Auth in your Supabase project
Here we will update our email configurations, to prevent supabase from sending confirmation emails on signup. This is because we don't have email confirmation setup on ClassroomIO, this feature will come later. If you don't disable it, you won't be able to signup into the application.
Here we will update our email configurations, to prevent supabase from sending confirmation emails on signup. This is because we don't use Supabase for email verification, we handle that internally due to the quality of the email.
<Image src={AuthSettings} alt="Authentication configuration" quality="100" />
### Configure SMTP
Supabase [now requires adding custom SMTP](https://github.com/orgs/supabase/discussions/29370) to your supabase project in order to avoid abuse of their system. Without adding a custom SMTP, your signup requests to your supabase project will fail. To avoid this, you should go to the [STMP section](https://supabase.com/dashboard/project/_/settings/auth) of your supabase settings.
Make sure to toggle **Enable Custom SMTP** and fill in the following fields:
- Sender email
- Sender name
- SMTP host
- SMTP port
- SMTP username
- SMTP password
<Image src={SmtpSettings} alt="SMTP Settings" quality="100" />
<Callout type="info" emoji="ℹ️">
Learn more about setting up SMTP [here](https://supabase.com/docs/guides/auth/auth-smtp)
</Callout>
### Add configurations to your environment variables
Now with all these set up you need to get update the .env file in `apps/dashboard`. You need to update the following environment variables: