Commit Graph
56 Commits
Author SHA1 Message Date
Andrey A. 22e2370b35 docs(self-hosted): add poolers how-to guide (#49303) 2026-08-21 07:10:18 -06:00
Andrey A. 9596b5f3ed docs(self-hosted): add a separate architecture diagram (#48763) 2026-08-11 11:48:22 +02:00
Andrey A. af384e136f chore(self-hosted): update tags in docker guide (#48739) 2026-08-05 14:19:11 +02:00
Andrey A. de5d3cd115 docs(self-hosted): update manual setup instructions (#48692) 2026-08-04 07:02:30 -06:00
Andrey A. 80866c6f22 docs(self-hosted): add updating how-to (#48535) 2026-08-03 17:02:14 +02:00
Andrey A. 6a99952af5 docs(self-hosted): update nav and minor corrections (#48499) 2026-07-31 10:50:46 +02:00
Miranda Limonczenko 0d465e7b5f chore(ui): Remove 'tip' from Admonition (#48419)
Closes FE-3966

## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## Problem

- The admonition uses both 'tip' and 'note', but the visual distinction
has long-ago collapsed.
- 'Note' is used far more frequently than 'tip'
- The two are very similar and it is confusing to know which one to use
when they are visually identical

## Solution

Collapse 'tip' and 'note' into one by removing all places where there is
'tip' and updating all references to 'tip' into 'note'.

**Note:** This PR also resolves new broken links flagged by the E2E docs
checker. It may move to another PR since E2Es keep erroring.

### Specific changes

See below for an AI-generated list of changes:

- **Type system** — removed `'tip'` from `AdmonitionType`, its
`TYPE_TO_VARIANT`/`TYPE_LABEL` entries, and the test case in
[`packages/ui-patterns/src/Admonition/](packages/ui-patterns/src/Admonition/)
- **Remark plugin** —
[remarkAdmonition.ts](apps/docs/lib/mdx/plugins/remarkAdmonition.ts) now
maps mkdocs `tip` → `note`
- **Lint allowlist** — `tip` dropped from `supa-mdx-lint.config.toml`
- **Content migration** — all 109 files with `type="tip"` (across
`apps/docs`, `apps/www`, `apps/studio`) converted to `type="note"`; zero
remaining hits confirmed by repo-wide grep
- **Style guide** — `CONTRIBUTING.md` and `contributing/content.mdx`
updated to describe 4 admonition types instead of 5

### Usage before implementation

See the usage table that points toward 'note' as being dominant across
all apps:

Here's the usage table:

| Location | `note` | `tip` |
|---|---|---|
| apps/docs | ~480 | ~143 |
| apps/studio | 34 | 6 |
| apps/www (blog) | 19 | 3 |
| packages/ui-patterns (tests) | 3 | 1 (parametrized) |
| design-system / ui-library / packages/ui / packages/common | 0–1 (test
fixture only) | 0 |

## Preview links


| App | Page | Search text (Ctrl+F) | Verify |
|---|---|---|---|
| docs |
[/docs/guides/ai-tools/byo-mcp](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai-tools/byo-mcp)
| official MCP TypeScript SDK | callout's aria-label="Note" |
| docs |
[/docs/guides/ai-tools/mcp](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai-tools/mcp)
| MCP server is available at | callout's aria-label="Note" |
| docs |
[/docs/guides/ai/python-clients](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/ai/python-clients)
| Click Connect at the top of any project page | callout's
aria-label="Note" |
| docs |
[/docs/guides/auth/audit-logs](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/auth/audit-logs)
| Disabling Postgres storage reduces your database storage costs |
callout's aria-label="Note" |
| docs |
[/docs/guides/database/tables](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/database/tables)
| access a custom schema through the Supabase Data API | callout's
aria-label="Note" |
| docs |
[/docs/guides/troubleshooting/edge-function-404-error-response](https://docs-git-admonition-collapse-note-tip-supabase.vercel.app/docs/guides/troubleshooting/edge-function-404-error-response)
| Always configure an appropriate time frame | callout's
aria-label="Note" (was single-quoted type='tip') |
| www | [blog:
cli-v2-config-as-code](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/cli-v2-config-as-code)
| Detecting config drift | callout's aria-label="Note" |
| www | [blog:
cli-v2-config-as-code](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/cli-v2-config-as-code)
| Setting Edge Function secrets | callout's aria-label="Note" |
| www | [blog:
nosql-mongodb-compatibility-with-ferretdb-and-flydotio](https://zone-www-dot-com-git-admonition-collapse-note-tip-supabase.vercel.app/blog/nosql-mongodb-compatibility-with-ferretdb-and-flydotio)
| If your network supports IPv6 connections | callout's
aria-label="Note" |

Note: the `www` rows use the `zone-www-dot-com` preview host, not the
`docs` one you gave — since blog pages are served from the www app, not
docs.


## Manual testing

1. Open preview links for affected pages.
2. Inspect. Open console.
3. Paste the following in and see there is no 'Tip' on the page:
```
document.querySelectorAll('[role="alert"]').forEach(el => console.log(el.getAttribute('aria-label'), el.textContent.slice(0,60)))
```



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

* **Documentation**
* Standardized informational callouts across docs and tutorials from
**“Tip”** to **“Note”**, updating multiple examples and guidance blocks.
* Updated a few related doc references/links and conditional “Next
steps” content.
* **UI Updates**
* Switched various in-app banners and notices to the **“Note”** style
variant.
* **Bug Fixes / Improvements**
* Removed support for the retired **“Tip”** callout type and aligned
docs linting, component behavior, and aria labeling to the remaining
admonition types.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-07-29 09:26:50 -07:00
Andrey A. e007cc37c3 docs(self-hosted): standardize on run.sh in how-to guides (#47811) 2026-07-10 14:35:59 +02:00
Andrey A. e7abda8dce fix(self-hosted): change default api external url to contain /auth/v1 (#47640) 2026-07-07 12:28:47 +02:00
Mandar Joshi 02ada3efe3 fix(docker): move hardcoded Realtime DB_ENC_KEY to .env variable (#46021) 2026-07-01 14:51:02 +02:00
3dffdefd6e fix(docs) Resolve 196 mdx lint warnings for just, quickly, actually, PostgreSQL (#47358)
Closes DOCS-1057
Contributes to DOCS-1052

## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## Problem

We have hundreds of MDX lint warnings in our docs going against style
best practices.

## Solution

Remove and replace in context the following:

- PostgreSQL. There was only one. There was concern about exceptions,
but I found none.
- Just
- Quickly
- Actually

### What changed

Edits follow the [Google developer documentation style
guide](https://developers.google.com/style): concise, direct, active
voice. The flagged words were removed when the sentence still read well,
or replaced when meaning needed to be preserved.

### Common patterns

| Flagged word | Approach | Example |
|---|---|---|
| **just** (filler) | Removed | "you just installed" → "you installed" |
| **just** (limiting) | **only** | "just one row" → "only one row" |
| **just like** | **like** / **the same as** | "function just like
regular users" → "function like regular users" |
| **not just** | **not only** | "not just errors" → "not only errors" |
| **quickly** (performance) | **efficiently** or removed | "find rows
quickly" → "find rows efficiently" |
| **quickly** (time) | **soon** / **rapidly** / removed | "expires too
quickly" → "expires too soon" |
| **actually** (filler) | Removed | "actually execute" → "execute"; "is
actually the most common" → "is the most common" |

## Tophatting

1. See the diff.
2. See that content continues to make sense in context.
3. Locally, `cd apps/docs` and run `pnpm run lint:mdx`.
4. Search for "just," "actually," "quickly", and "PostgreSQL" and see
there are 0 warnings.




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

* **Documentation**
* Updated wording across quickstarts, guides, and troubleshooting
articles for grammar, clarity, and consistent step-by-step phrasing.
* Clarified key concepts including Row Level Security policy evaluation
across Supabase products, deferred foreign key constraint behavior, and
when `EXPLAIN ANALYZE` executes queries (and related side effects).
* Refined several troubleshooting instructions and added guidance to cap
log payload size to reduce billed Logs Ingest volume.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Nik Richers <nrichers@gmail.com>
Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
2026-06-29 09:40:25 -07:00
Andrey A. 7480bff76c docs(self-hosted): add quick start and describe setup and management scripts (#46416) 2026-06-03 10:46:50 +02:00
fadymak 287af52198 docs(self-hosting): remove legacy key generation from docker guide (#45359) 2026-05-26 17:17:28 +02:00
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. b4a6897b1b chore(self-hosted): update proxy configs for envoy (#45229) 2026-04-27 15:22:02 +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. fe08059cb7 chore(self-hosted): remove backticks in headers in self-hosted how-to (#44184) 2026-03-26 08:54:46 +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
Jeremias Menichelli f6ec43a9ed [DOCS-454] fix(Docs): Fix images from causing CLS on pages (#43026) 2026-02-23 19:02:31 +01:00
Andrey A. e43e7fff4e add s3 configuration how-to for self-hosted 2026-02-18 14:15:42 +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. 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
Charis 2d55512553 chore: activate spelling and admonitions lints for docs (#33292) 2025-02-04 13:18:31 -05:00
Ibnu RasikhandCharis 1969be0908 Add Supabase AI Assistant documentation to the Self-Hosting with Docker section (#31243)
* Add Supabase AI Assistant Docs in Self Hosting with Docker Docs

Add Supabase AI Assistant Docs in Self Hosting with Docker Docs

* fix: minor text edit

* fix: lint error

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-01-07 20:39:01 +00:00
Charis d69902da94 chore(docs): lint all sections with linter v2 (#31110)
lint(docs): heading capitalization
2024-12-16 14:33:25 -05:00
Terry SuttonandCharis 4bbb9fa9ca Chore/update self host guide (#30167)
* Update self-host guide

* Undo changes

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

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

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

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

* Some changes to make benefit prettier

* Vale fixes

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-10-30 16:53:42 +00:00
Tyler b319ea91a4 docs: Update auth self-host docs to the latest info (#29994)
* docs: Update auth self-host docs to the latest info

* update description of URI_ALLOW_LIST

* update the variable name

* Add more description about how to configure auth on self-hosted environment

* minor styling fix
2024-10-21 21:14:46 +09:00
Andrew Valleteau 7feff8f45c fix(docs): self hosting db connection update (#29948)
* fix(docs): update self-hosting docs

Follow up: https://github.com/supabase/supabase/pull/29596

* chore: add env configurable tenant id
2024-10-17 16:34:24 +02:00
Andrew Valleteau 4bad8499ae feat: introduce _supabase database add supavisor to self-hosted (#29596)
* chore: move _analytics to a distinct database

Following: https://github.com/supabase/cli/pull/2707

BREAKING CHANGES:
When migrating from an older version you will need to manually create the new internal _supabase
database and analytics schema the same way the  and  do.
Via:

* feat: add supavisor to the self-hosted stack

* chore(docs): add docs about supavisor

* chore: fix reviewdog warning

* chore: fix typo

* chore: apply pr comments
2024-10-08 13:49:09 +02:00
lollipopkit🏳️‍⚧️andHan Qiao da21986a5d doc: rootless docker (#27515)
* doc: rootless docker

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

---------

Co-authored-by: Han Qiao <sweatybridge@gmail.com>
2024-07-02 04:13:58 +00:00