Commit Graph
64 Commits
Author SHA1 Message Date
Danny WhiteandChris Chinchilla 9c03ad6b02 chore(docs): migrate Admonition labels to titles (#46053)
## What kind of change does this PR introduce?

Docs update. Related to DEPR-551.

## What is the current behavior?

Docs MDX still uses the legacy `label` prop for Admonitions, even though
#45618 added `title` and kept `label` only as a backwards-compatible
alias after #45302 was reverted in #45535.

## What is the new behavior?

Migrates Docs-owned Admonitions from `label=` to `title=` without
changing rendered copy, component APIs, Studio callsites, design-system
examples, or the legacy `label` alias.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Standardized admonition headings across the docs by switching how
admonition headings are provided (preserving all visible guidance and
examples). Content and instructions remain unchanged; this ensures
consistent rendering of callouts and improves uniformity across guides
and reference pages.

<!-- review_stack_entry_start -->

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/46053?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)

<!-- review_stack_entry_end -->
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-05-18 19:00:09 +10:00
dd512e912a fix(self-hosted): prevent Kong startup failures from CRLF line endings (#44422)
## What changed
- added `docker/volumes/.gitattributes` with `* text=auto eol=lf` to
enforce LF line endings for Docker-mounted volume files
- added a Windows troubleshooting warning to the self-hosting Docker
guide for Kong startup failures caused by CRLF line endings

## Why
Issue #44052 reports `supabase-kong` failing with `exec
/home/kong/kong-entrypoint.sh: no such file or directory`.
A common cause is CRLF conversion on Windows for mounted shell scripts.
Enforcing LF in `docker/volumes` prevents this class of failure for
fresh checkouts/copies.

## Validation
- `git check-attr text eol -- docker/volumes/api/kong-entrypoint.sh
docker/volumes/db/roles.sql docker/volumes/logs/vector.yml`
- `pnpm exec prettier --check
apps/docs/content/guides/self-hosting/docker.mdx`
- attempted `pnpm --prefix apps/docs run lint:mdx` (failed locally due
missing `node-pty` native module in this environment)

Closes #44052


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Added warning about Windows CRLF line ending issues with Docker
mounted scripts and resolution steps.

* **Chores**
* Added line ending configuration to enforce LF format in Docker
volumes.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2026-05-15 10:29:04 +02:00
Andrey A. 980c1bc3cb chore(self-hosted): update prerequisites and example in docs (#45948) 2026-05-15 08:37:20 +01:00
Andrey A. 72525c66de chore(self-hosted): standardize on override vs overlay for compose in docs and configs (#45627) 2026-05-06 13:40:26 +02:00
Luiz Felipe Machado 5fa012cfa9 docs(self-hosted): clarify envoy api gateway setup (#45238) 2026-04-29 09:33:53 +00:00
Chris Chinchilla a96d3d2b21 docs: API landing pages overhaul (#45062) 2026-04-28 14:13:48 +02:00
Andrey A. b4a6897b1b chore(self-hosted): update proxy configs for envoy (#45229) 2026-04-27 15:22:02 +02:00
Andrey A. f235fe87f7 chore(self-hosted): add how-to guide for envoy api gateway (#45152) 2026-04-24 12:13:07 +00:00
Inder Singh cc4d985c40 feat(docker): remove superuser access (#42975) 2026-04-22 11:24:58 +02:00
Andrey A. 5181be6005 chore(self-hosted): update how-to guides to match current configs (#45011) 2026-04-20 15:25:06 +02:00
Taryn King 65c6929414 chore(docs): update docs to use postgres over postgresql language (#44881)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Updates verbiage throughout docs to use postgres over postgresql.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated terminology throughout documentation, guides, and resources
for consistent product naming across all user-facing materials,
including page titles, descriptions, and reference documentation.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-15 09:49:45 +00:00
Andrey A. d7a9ded4b0 add pg17 upgrade configuration for self-hosted supabase (#44147) 2026-04-07 16:44:03 +02:00
Luiz Felipe Machado 792c26aadf docs(self-hosting): fix SSO endpoint path in SAML login flow example (#44491) 2026-04-02 13:46:55 +00:00
Luiz Felipe Machado f128106801 feat(self-hosting): add SAML SSO env config and open Kong routes (#43385) 2026-04-01 15:42:36 +02:00
Luiz Felipe Machado ae6d4330d0 docs(self-hosting): add SAML 2.0 SSO configuration guide (#43386) 2026-04-01 08:08:15 +02:00
Inder Singh 2fd49395b8 docs(self-hosted): session token usage with s3 client (#43394) 2026-03-27 11:48:16 +01:00
Inder Singh 1f733dc1d4 docs(self-host): custom email templates (#42832) 2026-03-26 09:21:16 +01:00
Andrey A. fe08059cb7 chore(self-hosted): remove backticks in headers in self-hosted how-to (#44184) 2026-03-26 08:54:46 +01:00
Andrey A. 6ea650f999 fix: revise and update proxy how-to (#43853) 2026-03-17 11:32:42 +01:00
Ivan VasilovandJoshen Lim 9fa96977be chore: Minor prettier fixes (#43849)
This PR fixes some prettier issues:
- Bump and unify all prettier versions to 3.7.3 across teh whole repo
- Bump the SQL prettier plugin
- When running `test:prettier`, check `mdx` files also
- Run the new prettier format on all files

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2026-03-17 11:17:42 +01:00
Andrey A. 65d874291d add a new how-to describing new api keys 2026-03-16 12:00:43 +01:00
Danny WhiteandJoshen Lim 503c01b5bc chore(studio): refactor oauth apps page and table (#43366)
## What kind of change does this PR introduce?

UI update.

## What is the current behavior?

The org’s /apps page is glaringly out of date compared to similar pages.
It uses old page and layout components.

## What is the new behavior?

- Refactored /apps to use latest
[layout](https://supabase.com/design-system/docs/ui-patterns/layout) and
[table](https://supabase.com/design-system/docs/components/table)
components

Unrelated minor changes snuck in:

- Global `pnpm format` to properly format recurring annoyances elsewhere
- Minor polish on org tiles (pictured)

| Before | After |
| --- | --- |
| <img width="1728" height="997" alt="OAuth Apps
Supabase-30B6CDAE-4954-40F8-886A-939797999AA6"
src="https://github.com/user-attachments/assets/163c2787-f6ab-4a0b-80aa-af81260bdf9f"
/> | <img width="1728" height="997" alt="OAuth Apps
Supabase-7DD241E0-262A-4817-91B2-D2A299F8EB93"
src="https://github.com/user-attachments/assets/29928305-9110-4256-8663-c3821e696587"
/> |
| <img width="1728" height="997" alt="OAuth Apps
Supabase-9870816A-8022-479D-8011-236A813249AB"
src="https://github.com/user-attachments/assets/32e41835-59bc-4d83-92eb-635b98c5f4a5"
/> | <img width="1728" height="997" alt="OAuth Apps
Supabase-21CFBC16-E850-44A6-BEFF-C4FBED8ACB43"
src="https://github.com/user-attachments/assets/6999e2a0-ea17-44cb-99f2-42f985354589"
/> |
| <img width="1152" height="664"
alt="Supabase-9DD87028-2D46-47D0-8546-240184E1711B"
src="https://github.com/user-attachments/assets/2c7d8b2a-280f-48d6-9f78-19c519cf4654"
/> | <img width="1152" height="664"
alt="Supabase-F1C92F66-C602-4DC9-B3B4-AE3FB673276E"
src="https://github.com/user-attachments/assets/0a24a98e-386f-4ada-b282-0a59b159bbab"
/> |

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2026-03-06 12:23:33 +11:00
Andrey A. 2fcf513ab6 fix: reformat yaml and clarify testing in self-hosted oauth how-to 2026-03-04 11:17:03 +01:00
Andrey A.andChris Chinchilla 001faf98b6 docs: add https proxy how-to for self-hosted (#43293)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

- Add a new how-to guide covering PR #43291
- Explain how to use an https proxy on top of [self-hosted
Supabase](https://supabase.com/docs/guides/self-hosting) API gateway
(Kong)

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-03-03 17:09:46 +00:00
28808d2c9f docs: add oauth and otp how-to guides for self-hosted (#43286)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

- Add two new how-to guides covering OAuth and OTP/MFA configuration for
[self-hosted Supabase](https://supabase.com/docs/guides/self-hosting)
- Add placeholder environment variables to `.env.example` and
`docker-compose.yml`

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-03-03 17:33:20 +01:00
Andrey A. aa1aa73200 update .env.example with better comments 2026-02-25 21:44:45 +01:00
Andrey A. b5cb4548b6 add a how-to for self-hosted edge functions 2026-02-25 21:44:19 +01:00
Jeremias Menichelli f6ec43a9ed [DOCS-454] fix(Docs): Fix images from causing CLS on pages (#43026) 2026-02-23 19:02:31 +01:00
Prashant Sridharan 52e2bf6325 Added a new agency webinar (#43000)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Added a new webinar event
Speakers are both already in the system
2026-02-18 19:58:20 +00:00
Andrey A. e43e7fff4e add s3 configuration how-to for self-hosted 2026-02-18 14:15:42 +01:00
kemal.earth 48e4140202 chore(studio): remove [edge] label from logs search suggestions (#42944)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

This removes the label `[edge]` from the suggested list of log types in
the new logging interface. 🤞 this doesn't break anywhere else.

| Before | After |
|--------|--------|
| <img width="966" height="260" alt="image (1)"
src="https://github.com/user-attachments/assets/24fb996e-8bed-4d48-81f2-a3942c58ba1f"
/> | <img width="380" height="39" alt="Screenshot 2026-02-17 at 12 55
58"
src="https://github.com/user-attachments/assets/595a28be-bb27-4797-b82d-b3c4e32adb3d"
/> |
2026-02-18 10:35:14 +00:00
Andrey A. 26a42537d2 chore: rename configuration to how-to guides
https://github.com/supabase/supabase/blob/master/docker/docker-compose.s3.yml
2026-02-17 13:33:23 +01:00
Andrey A. 0312cc56ce add restore from platform to self-hosted how-to 2026-02-17 10:38:57 +01:00
Andrey A. 2b625b04f2 fix: add minio password generator and amend docs 2026-02-16 14:12:03 +00:00
Andrey A. ff1c78eee4 fix: add a note about special chars in dashboard password 2026-01-26 18:20:58 +11:00
Andrey A. 486dfccf60 fix: restructure overview and add quick setup (#41438) 2025-12-19 12:48:07 +01:00
Andrey A. 25fdff20c9 chore: add support, gotrue => auth, minor fixes, remove obscure analytics section (#41347) 2025-12-16 11:14:15 -03:30
Andrey A.andChris Chinchilla a90890ad52 fix(docs): multiple edits and enhancements for self-hosted docker guide (#40901)
* fix(docs): multiple edits and enhancements

* fix: edited to remove typos and align with the linter

* fix: remove more typos and a bit more linter compliance

* fix: correct minor typos

* chore: add linter exclusion

* fix: exclude lint check for imgproxy

* fix: move disable lint to separate lines

* chore: make prettier happy

* chore: typos plus add linux docker desktop

* chore: fix typos and add link to postgres password guidelines

* chore: stress postgres password recommendation

* fix: use relative paths for docs references

* chore: add a note about all digits in dashboard password

* chore: add a note about no-telemetry and design partnerships if enterprise

* chore: initial import of a simpler jwt generator component

* fix: grammar, some sections reorg, use simpler generator

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-12-12 10:20:24 +01:00
omahs 96fb9fb99d docs: Fix typos (#40906) 2025-12-01 12:19:35 +00:00
Andrey A. 911d646bcb docs: add a new section about mcp in self-hosted (#39952)
* docs: add a new section about mcp in self-hosted
2025-10-30 09:34:04 +01:00
Andrey A. 7d743d4fb3 docs: add a note about secret_key_base to self-hosting with docker (#39460) 2025-10-16 15:43:32 +02:00
Matt Rossman 31b6368049 feat: read-only mode for self-hosted MCP (#39041)
* feat: add `crypto-js`, `encryptString` with sample key

* feat: include POSTGRES_PASSWORD in generated .env.test

* feat: include POSTGRES_PASSWORD in turbo.json for studio

* feat: read only query support

* feat: configurable `POSTGRES_HOST`, `POSTGRES_DB`, `POSTGRES_PORT`

* chore: rename POSTGRES_USER to clarify write permission

* feat: configurable `PG_META_CRYPTO_KEY`

* chore: add `PG_META_CRYPTO_KEY` to generateLocalEnv

* feat: add 'postgres-meta' to linter dictionary

* feat: restore read-only toggle in local MCP URL builder
2025-10-06 16:14:27 -04:00
CharisandChris Chinchilla 47705a8968 chore: replace all supabase urls with relative urls (#38537)
* fix: rewrite relative URLs when syncing to GitHub discussion

Relative URLs back to supabse.com won't work in GitHub discussions, so
rewrite them back to absolute URLs starting with https://supabase.com

* fix: replace all supabase urls with relative urls

* chore: add linting for relative urls

* chore: bump linter version

* Prettier

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2025-09-09 12:54:33 +00:00
Charis 0e28054772 docs(self-hosted env): fix odd format for example .env file (#36120) 2025-06-02 17:50:48 -04:00
JasperandCharis 0c4c874a6a update: improve docker self hosting documentation (#27974)
* update: improve docker self hosting documentation

* fix: self hosting docs consistencies

* update: jwt generator according to official documentation

* Apply grammer improvements from code review

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* conform to prettier formatting

* Update apps/docs/content/guides/self-hosting/docker.mdx

* Update apps/docs/components/JwtGenerator/JwtGenerator.tsx

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-04-15 23:51:14 +00:00
8ca8cb43fd Added functions dashboard quickstart page, about deno 2 guide, and deno 2 test guide (#34599)
* Added functions dashboard quickstart page, about deno 2 guide, and deno 2 test guide

* fix: updated image sizes, and trimmed some images and text

* fix: removed line about assistant edits and made some minor polish fixes

* updated docs

* Apply suggestions from code review

* remove duplication

---------

Co-authored-by: Greg Papas <gregpapas@gregs-mbp.mynetworksettings.com>
Co-authored-by: Lakshan Perera <lakshan@laktek.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-04-01 13:59:17 +00:00
Charis 311232b3e1 feat(docs): ts hover annotations on code blocks (#34327) 2025-03-21 15:48:32 -04:00
Pidanou Eang 484805c878 docs: edit self-host guide (#32695)
- Added information to make the studio work outside of localhost. This information is only given inside .env.example
2025-03-01 00:47:09 +00:00
Charis a820c56ed0 chore: docs linting (#33574) 2025-02-21 14:13:00 -05:00
df9f410c50 docs(billing): complete rewrite
* deleted all old pages except from FAQs
* added pricing section to feature docs pages
* adjusted all links to new pages (on Dashboard, in docs, on Pricing page)
* configured redirects from old billing docs pages to new pages
---------
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>
2025-02-12 21:05:18 +01:00