docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "PowerSync",
  "colors": {
    "primary": "#4e89ff",
    "light": "#4e89ff",
    "dark": "#4e89ff"
  },
  "favicon": "/favicon.png",
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg",
    "href": "https://www.powersync.com/"
  },
  "background": {
    "decoration": "gradient"
  },
  "navbar": {
    "links": [
      {
        "label": "Dashboard",
        "href": "https://powersync.journeyapps.com/"
      }
    ],
    "primary": {
      "type": "button",
      "label": "Get Started",
      "href": "https://accounts.journeyapps.com/portal/powersync-signup?s=docs"
    }
  },
  "footer": {
    "socials": {
      "github": "https://github.com/powersync-ja",
      "discord": "https://discord.com/invite/powersync",
      "bluesky": "https://bsky.app/profile/powersync.com",
      "x": "https://x.com/powersync_",
      "youtube": "https://www.youtube.com/@powersync_",
      "linkedin": "https://www.linkedin.com/showcase/journeyapps-powersync/"
    }
  },
  "contextual": {
    "options": [
      "copy",
      "view",
      "chatgpt",
      "claude"
    ]
  },
  "integrations": {
    "plausible": {
      "domain": "docs.powersync.com"
    }
  },
  "navigation": {
    "tabs": [
      {
        "tab": "Documentation",
        "groups": [
          {
            "group": "Introduction",
            "pages": [
              "intro/powersync-overview",
              "intro/powersync-philosophy"
            ]
          },
          {
            "group": "Installation",
            "pages": [
              "installation/quickstart-guide",
              {
                "group": "Source Database Setup",
                "pages": [
                  "installation/database-setup",
                  "installation/database-setup/security-and-ip-filtering",
                  "installation/database-setup/private-endpoints"
                ]
              },
              "installation/database-connection",
              {
                "group": "Client-Side Setup",
                "pages": [
                  "installation/client-side-setup",
                  "installation/client-side-setup/define-your-schema",
                  "installation/client-side-setup/instantiate-powersync-database",
                  "installation/client-side-setup/integrating-with-your-backend"
                ]
              },
              {
                "group": "App Backend Setup",
                "pages": [
                  "installation/app-backend-setup",
                  "installation/app-backend-setup/writing-client-changes"
                ]
              },
              {
                "group": "Authentication Setup",
                "pages": [
                  "installation/authentication-setup",
                  "installation/authentication-setup/development-tokens",
                  {
                    "group": "Supabase Auth",
                    "pages": [
                      "installation/authentication-setup/supabase-auth",
                      "installation/authentication-setup/supabase-auth/stytch-+-supabase"
                    ]
                  },
                  "installation/authentication-setup/firebase-auth",
                  "installation/authentication-setup/auth0",
                  "installation/authentication-setup/custom"
                ]
              }
            ]
          },
          {
            "group": "Usage",
            "pages": [
              {
                "group": "Sync Rules",
                "pages": [
                  "usage/sync-rules",
                  "usage/sync-rules/example-global-data",
                  "usage/sync-rules/organize-data-into-buckets",
                  "usage/sync-rules/parameter-queries",
                  "usage/sync-rules/data-queries",
                  "usage/sync-rules/types",
                  "usage/sync-rules/client-id",
                  "usage/sync-rules/operators-and-functions",
                  "usage/sync-rules/schemas-and-connections",
                  "usage/sync-rules/case-sensitivity",
                  "usage/sync-rules/glossary",
                  "usage/sync-rules/guide-many-to-many-and-join-tables",
                  {
                    "group": "Advanced Topics",
                    "pages": [
                      "usage/sync-rules/advanced-topics",
                      "usage/sync-rules/advanced-topics/multiple-client-versions",
                      "usage/sync-rules/advanced-topics/client-parameters",
                      "usage/sync-rules/advanced-topics/partitioned-tables",
                      "usage/sync-rules/advanced-topics/sharded-databases"
                    ]
                  }
                ]
              },
              {
                "group": "Lifecycle / Maintenance",
                "pages": [
                  "usage/lifecycle-maintenance",
                  "usage/lifecycle-maintenance/implementing-schema-changes",
                  {
                    "group": "Deploying Schema Changes",
                    "pages": [
                      "usage/lifecycle-maintenance/deploying-schema-changes",
                      "usage/lifecycle-maintenance/deploying-schema-changes/additive-changes",
                      "usage/lifecycle-maintenance/deploying-schema-changes/renaming-a-table-on-the-server",
                      "usage/lifecycle-maintenance/deploying-schema-changes/renaming-a-table-on-the-client",
                      "usage/lifecycle-maintenance/deploying-schema-changes/renaming-a-table-on-both-server-and-client",
                      "usage/lifecycle-maintenance/deploying-schema-changes/renaming-a-column-on-the-server",
                      "usage/lifecycle-maintenance/deploying-schema-changes/renaming-a-column-on-the-client",
                      "usage/lifecycle-maintenance/deploying-schema-changes/changing-a-column-type"
                    ]
                  },
                  {
                    "group": "Handling Update Conflicts",
                    "pages": [
                      "usage/lifecycle-maintenance/handling-update-conflicts",
                      "usage/lifecycle-maintenance/handling-update-conflicts/custom-conflict-resolution"
                    ]
                  },
                  "usage/lifecycle-maintenance/handling-write-validation-errors",
                  "usage/lifecycle-maintenance/upgrading-the-client-sdk",
                  "usage/lifecycle-maintenance/postgres-maintenance",
                  "usage/lifecycle-maintenance/compacting-buckets"
                ]
              },
              {
                "group": "Use Case Examples",
                "pages": [
                  "usage/use-case-examples",
                  "usage/use-case-examples/attachments-files",
                  "usage/use-case-examples/background-syncing",
                  "usage/use-case-examples/crdts",
                  "usage/use-case-examples/custom-types-arrays-and-json",
                  "usage/use-case-examples/data-encryption",
                  "usage/use-case-examples/full-text-search",
                  "usage/use-case-examples/infinite-scrolling",
                  "usage/use-case-examples/offline-only-usage",
                  "usage/use-case-examples/postgis",
                  "usage/use-case-examples/prioritized-sync",
                  "usage/use-case-examples/raw-tables",
                  "usage/use-case-examples/custom-write-checkpoints"
                ]
              },
              {
                "group": "Tools",
                "pages": [
                  "usage/tools",
                  "usage/tools/powersync-dashboard",
                  "usage/tools/cli",
                  "usage/tools/diagnostic-app",
                  "usage/tools/monitoring-and-alerting",
                  "usage/tools/cloudcode"
                ]
              }
            ]
          },
          {
            "group": "Integration Guides",
            "pages": [
              "integration-guides/integrations-overview",
              {
                "group": "Supabase + PowerSync",
                "pages": [
                  "integration-guides/supabase-+-powersync",
                  "integration-guides/supabase-+-powersync/handling-attachments",
                  "integration-guides/supabase-+-powersync/realtime-streaming",
                  "integration-guides/supabase-+-powersync/rls-and-sync-rules",
                  "integration-guides/supabase-+-powersync/local-development"
                ]
              },
              {
                "group": "FlutterFlow + PowerSync",
                "pages": [
                  "integration-guides/flutterflow-+-powersync",
                  "integration-guides/flutterflow-+-powersync/handling-attachments",
                  "integration-guides/flutterflow-+-powersync/flutter-web",
                  "integration-guides/flutterflow-+-powersync/full-text-search",
                  "integration-guides/flutterflow-+-powersync/powersync-+-flutterflow-legacy"
                ]
              },
              "integration-guides/railway-+-powersync",
              "integration-guides/coolify"
            ]
          },
          {
            "group": "Migration Guides",
            "pages": [
              "migration-guides/mongodb-atlas",
              "migration-guides/watermelondb"
            ]
          },
          {
            "group": "Architecture",
            "pages": [
              "architecture/architecture-overview",
              "architecture/powersync-service",
              "architecture/client-architecture",
              "architecture/powersync-protocol",
              "architecture/consistency"
            ]
          }
        ]
      },
      {
        "tab": "Client SDKs",
        "groups": [
          {
            "group": "Client SDKs",
            "pages": [
              "client-sdk-references/introduction",
              {
                "group": "Flutter",
                "icon": "flutter",
                "pages": [
                  "client-sdk-references/flutter",
                  "client-sdk-references/flutter/flutter-web-support",
                  "client-sdk-references/flutter/flutter-orm-support",
                  "client-sdk-references/flutter/usage-examples",
                  "client-sdk-references/flutter/state-management",
                  "client-sdk-references/flutter/unit-testing",
                  "client-sdk-references/flutter/encryption",
                  "client-sdk-references/flutter/api-reference"
                ]
              },
              {
                "group": "React Native & Expo",
                "icon": "react",
                "pages": [
                  "client-sdk-references/react-native-and-expo",
                  "client-sdk-references/react-native-and-expo/react-native-web-support",
                  "client-sdk-references/react-native-and-expo/javascript-orm-support",
                  "client-sdk-references/react-native-and-expo/usage-examples",
                  "client-sdk-references/react-native-and-expo/encryption",
                  "client-sdk-references/react-native-and-expo/api-reference"
                ]
              },
              {
                "group": "JavaScript Web",
                "icon": "js",
                "pages": [
                  "client-sdk-references/javascript-web",
                  {
                    "group": "ORM Support",
                    "pages": [
                      "client-sdk-references/javascript-web/javascript-orm/overview",
                      "client-sdk-references/javascript-web/javascript-orm/kysely",
                      "client-sdk-references/javascript-web/javascript-orm/drizzle"
                    ]
                  },
                  "client-sdk-references/javascript-web/javascript-spa-frameworks",
                  "client-sdk-references/javascript-web/usage-examples",
                  "client-sdk-references/javascript-web/encryption",
                  "client-sdk-references/javascript-web/api-reference"
                ]
              },
              {
                "group": "Kotlin Multiplatform",
                "icon": "k",
                "pages": [
                  "client-sdk-references/kotlin-multiplatform",
                  "client-sdk-references/kotlin-multiplatform/usage-examples"
                ]
              },
              {
                "group": "Swift",
                "icon": "swift",
                "pages": [
                  "client-sdk-references/swift",
                  "client-sdk-references/swift/usage-examples"
                ]
              },
              {
                "group": "Node.js",
                "icon": "node-js",
                "pages": [
                  "client-sdk-references/node",
                  "client-sdk-references/node/javascript-orm-support"
                ]
              },
              {
                "group": ".NET",
                "icon": "microsoft",
                "pages": [
                  "client-sdk-references/dotnet"
                ]
              }
            ]
          }
        ]
      },
      {
        "tab": "Self-Hosting",
        "groups": [
          {
            "group": "Self-Hosting",
            "pages": [
              "self-hosting/getting-started",
              {
                "group": "Installation",
                "pages": [
                  "self-hosting/installation",
                  "self-hosting/installation/database-setup",
                  "self-hosting/installation/powersync-service-setup",
                  "self-hosting/installation/client-side-setup",
                  "self-hosting/installation/app-backend-setup"
                ]
              },
              "self-hosting/local-development",
              {
                "group": "Lifecycle / Maintenance",
                "pages": [
                  "self-hosting/lifecycle-maintenance",
                  "self-hosting/lifecycle-maintenance/securing-your-deployment",
                  "self-hosting/lifecycle-maintenance/healthchecks",
                  "self-hosting/lifecycle-maintenance/telemetry",
                  "self-hosting/lifecycle-maintenance/migrating",
                  "self-hosting/lifecycle-maintenance/multiple-instances"
                ]
              },
              "self-hosting/enterprise",
              {
                "group": "Appendix",
                "pages": [
                  "self-hosting/appendix",
                  "self-hosting/appendix/database-connection"
                ]
              }
            ]
          }
        ]
      },
      {
        "tab": "Tutorials",
        "groups": [
          {
            "group": " ",
            "pages": [
              "tutorials/overview"
            ]
          },
          {
            "group": "Client",
            "pages": [
              "tutorials/client/overview",
              {
                "group": "Client SDKs",
                "pages": [
                  "tutorials/client/sdks/web/next-js"
                ]
              },
              {
                "group": "Attachments / Files",
                "pages": [
                  "tutorials/client/attachments-and-files/overview",
                  "tutorials/client/attachments-and-files/aws-s3-storage-adapter",
                  "tutorials/client/attachments-and-files/pdf-attachment"
                ]
              },
              {
                "group": "Performance",
                "pages": [
                  "tutorials/client/performance/overview",
                  "tutorials/client/performance/supabase-connector-performance"
                ]
              },
              {
                "group": "Data Management",
                "pages": [
                  "tutorials/client/data/overview",
                  "tutorials/client/data/cascading-delete",
                  "tutorials/client/data/sequential-id-mapping"
                ]
              }
            ]
          },
          {
            "group": "Self-Hosting",
            "pages": [
              "tutorials/self-host/overview",
              "tutorials/self-host/generate-dev-token"
            ]
          }
        ]
      },
      {
        "tab": "Resources",
        "groups": [
          {
            "group": "Resources",
            "pages": [
              "resources/demo-apps-example-projects",
              {
                "group": "Troubleshooting",
                "pages": [
                  "resources/troubleshooting",
                  "resources/troubleshooting/error-codes"
                ]
              },
              {
                "group": "Usage & Billing",
                "pages": [
                  "resources/usage-and-billing",
                  "resources/usage-and-billing/pricing-example",
                  "resources/usage-and-billing-faq"
                ]
              },
              "resources/ai-tools",
              "resources/performance-and-limits",
              "resources/feature-status",
              "resources/supported-hardware",
              "resources/faq",
              "resources/local-first-software",
              "resources/release-notes",
              "resources/roadmap",
              "resources/blog",
              "resources/security",
              "resources/contact-us"
            ]
          }
        ]
      }
    ],
    "global": {
      "anchors": [
        {
          "anchor": "GitHub",
          "href": "https://github.com/powersync-ja",
          "icon": "github"
        },
        {
          "anchor": "Community Discord",
          "href": "https://discord.com/invite/powersync",
          "icon": "discord"
        },
        {
          "anchor": "PowerSync Dashboard",
          "href": "https://powersync.journeyapps.com/",
          "icon": "desktop"
        },
        {
          "anchor": "PowerSync Website",
          "href": "https://www.powersync.com/",
          "icon": "browser"
        }
      ]
    }
  },
  "redirects": [
    {
      "source": "/overview-1",
      "destination": "/intro/powersync-overview"
    },
    {
      "source": "/quickstart-guide",
      "destination": "/installation/quickstart-guide"
    },
    {
      "source": "/overview/powersync-philosophy",
      "destination": "/intro/powersync-philosophy"
    },
    {
      "source": "/usage/quickstart-guide",
      "destination": "/installation/quickstart-guide"
    },
    {
      "source": "/usage/installation",
      "destination": "/installation/quickstart-guide"
    },
    {
      "source": "/usage/installation/database-setup",
      "destination": "/installation/database-setup"
    },
    {
      "source": "/usage/installation/database-setup/security-and-ip-filtering",
      "destination": "installation/database-setup/security-and-ip-filtering"
    },
    {
      "source": "/usage/installation/database-connection",
      "destination": "/installation/database-connection"
    },
    {
      "source": "/usage/installation/client-side-setup",
      "destination": "/installation/client-side-setup"
    },
    {
      "source": "/usage/installation/client-side-setup/define-your-schema",
      "destination": "/installation/client-side-setup/define-your-schema"
    },
    {
      "source": "/usage/installation/client-side-setup/instantiate-powersync-database",
      "destination": "/installation/client-side-setup/instantiate-powersync-database"
    },
    {
      "source": "/usage/installation/client-side-setup/integrating-with-your-backend",
      "destination": "/installation/client-side-setup/integrating-with-your-backend"
    },
    {
      "source": "/usage/installation/app-backend-setup",
      "destination": "/installation/app-backend-setup"
    },
    {
      "source": "/usage/installation/app-backend-setup/writing-client-changes",
      "destination": "installation/app-backend-setup/writing-client-changes"
    },
    {
      "source": "/usage/installation/authentication-setup",
      "destination": "/installation/authentication-setup"
    },
    {
      "source": "/usage/installation/authentication-setup/development-tokens",
      "destination": "/installation/authentication-setup/development-tokens"
    },
    {
      "source": "/usage/installation/authentication-setup/supabase-auth",
      "destination": "/installation/authentication-setup/supabase-auth"
    },
    {
      "source": "/usage/installation/authentication-setup/supabase-auth/stytch-+-supabase",
      "destination": "/installation/authentication-setup/supabase-auth/stytch-+-supabase"
    },
    {
      "source": "usage/installation/authentication-setup/firebase-auth",
      "destination": "/installation/authentication-setup/firebase-auth"
    },
    {
      "source": "usage/installation/authentication-setup/auth0",
      "destination": "/installation/authentication-setup/auth0"
    },
    {
      "source": "/usage/installation/authentication-setup/custom",
      "destination": "/installation/authentication-setup/custom"
    },
    {
      "source": "/installation/sync-rules",
      "destination": "/usage/sync-rules"
    },
    {
      "source": "/usage/sync-rules/advanced-topics/client-parameters-beta",
      "destination": "/usage/sync-rules/advanced-topics/client-parameters"
    },
    {
      "source": "/client-sdk-references/flutter/flutter-web-support-alpha",
      "destination": "/client-sdk-references/flutter/flutter-web-support"
    },
    {
      "source": "/resources/migration-guides",
      "destination": "/migration-guides/mongodb-atlas"
    },
    {
      "source": "/resources/migration-guides/mongodb-atlas",
      "destination": "/migration-guides/mongodb-atlas"
    },
    {
      "source": "/resources/migration-guides/watermelondb",
      "destination": "/migration-guides/watermelondb"
    },
    {
      "source": "/resources/monitoring-and-alerting",
      "destination": "/usage/tools/monitoring-and-alerting"
    },
    {
      "source": "/client-sdk-references/js-web",
      "destination": "/client-sdk-references/javascript-web"
    },
    {
      "source": "/client-sdk-references/js-web/javascript-spa-frameworks",
      "destination": "/client-sdk-references/javascript-web/javascript-spa-frameworks"
    },
    {
      "source": "/client-sdk-references/js-web/javascript-orm-support",
      "destination": "/client-sdk-references/javascript-web/javascript-orm/overview"
    },
    {
      "source": "/client-sdk-references/js-web/usage-examples",
      "destination": "/client-sdk-references/javascript-web/usage-examples"
    },
    {
      "source": "/client-sdk-references/js-web/api-reference",
      "destination": "/client-sdk-references/javascript-web/api-reference"
    },
    {
      "source": "/integration-guides/supabase",
      "destination": "/integration-guides/supabase-+-powersync"
    },
    {
      "source": "/self-hosting/lifecycle-maintenance/server-specs",
      "destination": "/self-hosting/lifecycle-maintenance"
    },
    {
      "source": "/self-hosting/telemetry",
      "destination": "/self-hosting/lifecycle-maintenance/telemetry"
    }
  ]
}