Skip to content

Improve local development credential documentation #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve local development credential documentation #402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f98e8bb
Clarify local development security settings for non-localhost scenarios
ivanauth Oct 18, 2025
5db994c
Improve local development credential documentation
ivanauth Oct 23, 2025
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
13 changes: 13 additions & 0 deletions pages/spicedb/getting-started/client-libraries.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ the primary documentation for the gRPC API is in the [buf documentation] for Spi
The gRPC client documentation associated with each host language will also be helpful for putting together invocations.
Additionally, there are `example` directories in the client libraries that provide example usages.

## Local Development

When developing locally with SpiceDB running without TLS, you'll need to configure insecure credentials:

- **Node.js**: `v1.ClientSecurity.INSECURE_PLAINTEXT_CREDENTIALS`
- **Python**: `insecure_bearer_token_credentials()`
- **Go**: `grpcutil.WithInsecureBearerToken()` and `grpc.WithTransportCredentials(insecure.NewCredentials())`
- **Ruby**: `credentials: :this_channel_is_insecure`
- **Java**: `.usePlaintext()`
- **Dotnet**: `ChannelCredentials.Insecure` with `UnsafeUseInsecureChannelCallCredentials = true`

See the [Protecting a Blog Application](./protecting-a-blog#checking-permissions) guide for examples.

## HTTP Clients

SpiceDB exposes an HTTP API when run with the `--http-enabled` flag.
Expand Down
14 changes: 13 additions & 1 deletion pages/spicedb/getting-started/protecting-a-blog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,6 +730,18 @@ When doing a permission check, in order to get read-after-write consistency, you

The following examples demonstrate the transitive property of checks:

<Callout type="info">
When developing locally with SpiceDB without TLS, use insecure credentials in your client library:
- **Node.js**: `INSECURE_PLAINTEXT_CREDENTIALS`
- **Python**: `insecure_bearer_token_credentials()`
- **Go**: `grpcutil.WithInsecureBearerToken()` and `grpc.WithTransportCredentials(insecure.NewCredentials())`
- **Ruby**: `credentials: :this_channel_is_insecure`
- **Java**: `.usePlaintext()`
- **Dotnet**: `ChannelCredentials.Insecure` with `UnsafeUseInsecureChannelCallCredentials = true`

This applies to localhost, Docker, Orbstack, and other local environments. Always switch to secure credentials before production deployment.
</Callout>

<Tabs items={['zed', 'Node', 'Go', 'Python', 'Ruby', 'Java']}>
<Tabs.Tab>

Expand All @@ -749,7 +761,7 @@ import { v1 } from '@authzed/authzed-node';
const { promises: client } = v1.NewClient(
't_your_token_here_1234567deadbeef',
'grpc.authzed.com:50051',
// NOTE: Remove if SpiceDB is behind TLS
// For local development without TLS
v1.ClientSecurity.INSECURE_PLAINTEXT_CREDENTIALS
);

Expand Down
Loading