Skip to content

Commit 91e3e4a

Browse files
committed
add some concept and pgsql docs
1 parent 693cfa8 commit 91e3e4a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+4661
-3152
lines changed

content/docs/app/supabase.md

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,44 @@ Pigsty can help you deploy enterprise-grade Supabase on your own servers (physic
1111

1212
> Pigsty is one of three self-hosting approaches listed on the Supabase official documentation: [Self-hosting: Third-Party Guides](https://supabase.com/docs/guides/self-hosting#third-party-guides)
1313
14+
This tutorial requires basic Linux knowledge. Otherwise, consider using Supabase cloud or plain Docker Compose self-hosting.
15+
1416

1517
--------
1618

1719
## TL;DR
1820

19-
[Prepare](/docs/deploy/prepare) a [**Linux**](/docs/deploy/prepare) server, follow the Pigsty [standard installation](/docs/setup/install) process with the `supabase` configuration template:
21+
[Prepare](/docs/deploy/prepare) a [**Linux server**](/docs/deploy/prepare), follow the Pigsty [**standard single-node installation**](/docs/setup/install) process with the `supabase` config template:
2022

2123
```bash
22-
curl -fsSL https://repo.pigsty.cc/get | bash; cd ~/pigsty
24+
curl -fsSL https://repo.pigsty.io/get | bash; cd ~/pigsty
2325
./configure -c supabase # Use supabase config (change credentials in pigsty.yml)
2426
vi pigsty.yml # Edit domain, passwords, keys...
25-
./deploy.yml # Install Pigsty
26-
./docker.yml # Install Docker Compose components
27-
./app.yml # Start Supabase stateless components with Docker (may take time)
27+
./deploy.yml # Standard single-node Pigsty deployment
28+
./docker.yml # Install Docker module
29+
./app.yml # Start Supabase stateless components (may be slow)
2830
```
2931

3032
After installation, access Supa Studio on port `8000` with username `supabase` and password `pigsty`.
3133

32-
![](/img/docs/supabase-login.png)
34+
![](/img/pigsty/supabase.webp)
3335

3436
{{< asciinema file="demo/supabase.cast" markers="0:Check,11:Install,43:Config,307:Docker,321:Domain,340:App,350:Verify" theme="solarized-light" speed="1.3" autoplay="true" loop="true" >}}
3537

3638

3739

40+
--------
41+
42+
## Checklist
43+
44+
- [ ] At least one 1C2G server
45+
- [ ] Static internal IPv4 address
46+
- [ ] [**Supported Linux distro**](/docs/ref/linux) installed
47+
- [ ] [**Standard Pigsty installation**](/docs/setup/install)
48+
- [ ] Modified config file: domain, passwords, IP address
49+
- [ ] [**Docker module installed**](/docs/docker), ensure proxy/mirror available
50+
- [ ] Use Pigsty's [`app.yml`](/docs/docker/playbook) to start Supabase
51+
3852

3953
------
4054

@@ -112,11 +126,11 @@ Let's start with single-node Supabase deployment. We'll cover multi-node high av
112126
then run [`docker.yml`](/docs/docker/playbook#dockeryml) and `app.yml` to start stateless Supabase containers (default ports `8000`/`8433`).
113127

114128
```bash
115-
curl -fsSL https://repo.pigsty.cc/get | bash; cd ~/pigsty
129+
curl -fsSL https://repo.pigsty.io/get | bash; cd ~/pigsty
116130
./configure -c supabase # Use supabase config (change credentials in pigsty.yml)
117131
vi pigsty.yml # Edit domain, passwords, keys...
118132
./deploy.yml # Install Pigsty
119-
./docker.yml # Install Docker Compose components
133+
./docker.yml # Install Docker module
120134
./app.yml # Start Supabase stateless components with Docker
121135
```
122136

@@ -184,12 +198,14 @@ These are Pigsty component passwords. Strongly recommended to set before install
184198

185199
Besides Pigsty component passwords, you need to [change Supabase keys](https://supabase.com/docs/guides/self-hosting/docker#securing-your-services), including:
186200

187-
- [`JWT_SECRET`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#131)
188-
- [`ANON_KEY`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L132)
189-
- [`SERVICE_ROLE_KEY`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L133)
190-
- [`PG_META_CRYPTO_KEY`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L134)
191-
- [`DASHBOARD_USERNAME`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L136): Supabase Studio web UI default username, default `supabase`
192-
- [`DASHBOARD_PASSWORD`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L137): Supabase Studio web UI default password, default `pigsty`
201+
- [`JWT_SECRET`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L135): JWT signing key, at least 32 characters
202+
- [`ANON_KEY`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L136): Anonymous user JWT credential
203+
- [`SERVICE_ROLE_KEY`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L137): Service role JWT credential
204+
- [`PG_META_CRYPTO_KEY`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L138): PostgreSQL Meta service encryption key, at least 32 characters
205+
- [`DASHBOARD_USERNAME`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L140): Supabase Studio web UI default username, default `supabase`
206+
- [`DASHBOARD_PASSWORD`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L141): Supabase Studio web UI default password, default `pigsty`
207+
- [`LOGFLARE_PUBLIC_ACCESS_TOKEN`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L144): Logflare public access token, 32-64 random characters
208+
- [`LOGFLARE_PRIVATE_ACCESS_TOKEN`](https://github.com/pgsty/pigsty/blob/main/conf/supabase.yml#L145): Logflare private access token, 32-64 random characters
193209

194210
Please follow the [Supabase tutorial: Securing your services](https://supabase.com/docs/guides/self-hosting/docker#generate-api-keys):
195211

0 commit comments

Comments
 (0)