Skip to content
Open
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/authzed-materialize/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "AuthZed Materialize"
description: "A service that precomputes permissions to speed up checks and lookups, with WatchPermissionSets and LookupPermissionSets APIs."
---

import { Callout } from "nextra/components";

# AuthZed Materialize
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
5 changes: 5 additions & 0 deletions app/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
9 changes: 5 additions & 4 deletions app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,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/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 Docs
description: "Documentation for SpiceDB and AuthZed products, covering schema design, APIs, datastores, consistency, deployment, and authorization concepts."
---

Browse documentation for **SpiceDB** or **AuthZed Products** by selecting one below.
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/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
5 changes: 5 additions & 0 deletions app/spicedb/concepts/watch/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Watching Relationship Changes"
description: "Use SpiceDB's streaming Watch API to monitor relationship creates, touches, and deletes, including historical updates, checkpoints, and transaction metadata."
---

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

Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/concepts/zanzibar/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Google Zanzibar"
description: "The history and significance of Google Zanzibar, the ReBAC authorization system SpiceDB is based on, and how SpiceDB differs from it."
---

import YouTube from "@/components/youtube-wrapper";
import ObjectTypeDiagram from "@/public/images/object-type-regex.svg";
import ObjectIDDiagram from "@/public/images/object-id-regex.svg";
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/getting-started/client-libraries/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Official Client Libraries"
description: "AuthZed's official gRPC client libraries for SpiceDB in Go, Node, Python, Ruby, Java, and .NET, plus HTTP client and local development setup."
---

import { Tabs } from "nextra/components";

# Official Client Libraries
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/getting-started/coming-from/cancancan/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "SpiceDB for Ruby on Rails CanCanCan users"
description: "How SpiceDB differs from the Ruby on Rails CanCanCan gem across models, data, and engine, and when to choose each for authorization."
---

import { Callout } from "nextra/components";
import PSDLight from "@/public/images/ps-light.svg";
import PSDDark from "@/public/images/ps-dark.svg";
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/getting-started/coming-from/opa/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "SpiceDB for Open Policy Agent (OPA) users"
description: "How SpiceDB differs from Open Policy Agent across models, data, and engine, and when to choose a database over a policy engine for authorization."
---

import { Callout } from "nextra/components";
import PSDLight from "@/public/images/ps-light.svg";
import PSDDark from "@/public/images/ps-dark.svg";
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/getting-started/configuration/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Configuring SpiceDB"
description: "Ways to configure SpiceDB at runtime: command-line flags, environment variables, operator config, spicedb.env dotenv files, and their order of precedence."
---

import { Tabs } from "nextra/components";

# Configuring SpiceDB
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/getting-started/discovering-spicedb/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "SpiceDB Documentation"
description: "Overview of SpiceDB, the open-source Google Zanzibar-inspired database for application permissions, its history, and its core features."
---

import { Cards } from "nextra/components";
import { faQuestion, faHand, faDollarSign } from "@fortawesome/free-solid-svg-icons";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/getting-started/faq/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Frequently-asked Questions"
description: "Answers to common SpiceDB questions on open-source licensing, IT infrastructure, policy engines, filtering resources by access, and getting involved."
---

# Frequently-asked Questions

## Is SpiceDB Open Source?
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/getting-started/first-steps/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "First steps"
description: "A guided starting path for SpiceDB: learn core concepts, watch videos, try the Playground, install the toolchain, and go to production."
---

import { Cards, Steps } from "nextra/components";
import YouTube from "@/components/youtube-wrapper";
import {
Expand Down
5 changes: 5 additions & 0 deletions app/spicedb/getting-started/install/debian/page.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Installing SpiceDB on Ubuntu or Debian"
description: "How to install SpiceDB on Debian-based Linux using apt-get, snap packages, or a manual binary download for AMD64 and ARM64."
---

import { Callout } from "nextra/components";

# Installing SpiceDB on Ubuntu or Debian
Expand Down
Loading
Loading