The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
docs: convert self-hosting overview to ContentListings and restructure the page (#47469)
Nik Richers6418820b0be0
diff --git a/apps/docs/components/ContentListings/ContentListings.client.tsx b/apps/docs/components/ContentListings/ContentListings.client.tsxindex 323478ca22e..3d36bc1ef50 100644--- a/apps/docs/components/ContentListings/ContentListings.client.tsx+++ b/apps/docs/components/ContentListings/ContentListings.client.tsx@@ -9,6 +9,7 @@ import {import { useSendTelemetryEvent } from '~/lib/telemetry'import Link from 'next/link'import { useCallback } from 'react'+import { Badge } from 'ui'import { GlassPanel } from 'ui-patterns/GlassPanel'import { Heading } from 'ui/src/components/CustomHTMLElements'@@ -77,7 +78,8 @@ function ContentListingsGroup({ group }: { group: ContentListingGroup }) {<GlassPaneltitle={item.title}icon={item.icon}- hasLightIcon={Boolean(item.icon)}+ hasLightIcon={item.hasLightIcon ?? true}+ badge={item.badge ? <Badge variant="success">{item.badge}</Badge> : undefined}>{item.description}</GlassPanel>diff --git a/apps/docs/content/guides/self-hosting.mdx b/apps/docs/content/guides/self-hosting.mdxindex f5923055c7b..7858060697c 100644--- a/apps/docs/content/guides/self-hosting.mdx+++ b/apps/docs/content/guides/self-hosting.mdx@@ -5,53 +5,6 @@ subtitle: 'Install and run your own Supabase on your computer, server, or cloudhideToc: true----## Get started--The fastest and recommended way to self-host Supabase is to use Docker.--<div className="grid md:grid-cols-12 gap-4 not-prose">- <div className="md:col-span-6 xl:col-span-4 relative" key="/guides/self-hosting/docker">- <Link href="/guides/self-hosting/docker" passHref>- <GlassPanel icon={'/docs/img/icons/docker'} hasLightIcon={true}- title={- <span className="flex items-center gap-2">- Docker- <Badge variant="success">Official</Badge>- </span>- }- showIconBg={true}- >- Deploy Supabase within your own infrastructure using Docker Compose.- </GlassPanel>- </Link>-- </div>-</div>--## Community-driven projects--{/* supa-mdx-lint-disable-next-line Rule004ExcludeWords */}-There are several other options to deploy Supabase. If you're interested in helping these projects, visit our [Community](/contribute) page.--<div className="grid md:grid-cols-12 gap-4 not-prose">- <div className="md:col-span-6 xl:col-span-3">- <Link href="https://github.com/supabase-community/supabase-kubernetes" passHref>- <GlassPanel title={<span className="flex items-center gap-2">Kubernetes</span>}>- Helm charts to deploy a Supabase on Kubernetes.- </GlassPanel>- </Link>- </div>- <div className="md:col-span-6 xl:col-span-3">- <Link href="https://github.com/supabase-community/supabase-traefik" passHref>- <GlassPanel title={<span className="flex items-center gap-2">Traefik</span>}>- A self-hosted Supabase setup with Traefik as a reverse proxy.- </GlassPanel>- </Link>- </div>-</div>--## About self-hosting-Self-hosting is a good fit if you need full control over your data, have compliance requirements that prevent you from using managed services, or want to run Supabase in an isolated environment.### How self-hosted Supabase differs@@ -81,24 +34,19 @@ Self-hosted Supabase (run via Docker Compose) **does not phone home or collect aThe **Supabase CLI** is a [separate tool](/docs/guides/local-development/cli/getting-started) and collects usage telemetry to help improve the developer experience. See [CLI telemetry](/docs/guides/local-development/cli/getting-started#telemetry) for opt-out methods.-## Support and community--Self-hosted Supabase is community-supported.+<ContentListings id="self-hosting-get-started" />-For resolving common issues:+<ContentListings id="self-hosting-community" />-- [GitHub Discussions](https://github.com/orgs/supabase/discussions?discussions_q=is%3Aopen+label%3Aself-hosted) - Questions, feature requests, and workarounds-- [GitHub Issues](https://github.com/supabase/supabase/issues?q=is%3Aissue%20state%3Aopen%20label%3Aself-hosted) - Known issues+## Support and community-Get help and connect with other users:+Self-hosted Supabase is community-supported.-- [Discord](https://discord.supabase.com) - Real-time chat and community support- {/* supa-mdx-lint-disable-next-line Rule003Spelling */}-- [Reddit](https://www.reddit.com/r/Supabase/) - Official Supabase subreddit+<ContentListings id="self-hosting-resolve-issues" />-Share your self-hosting experience:+<ContentListings id="self-hosting-get-help" />-- [GitHub Discussions](https://github.com/orgs/supabase/discussions/39820) - "Self-hosting: What's working (and what's not)?"+<ContentListings id="self-hosting-share-experience" />### Enterprise self-hostingdiff --git a/apps/docs/data/content-listings/index.ts b/apps/docs/data/content-listings/index.tsindex b5ac8a84d09..dc94dece7e8 100644--- a/apps/docs/data/content-listings/index.ts+++ b/apps/docs/data/content-listings/index.ts@@ -12,6 +12,13 @@ import {} from './functions.data'import { gettingStartedGetStarted } from './getting-started.data'import { realtimeExamples, realtimeGetStarted, realtimeResources } from './realtime.data'+import {+ selfHostingCommunity,+ selfHostingGetHelp,+ selfHostingGetStarted,+ selfHostingResolveIssues,+ selfHostingShareExperience,+} from './self-hosting.data'import { storageExamples, storageGetStarted, storageResources } from './storage.data'const ALL_GROUPS: readonly ContentListingGroup[] = [@@ -30,6 +37,11 @@ const ALL_GROUPS: readonly ContentListingGroup[] = [realtimeGetStarted,realtimeExamples,realtimeResources,+ selfHostingGetStarted,+ selfHostingCommunity,+ selfHostingResolveIssues,+ selfHostingGetHelp,+ selfHostingShareExperience,storageGetStarted,storageExamples,storageResources,diff --git a/apps/docs/data/content-listings/self-hosting.data.ts b/apps/docs/data/content-listings/self-hosting.data.tsnew file mode 100644index 00000000000..c83ef00c456--- /dev/null+++ b/apps/docs/data/content-listings/self-hosting.data.ts@@ -0,0 +1,104 @@+import type { ContentListingGroup } from '~/lib/content-listings.schema'++export const selfHostingGetStarted: ContentListingGroup = {+ id: 'self-hosting-get-started',+ heading: 'Get started',+ headingLevel: 'h2',+ type: 'grid',+ columns: 2,+ description: 'The fastest and recommended way to self-host Supabase is to use Docker.',+ items: [+ {+ title: 'Docker',+ href: '/guides/self-hosting/docker',+ icon: '/docs/img/icons/docker',+ description: 'Deploy Supabase within your own infrastructure using Docker Compose.',+ badge: 'Official',+ },+ ],+}++export const selfHostingCommunity: ContentListingGroup = {+ id: 'self-hosting-community',+ heading: 'Community-driven projects',+ headingLevel: 'h2',+ type: 'grid',+ columns: 2,+ description:+ "There are several other options to deploy Supabase. If you're interested in helping these projects, visit our Community page.",+ items: [+ {+ title: 'Kubernetes',+ href: 'https://github.com/supabase-community/supabase-kubernetes',+ icon: '/docs/img/icons/kubernetes-icon',+ hasLightIcon: false,+ description: 'Helm charts to deploy a Supabase on Kubernetes.',+ },+ {+ title: 'Traefik',+ href: 'https://github.com/supabase-community/supabase-traefik',+ icon: '/docs/img/icons/traefik-icon',+ hasLightIcon: false,+ description: 'A self-hosted Supabase setup with Traefik as a reverse proxy.',+ },+ ],+}++export const selfHostingResolveIssues: ContentListingGroup = {+ id: 'self-hosting-resolve-issues',+ description: 'For resolving common issues:',+ type: 'grid',+ columns: 2,+ items: [+ {+ title: 'GitHub Discussions',+ href: 'https://github.com/orgs/supabase/discussions?discussions_q=is%3Aopen+label%3Aself-hosted',+ icon: '/docs/img/icons/github-icon',+ description: 'Questions, feature requests, and workarounds',+ },+ {+ title: 'GitHub Issues',+ href: 'https://github.com/supabase/supabase/issues?q=is%3Aissue%20state%3Aopen%20label%3Aself-hosted',+ icon: '/docs/img/icons/github-icon',+ description: 'Known issues',+ },+ ],+}++export const selfHostingGetHelp: ContentListingGroup = {+ id: 'self-hosting-get-help',+ description: 'Get help and connect with other users:',+ type: 'grid',+ columns: 2,+ items: [+ {+ title: 'Discord',+ href: 'https://discord.supabase.com',+ icon: '/docs/img/icons/discord-icon',+ hasLightIcon: false,+ description: 'Real-time chat and community support',+ },+ {+ title: 'Reddit',+ href: 'https://www.reddit.com/r/Supabase/',+ icon: '/docs/img/icons/reddit-icon',+ hasLightIcon: false,+ description: 'Official Supabase subreddit',+ },+ ],+}++export const selfHostingShareExperience: ContentListingGroup = {+ id: 'self-hosting-share-experience',+ description: 'Share your self-hosting experience:',+ type: 'grid',+ columns: 2,+ items: [+ {+ title: 'GitHub Discussions',+ href: 'https://github.com/orgs/supabase/discussions/39820',+ icon: '/docs/img/icons/github-icon',+ description: "Self-hosting: What's working (and what's not)?",+ },+ ],+}diff --git a/apps/docs/lib/content-listings.zod.mjs b/apps/docs/lib/content-listings.zod.mjsindex 4480879288e..990eb7f1c37 100644--- a/apps/docs/lib/content-listings.zod.mjs+++ b/apps/docs/lib/content-listings.zod.mjs@@ -5,6 +5,8 @@ export const contentListingItemSchema = z.object({href: z.string().min(1),description: z.string().min(1),icon: z.string().min(1).optional(),+ hasLightIcon: z.boolean().optional(),+ badge: z.string().min(1).optional(),})export const contentListingGroupTypeSchema = z.enum(['list', 'grid'])diff --git a/apps/docs/public/img/icons/kubernetes-icon.svg b/apps/docs/public/img/icons/kubernetes-icon.svgnew file mode 100644index 00000000000..b2dded3a0e3--- /dev/null+++ b/apps/docs/public/img/icons/kubernetes-icon.svg@@ -0,0 +1 @@+<svg fill="#326CE5" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Kubernetes</title><path d="M10.204 14.35l.007.01-.999 2.413a5.171 5.171 0 0 1-2.075-2.597l2.578-.437.004.005a.44.44 0 0 1 .484.606zm-.833-2.129a.44.44 0 0 0 .173-.756l.002-.011L7.585 9.7a5.143 5.143 0 0 0-.73 3.255l2.514-.725.002-.009zm1.145-1.98a.44.44 0 0 0 .699-.337l.01-.005.15-2.62a5.144 5.144 0 0 0-3.01 1.442l2.147 1.523.004-.002zm.76 2.75l.723.349.722-.347.18-.78-.5-.623h-.804l-.5.623.179.779zm1.5-3.095a.44.44 0 0 0 .7.336l.008.003 2.134-1.513a5.188 5.188 0 0 0-2.992-1.442l.148 2.615.002.001zm10.876 5.97l-5.773 7.181a1.6 1.6 0 0 1-1.248.594l-9.261.003a1.6 1.6 0 0 1-1.247-.596l-5.776-7.18a1.583 1.583 0 0 1-.307-1.34L2.1 5.573c.108-.47.425-.864.863-1.073L11.305.513a1.606 1.606 0 0 1 1.385 0l8.345 3.985c.438.209.755.604.863 1.073l2.062 8.955c.108.47-.005.963-.308 1.34zm-3.289-2.057c-.042-.01-.103-.026-.145-.034-.174-.033-.315-.025-.479-.038-.35-.037-.638-.067-.895-.148-.105-.04-.18-.165-.216-.216l-.201-.059a6.45 6.45 0 0 0-.105-2.332 6.465 6.465 0 0 0-.936-2.163c.052-.047.15-.133.177-.159.008-.09.001-.183.094-.282.197-.185.444-.338.743-.522.142-.084.273-.137.415-.242.032-.024.076-.062.11-.089.24-.191.295-.52.123-.736-.172-.216-.506-.236-.745-.045-.034.027-.08.062-.111.088-.134.116-.217.23-.33.35-.246.25-.45.458-.673.609-.097.056-.239.037-.303.033l-.19.135a6.545 6.545 0 0 0-4.146-2.003l-.012-.223c-.065-.062-.143-.115-.163-.25-.022-.268.015-.557.057-.905.023-.163.061-.298.068-.475.001-.04-.001-.099-.001-.142 0-.306-.224-.555-.5-.555-.275 0-.499.249-.499.555l.001.014c0 .041-.002.092 0 .128.006.177.044.312.067.475.042.348.078.637.056.906a.545.545 0 0 1-.162.258l-.012.211a6.424 6.424 0 0 0-4.166 2.003 8.373 8.373 0 0 1-.18-.128c-.09.012-.18.04-.297-.029-.223-.15-.427-.358-.673-.608-.113-.12-.195-.234-.329-.349-.03-.026-.077-.062-.111-.088a.594.594 0 0 0-.348-.132.481.481 0 0 0-.398.176c-.172.216-.117.546.123.737l.007.005.104.083c.142.105.272.159.414.242.299.185.546.338.743.522.076.082.09.226.1.288l.16.143a6.462 6.462 0 0 0-1.02 4.506l-.208.06c-.055.072-.133.184-.215.217-.257.081-.546.11-.895.147-.164.014-.305.006-.48.039-.037.007-.09.02-.133.03l-.004.002-.007.002c-.295.071-.484.342-.423.608.061.267.349.429.645.365l.007-.001.01-.003.129-.029c.17-.046.294-.113.448-.172.33-.118.604-.217.87-.256.112-.009.23.069.288.101l.217-.037a6.5 6.5 0 0 0 2.88 3.596l-.09.218c.033.084.069.199.044.282-.097.252-.263.517-.452.813-.091.136-.185.242-.268.399-.02.037-.045.095-.064.134-.128.275-.034.591.213.71.248.12.556-.007.69-.282v-.002c.02-.039.046-.09.062-.127.07-.162.094-.301.144-.458.132-.332.205-.68.387-.897.05-.06.13-.082.215-.105l.113-.205a6.453 6.453 0 0 0 4.609.012l.106.192c.086.028.18.042.256.155.136.232.229.507.342.84.05.156.074.295.145.457.016.037.043.09.062.129.133.276.442.402.69.282.247-.118.341-.435.213-.71-.02-.039-.045-.096-.065-.134-.083-.156-.177-.261-.268-.398-.19-.296-.346-.541-.443-.793-.04-.13.007-.21.038-.294-.018-.022-.059-.144-.083-.202a6.499 6.499 0 0 0 2.88-3.622c.064.01.176.03.213.038.075-.05.144-.114.28-.104.266.039.54.138.87.256.154.06.277.128.448.173.036.01.088.019.13.028l.009.003.007.001c.297.064.584-.098.645-.365.06-.266-.128-.537-.423-.608zM16.4 9.701l-1.95 1.746v.005a.44.44 0 0 0 .173.757l.003.01 2.526.728a5.199 5.199 0 0 0-.108-1.674A5.208 5.208 0 0 0 16.4 9.7zm-4.013 5.325a.437.437 0 0 0-.404-.232.44.44 0 0 0-.372.233h-.002l-1.268 2.292a5.164 5.164 0 0 0 3.326.003l-1.27-2.296h-.01zm1.888-1.293a.44.44 0 0 0-.27.036.44.44 0 0 0-.214.572l-.003.004 1.01 2.438a5.15 5.15 0 0 0 2.081-2.615l-2.6-.44-.004.005z"/></svg>\ No newline at end of filediff --git a/apps/docs/public/img/icons/reddit-icon.svg b/apps/docs/public/img/icons/reddit-icon.svgnew file mode 100644index 00000000000..34c37c0fe36--- /dev/null+++ b/apps/docs/public/img/icons/reddit-icon.svg@@ -0,0 +1 @@+<svg fill="#FF4500" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Reddit</title><path d="M12 0C5.373 0 0 5.373 0 12c0 3.314 1.343 6.314 3.515 8.485l-2.286 2.286C.775 23.225 1.097 24 1.738 24H12c6.627 0 12-5.373 12-12S18.627 0 12 0Zm4.388 3.199c1.104 0 1.999.895 1.999 1.999 0 1.105-.895 2-1.999 2-.946 0-1.739-.657-1.947-1.539v.002c-1.147.162-2.032 1.15-2.032 2.341v.007c1.776.067 3.4.567 4.686 1.363.473-.363 1.064-.58 1.707-.58 1.547 0 2.802 1.254 2.802 2.802 0 1.117-.655 2.081-1.601 2.531-.088 3.256-3.637 5.876-7.997 5.876-4.361 0-7.905-2.617-7.998-5.87-.954-.447-1.614-1.415-1.614-2.538 0-1.548 1.255-2.802 2.803-2.802.645 0 1.239.218 1.712.585 1.275-.79 2.881-1.291 4.64-1.365v-.01c0-1.663 1.263-3.034 2.88-3.207.188-.911.993-1.595 1.959-1.595Zm-8.085 8.376c-.784 0-1.459.78-1.506 1.797-.047 1.016.64 1.429 1.426 1.429.786 0 1.371-.369 1.418-1.385.047-1.017-.553-1.841-1.338-1.841Zm7.406 0c-.786 0-1.385.824-1.338 1.841.047 1.017.634 1.385 1.418 1.385.785 0 1.473-.413 1.426-1.429-.046-1.017-.721-1.797-1.506-1.797Zm-3.703 4.013c-.974 0-1.907.048-2.77.135-.147.015-.241.168-.183.305.483 1.154 1.622 1.964 2.953 1.964 1.33 0 2.47-.81 2.953-1.964.057-.137-.037-.29-.184-.305-.863-.087-1.795-.135-2.769-.135Z"/></svg>\ No newline at end of filediff --git a/apps/docs/public/img/icons/traefik-icon.svg b/apps/docs/public/img/icons/traefik-icon.svgnew file mode 100644index 00000000000..0135fda5beb--- /dev/null+++ b/apps/docs/public/img/icons/traefik-icon.svg@@ -0,0 +1 @@+<svg fill="#24A1C1" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Traefik Proxy</title><path d="M12 1.19c1.088 0 2.056.768 2.056 1.714 0 .947-.921 1.715-2.056 1.715-.13 0-.3-.022-.509-.064a.685.685 0 0 0-.475.076l-7.37 4.195a.344.344 0 0 0 .001.597l7.99 4.49c.208.116.461.116.669 0l8.034-4.468a.343.343 0 0 0 .003-.598l-2.507-1.424a.683.683 0 0 0-.67-.003l-2.647 1.468a.234.234 0 0 0-.119.18l-.001.025c0 .946-.921 1.714-2.056 1.714s-2.056-.768-2.056-1.714c0-.947.921-1.715 2.056-1.715.042 0 .09.002.145.007l.087.008.096.013a.685.685 0 0 0 .425-.08l3.913-2.173c.3-.166.662-.171.965-.017l.04.023 5.465 3.104c.686.39.693 1.368.03 1.773l-.037.021-3.656 2.033a.343.343 0 0 0 .007.604l3.62 1.906c.72.378.736 1.402.03 1.804l-10.995 6.272a1.03 1.03 0 0 1-1.019 0L.526 16.43a1.03 1.03 0 0 1 .034-1.806l3.66-1.911a.343.343 0 0 0 .01-.603L.524 10.029a1.03 1.03 0 0 1-.041-1.77l.036-.021L9.618 3.06a.688.688 0 0 0 .308-.369l.011-.036c.32-.952 1.046-1.466 2.063-1.466Zm5.076 12.63-4.492 2.586-.041.022c-.306.158-.671.152-.973-.018l-4.478-2.527a.682.682 0 0 0-.65-.01L3.86 15.224a.343.343 0 0 0-.012.602l7.887 4.515c.21.12.467.121.677 0l7.956-4.547a.343.343 0 0 0-.01-.602l-2.623-1.384a.683.683 0 0 0-.659.012z"/></svg>\ No newline at end of filediff --git a/packages/ui-patterns/src/GlassPanel/index.tsx b/packages/ui-patterns/src/GlassPanel/index.tsxindex 11858aeddf0..9fcf7d7586f 100644--- a/packages/ui-patterns/src/GlassPanel/index.tsx+++ b/packages/ui-patterns/src/GlassPanel/index.tsx@@ -17,6 +17,7 @@ interface Props {hasLightIcon?: booleanshowLink?: booleanshowIconBg?: boolean+ badge?: React.ReactNode}const IconBackground = ({@@ -71,6 +72,7 @@ export const GlassPanel = ({hasLightIcon,showLink = false,showIconBg = false,+ badge,className,}: Props) => {const { resolvedTheme } = useTheme()@@ -143,7 +145,10 @@ export const GlassPanel = ({) : (icon && <IconBackground showIconBg={showIconBg}>{icon}</IconBackground>)}- <p className="text-base text-foreground">{title}</p>+ <p className="text-base text-foreground flex items-center gap-2">+ {title}+ {badge}+ </p></div>{children && <span className="text-sm text-foreground-light grow">{children}</span>}