Skip to content

Commit 43c0c25

Browse files
filipecabacocharislamw3b6x9
authored
realtime: improve protocol docs; move settings to a guides (supabase#37280)
* realtime: improve protocol docs; move settings to a guides * fix GH action feedback * Update apps/docs/content/guides/realtime/protocol.mdx Co-authored-by: Charis <[email protected]> * Update apps/docs/content/guides/realtime/protocol.mdx Co-authored-by: Charis <[email protected]> * fix image and protocol --------- Co-authored-by: Charis <[email protected]> Co-authored-by: Wen Bo Xie <[email protected]>
1 parent 6cbb409 commit 43c0c25

File tree

10 files changed

+281
-137
lines changed

10 files changed

+281
-137
lines changed

apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1586,6 +1586,7 @@ export const realtime: NavMenuConstant = {
15861586
name: 'Postgres Changes',
15871587
url: '/guides/realtime/postgres-changes',
15881588
},
1589+
{ name: 'Settings', url: '/guides/realtime/settings' },
15891590
],
15901591
},
15911592
{
@@ -1622,7 +1623,7 @@ export const realtime: NavMenuConstant = {
16221623
{ name: 'Quotas', url: '/guides/realtime/quotas' },
16231624
{ name: 'Pricing', url: '/guides/realtime/pricing' },
16241625
{ name: 'Architecture', url: '/guides/realtime/architecture' },
1625-
{ name: 'Message Protocol', url: '/guides/realtime/protocol', items: [] },
1626+
{ name: 'Protocol', url: '/guides/realtime/protocol', items: [] },
16261627
{ name: 'Benchmarks', url: '/guides/realtime/benchmarks' },
16271628
],
16281629
},

apps/docs/content/guides/realtime/architecture.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@ Realtime is a globally distributed Elixir cluster. Clients can connect to any no
99

1010
Realtime is written in [Elixir](https://elixir-lang.org/), which compiles to [Erlang](https://www.erlang.org/), and utilizes many tools the [Phoenix Framework](https://www.phoenixframework.org/) provides out of the box.
1111

12-
![Global Architecture](/docs/img/guides/realtime/realtime-arch.png)
12+
<Image
13+
alt="Architecture"
14+
src={{
15+
light: '/docs/img/guides/platform/realtime/architecture--light.png',
16+
dark: '/docs/img/guides/platform/realtime/architecture--dark.png',
17+
}}
18+
/>
1319

1420
## Elixir & Phoenix
1521

apps/docs/content/guides/realtime/concepts.mdx

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -107,32 +107,6 @@ Anyone with access to a valid JWT signed with the project's JWT secret is able t
107107

108108
Clients can choose to receive `INSERT`, `UPDATE`, `DELETE`, or `*` (all) changes for all changes in a schema, a table in a schema, or a column's value in a table. Your clients should only listen to tables in the `public` schema and you must first enable the tables you want your clients to listen to.
109109

110-
## Settings
111-
112-
<Admonition type="note">
113-
114-
Realtime settings are currently under Feature Preview section in the dashboard.
115-
116-
</Admonition>
117-
118-
<Image
119-
alt="Usage page navigation bar"
120-
src={{
121-
light: '/docs/img/guides/platform/realtime-settings--light.png',
122-
dark: '/docs/img/guides/platform/realtime-settings--dark.png',
123-
}}
124-
zoomable
125-
/>
126-
127-
You can set the following settings using the Realtime Settings screen in your Dashboard:
128-
129-
- Channel Restrictions: You can toggle this settings to set Realtime to allow public channels or set it to use only private channels with [Realtime Authorization](/docs/content/guides/realtime/authorization).
130-
- Database connection pool size: Determines the number of connections used for Realtime Authorization RLS checking
131-
{/* supa-mdx-lint-disable-next-line Rule004ExcludeWords */}
132-
- Max concurrent clients: Determines the maximum number of clients that can be connected
133-
134-
All changes made in this screen will disconnect all your connected clients to ensure Realtime starts with the appropriate settings and all changes are stored in Supabase middleware.
135-
136110
## Choosing between Broadcast and Postgres Changes for database changes
137111

138112
We recommend using Broadcast by default and using Broadcast from Database specifically as it will allow you to scale your application compared to Postgres Changes.

0 commit comments

Comments
 (0)