Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions app/authzed/api/http-api/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "HTTP API Documentation"
description: "Interactive Swagger reference for the SpiceDB and AuthZed HTTP API, documenting available endpoints, request parameters, and response schemas."
---

import { Swagger } from "@/components/swagger";

# HTTP API Documentation
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/concepts/audit-logging/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Audit Logging"
description: "AuthZed functionality that publishes detailed logs of SpiceDB API operations to log sinks like AWS Kinesis and Kinesis Firehose."
---

import { Callout, Tabs } from "nextra/components";

# Audit Logging
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/concepts/feature-maturity/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Feature Maturity"
description: "The three AuthZed feature maturity stages: Tech Preview, Early Access, and General Availability, and the stability each provides."
---

# Feature Maturity

In order to provide a balance between stability and the ability to adopt new functionality in its early stages, features developed by AuthZed are classified under one of three states of maturity.
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/concepts/management-dashboard/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Management Dashboard"
description: "A web-based application for platform operators to configure and monitor SpiceDB deployments on AuthZed Dedicated and Cloud."
---

# Management Dashboard

The Management Dashboard is a web-based application for organizations to manage SpiceDB deployments.
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/concepts/multi-region/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Multi-Region Deployments"
description: "A collection of SpiceDB deployments located in different regions worldwide that all share a single datastore."
---

# Multi-Region Deployments

Multi-Region Deployments are a collection of SpiceDB deployments that can be located in various regions across the world, but that all share a single [Datastore].
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/concepts/private-networking/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Private Networking"
description: "AuthZed Dedicated functionality that restricts network access to trusted internal networks, illustrated with AWS PrivateLink."
---

import { Callout } from "nextra/components";

# Private Networking
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/concepts/restricted-api-access/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Restricted API Access"
description: "Apply least-privilege access to the SpiceDB API using service accounts, tokens, roles, policies, and CEL expressions in AuthZed products."
---

import { Callout, Tabs } from "nextra/components";

# Restricted API Access
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/concepts/security-embargo/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Security Embargo"
description: "How AuthZed's security embargo program privately reports, analyzes, and resolves security vulnerabilities before public disclosure."
---

import { Callout } from "nextra/components";

# Security Embargo
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/concepts/update-channels/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Update Channels"
description: "How AuthZed's Rapid and Regular update channels control the flow of SpiceDB updates, with configurable update and rollout strategies."
---

# Update Channels

Update Channels dictate the flow of updates to running SpiceDB clusters.
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/concepts/workload-isolation/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Workload Isolation"
description: "AuthZed functionality that gives SpiceDB deployments dedicated hardware to guarantee performance and prevent noisy neighbor problems."
---

import YouTube from "@/components/youtube-wrapper";

# Workload Isolation
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/guides/cloud/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Getting Started with AuthZed Cloud"
description: "Create a permissions system in AuthZed Cloud and configure access with service accounts, tokens, roles, and policies."
---

import { Callout } from "nextra/components";
import YouTube from "@/components/youtube-wrapper";

Expand Down
5 changes: 5 additions & 0 deletions app/authzed/guides/picking-a-product/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Picking the right AuthZed Product"
description: "Compare AuthZed Open Source, Cloud, Dedicated, and Enterprise across features like audit logging, isolation, and support to choose the right option."
---

import { Callout } from "nextra/components";

# Picking the right AuthZed Product
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/guides/postgres-fdw/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Using Postgres FDW with AuthZed Cloud/Dedicated"
description: "Query your AuthZed Cloud or Dedicated permissions system with SQL via the Postgres FDW, using Restricted API Access tokens for authentication."
---

import { Callout, Steps } from "nextra/components";

# Using Postgres FDW with AuthZed Cloud/Dedicated
Expand Down
5 changes: 5 additions & 0 deletions app/authzed/guides/setting-up-private-networking/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Setting up Private Networking"
description: "Step-by-step guide to configuring AuthZed Dedicated Private Networking on AWS, GCP and Azure."
---

import { Steps } from "nextra/components";
import { Callout } from "nextra/components";

