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
1 change: 0 additions & 1 deletion Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,6 @@ ColdBrew composes proven Go libraries — not replacements:
## Next Steps

- **[Getting Started](/getting-started)** — Create your first ColdBrew service
- **[Using ColdBrew](/using)** — Configure and extend your service
- **[How-To Guides](/howto)** — Step-by-step guides for common tasks
- **[Production Deployment](/howto/production)** — Kubernetes, health probes, tracing, and graceful shutdown
Comment thread
ankurs marked this conversation as resolved.
- **[Integrations](/integrations)** — Set up monitoring, tracing, and error tracking
Expand Down
131 changes: 0 additions & 131 deletions USING.md

This file was deleted.

34 changes: 33 additions & 1 deletion quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,39 @@ Three jobs in a single `test` stage:

Go module caching is enabled for faster builds.

## Configuration

ColdBrew uses environment variables for configuration. Common settings:

| Variable | Default | Description |
|----------|---------|-------------|
| `GRPC_PORT` | `9090` | gRPC server port |
| `HTTP_PORT` | `9091` | HTTP gateway port |
| `LOG_LEVEL` | `info` | Log level (debug, info, warn, error) |
| `JSON_LOGS` | `true` | JSON formatted logs |
| `ENVIRONMENT` | `""` | Environment name |
| `TRACE_HEADER_NAME` | `x-trace-id` | Header name for trace propagation |
| `NEW_RELIC_APPNAME` | `""` | New Relic application name |
| `NEW_RELIC_LICENSE_KEY` | `""` | New Relic license key |
| `SENTRY_DSN` | `""` | Sentry DSN for error tracking |

See the **[Configuration Reference](/config-reference)** for the complete list of 40+ environment variables including gRPC keepalive, TLS, OpenTelemetry OTLP, Prometheus histogram buckets, and graceful shutdown tuning.

## Adding Interceptors

ColdBrew comes with a comprehensive set of [interceptors](/howto/interceptors) pre-configured. To add custom interceptors:

```go
import "github.com/go-coldbrew/interceptors"

func init() {
interceptors.AddUnaryServerInterceptor(myCustomInterceptor)
Comment thread
ankurs marked this conversation as resolved.
}
```

{: .warning }
Interceptor configuration functions must be called during `init()` — they are not safe for concurrent use.

## What's Built In (You Didn't Have to Configure)

Everything below was set up automatically by ColdBrew:
Expand Down Expand Up @@ -463,7 +496,6 @@ Your service starts on `:9090` (gRPC) and `:9091` (HTTP) with metrics, health ch

## Next Steps

- **[Using ColdBrew](/using)** — Configure ports, environment variables, and interceptors
- **[How-To Guides](/howto)** — Tracing, logging, metrics, error handling, and more
- **[Production Deployment](/howto/production)** — Kubernetes manifests, health probes, tracing, and graceful shutdown
- **[Integrations](/integrations)** — Connect New Relic, Prometheus, Sentry, Jaeger
Expand Down
1 change: 0 additions & 1 deletion tests/navigation.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import { test, expect } from "@playwright/test";
const topLevelPages = [
{ path: "/", title: "ColdBrew" },
{ path: "/getting-started/", title: "Getting Started" },
{ path: "/using/", title: "Using ColdBrew" },
{ path: "/architecture/", title: "Architecture" },
{ path: "/howto/", title: "How To" },
{ path: "/integrations/", title: "Integrations" },
Expand Down
Loading