Expand Down
9 changes: 5 additions & 4 deletions app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@ export const generateMetadata = async (
},
description: "Welcome to the SpiceDB and AuthZed docs site.",
openGraph: {
title: {
default: "Authzed Docs",
template: "%s - Authzed Docs",
},
// Slack builds its preview links from these tags.
// Intentionally omit `title` here: an og:title template only applies when
// a child page sets `openGraph.title` as a string, which Nextra pages
// never do. Leaving it unset lets Next.js infer og:title from the
// (already templated) page `title`, so previews show the real page name.
description: description ?? undefined,
},
alternates: {
Expand Down
5 changes: 5 additions & 0 deletions app/materialize/api/client-sdks/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Client SDKs"
description: "SDK versions with generated gRPC and protobuf support for the AuthZed Materialize API in Go, Java, Python, Ruby, and Node.js."
---

# Client SDKs

All SpiceDB SDKs have the generated gRPC and protobuf code
Expand Down
5 changes: 5 additions & 0 deletions app/materialize/api/lookup-permission-sets/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "LookupPermissionSets"
description: "Backfill an initial snapshot of Materialize permission set data with the cursor-resumable LookupPermissionSets API, including reindexing strategies for breaking schema changes."
---

import { Callout } from "nextra/components";

# LookupPermissionSets
Expand Down
5 changes: 5 additions & 0 deletions app/materialize/api/watch-permission-sets/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "WatchPermissionSets"
description: "Stream permission set changes from Materialize with the WatchPermissionSets API: event types, revision checkpoints, and breaking schema change notifications."
---

import { Callout } from "nextra/components";

# WatchPermissionSets
Expand Down
5 changes: 5 additions & 0 deletions app/materialize/concepts/managing-client-state/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Managing Client State"
description: "State diagram of the transitions a client application moves through when consuming the LookupPermissionSets and WatchPermissionSets APIs."
---

# Managing Client State

This diagram shows the various states your client application will need to transition through when calling the [LookupPermissionSets] and the [WatchPermissionSets] APIs.
Expand Down
5 changes: 5 additions & 0 deletions app/materialize/concepts/permission-set-lifecycle/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "The Permission Set Lifecycle"
description: "How your local copy of Materialize permission data is backfilled, kept current with the change stream, and rebuilt after a breaking schema change."
---

import { Callout } from "nextra/components";

# The permission set lifecycle
Expand Down
5 changes: 5 additions & 0 deletions app/materialize/concepts/permission-sets/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Permission Sets"
description: "Permission sets are the unit of precomputed authorization data Materialize produces: member-to-set and set-to-set edges you can store and query in your own datastore."
---

import { Callout } from "nextra/components";

# Permission Sets
Expand Down
5 changes: 5 additions & 0 deletions app/materialize/concepts/snapshots/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Snapshots"
description: "Snapshots are point-in-time, internally consistent views of Materialize permission sets anchored to a SpiceDB revision, enabling safe resume, rotation, and rebuilds."
---

import { Callout } from "nextra/components";

# Snapshots
Expand Down
5 changes: 5 additions & 0 deletions app/materialize/getting-started/limitations/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Limitations"
description: "Current limitations of AuthZed Materialize, including caveats, wildcards, .all intersections, expiring relationships, and computation lag."
---

# Limitations

- Your schema can contain any of the following, but they cannot be on the path of your configured Materialize permissions or it will throw an error:
Expand Down
5 changes: 5 additions & 0 deletions app/materialize/getting-started/overview/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "What is Materialize?"
description: "AuthZed Materialize precomputes the permissions you configure it to watch, speeding up checks and lookups and enabling colocated permissions for search, sorting, and filtering."
---

import { Callout } from "nextra/components";

# What is Materialize?
Expand Down
5 changes: 5 additions & 0 deletions app/materialize/guides/recommended-architecture/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Recommended Architecture"
description: "How to build a durable, resumable, idempotent consumer that streams Materialize permission updates into your own datastore."
---

import { Callout } from "nextra/components";

# Recommended Architecture
Expand Down
5 changes: 5 additions & 0 deletions app/materialize/guides/relational-database/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Syncing to a Relational Database"
description: "Store Materialize permission sets in member_to_set and set_to_set tables and use SQL joins for authorization-aware filtering, with worked examples."
---

import { Callout } from "nextra/components";

# Syncing to a Relational Database
Expand Down
5 changes: 5 additions & 0 deletions app/mcp/authzed/authzed-mcp-server/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "AuthZed MCP Server"
description: "Connect AI clients to the remote AuthZed MCP server at mcp.authzed.com to search SpiceDB and AuthZed docs, APIs, and authorization pattern examples."
---

# AuthZed MCP Server

Connect your AI tools to AuthZed and SpiceDB documentation using the Model Context Protocol (MCP).
Expand Down
5 changes: 5 additions & 0 deletions app/mcp/authzed/spicedb-dev-mcp-server/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "SpiceDB Dev MCP Server"
description: "Run a local, in-memory SpiceDB dev instance over MCP to build, test, and debug schemas and permissions interactively in your AI coding assistant."
---

import { Callout } from "nextra/components";

# SpiceDB Dev MCP Server
Expand Down
5 changes: 5 additions & 0 deletions app/mcp/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Model Context Protocol"
description: "An overview of the Model Context Protocol (MCP), how it connects LLMs to external tools and data, its security model, and AuthZed's MCP resources."
---

# Model Context Protocol

## Overview
Expand Down
1 change: 1 addition & 0 deletions app/page.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: AuthZed Documentation
description: "Documentation for SpiceDB and AuthZed products, covering schema design, APIs, datastores, consistency, deployment, and authorization concepts."
---

import { DocsHomeShell } from "@/components/docs-home-shell";
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/api/http-api/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "HTTP API Documentation"
description: "Interactive Swagger reference for the SpiceDB HTTP API, covering permission checks, relationship reads and writes, and schema operations."
---

import { Swagger } from "@/components/swagger";

# HTTP API Documentation
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/best-practices/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Best Practices"
description: "Prioritized best practices for running SpiceDB, covering schema design, datastore tuning, consistency, API usage, and operational recommendations."
---

# Best Practices

## Rule Categories
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/caveats/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Caveats"
description: "How to define and use SpiceDB caveats: CEL-based conditional relationships for ABAC, parameter types, providing context via the API and zed CLI, and validation."
---

import { Callout } from "nextra/components";

# Caveats
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/commands/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "SpiceDB CLI Command Reference"
description: "Reference for the spicedb command-line tool and its subcommands, including serve, datastore migrate, lsp, and their configuration flags."
---

## Reference: `spicedb`

A database that stores and computes permissions
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/consistency/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Consistency"
description: "How SpiceDB balances caching performance with data freshness using ZedTokens and per-request consistency levels to avoid the New Enemy Problem."
---

import YouTube from "@/components/youtube-wrapper";
import { Callout } from "nextra/components";

Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/datastore-migrations/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Datastore Migrations"
description: "How to migrate a SpiceDB datastore schema using spicedb datastore migrate, plus migration compatibility, overrides, and update recommendations."
---

import { Callout } from "nextra/components";

# Datastore Migrations
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/datastores/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Datastores"
description: "SpiceDB's supported datastores (CockroachDB, Cloud Spanner, PostgreSQL, MySQL, memdb) with usage notes, consistency considerations, and configuration parameters."
---

import { Callout } from "nextra/components";

# Datastores
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/expiring-relationships/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Writing Relationships that Expire"
description: "Grant time-bound access in SpiceDB v1.40+ using expiring relationships: schema setup, the API, zed, garbage collection, and migrating off caveats."
---

import { Callout } from "nextra/components";
import { InlinePlayground } from "@/components/playground";

Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/querying-data/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Querying Data"
description: "Compare SpiceDB's data-querying APIs including CheckPermission, CheckBulkPermissions, LookupResources, LookupSubjects, ReadRelationships, and Watch."
---

import { Callout } from "nextra/components";

# Querying Data
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/read-after-write/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Read-After-Write Consistency"
description: "How to ensure SpiceDB permission checks reflect recently written relationships using ZedTokens, fully_consistent, or eventual consistency."
---

import { Callout } from "nextra/components";

# Read-After-Write Consistency
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/reflection-apis/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Reflection APIs"
description: "SpiceDB's Reflection APIs (ReflectSchema, DiffSchema, DependentRelations, ComputablePermissions) for inspecting stored schema structure and permission dependencies."
---

import { Callout } from "nextra/components";
import { InlinePlayground } from "@/components/playground";

Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/relationships/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Relationships"
description: "How relationships work in SpiceDB: relationship syntax, graph traversals for permission checks, and strategies for writing and keeping them in sync."
---

import { Callout } from "nextra/components";

# Relationships
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/schema/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Schema Language Reference"
description: "Reference for the SpiceDB schema language: object type definitions, relations, permissions, arrows, wildcards, caveats, typechecking, and common patterns."
---

import { Callout } from "nextra/components";
import YouTube from "@/components/youtube-wrapper";
import { InlinePlayground } from "@/components/playground";
Expand Down
Loading
Loading