Local setup
Verification RequiredStart here before running Stornamics first-success tutorials. This page separates the tools required for every local tutorial, the optional helpers that make output easier to inspect, and the product-specific tools needed for Rust, OpenTelemetry, and S3-style workflows.
These tools are the baseline for local tutorials. Product pages may add more requirements, but they should not assume less than this baseline.
| Tool | Used For | Check | Notes |
|---|---|---|---|
| Terminal shell | All local tutorials | pwd | Examples use a POSIX-style shell unless the tutorial explicitly lists a Windows or PowerShell variant. |
| Git | Repository checkout and source-relative commands | git --version | Use the repository root named in each tutorial before running source-relative commands. |
| Node.js and npm | Docs preview and Node-based examples | node --version && npm --version | Use the committed package lock for the docs site. A global Gatsby install is not required. |
| curl | HTTP startup, readiness, ingest, query, and cleanup checks | curl --version | Tutorials that use HTTP should include headers, request bodies, status checks, and expected response fields. |
These tools become required when a tutorial uses the matching product path or workflow. The tutorial itself should repeat the relevant checks near the first command that needs them.
| Tool | Used For | Check | Notes |
|---|---|---|---|
| Rust toolchain | Concordia and Rust-backed local binaries | rustc --version && cargo --version | Required only when a tutorial builds or runs a local Rust binary from source. |
| OpenTelemetry Collector | LogDB collector pipelines | otelcol --version or otelcol-contrib --version | Required when a tutorial sends telemetry through a collector. Curl-only LogDB tutorials can list it as optional. |
| AWS CLI or S3-compatible client | ObjectDB S3 Core workflows | aws --version or the client-specific version command | Use a local endpoint override and tutorial-scoped fake credentials. Do not assume real AWS account access. |
These helpers can make local work easier, but a tutorial should mark them optional unless its workflow depends on that tool.
| Tool | Used For | Check | Notes |
|---|---|---|---|
| jq | Readable JSON output | jq --version | Helpful for extracting IDs or fields from responses. Tutorials must still show how to verify success without hiding the response shape. |
| Docker or compatible container runtime | Tutorials that choose a containerized helper path | docker --version | Optional unless a specific tutorial marks a container as the recommended local service path. |
| HTTP client UI | Manual request inspection | n/a | Useful for exploration. Confirm manually that the client can send localhost requests, but keep canonical tutorial commands copy/paste friendly in the shell. |
Required here: curl, AWS CLI or S3-compatible client
Required here: curl
Required here: curl, OpenTelemetry Collector when the workflow uses it
Required here: Rust toolchain, curl for HTTP routes
Tutorials should target localhost or another explicitly named local endpoint unless the page has reviewed remote-environment instructions.
Startup steps should name the default port, the readiness check, and the documented way to choose another port when the default is already in use.
Buckets, streams, queues, tenants, datasets, keys, records, and local data directories should be tutorial-scoped so cleanup is narrow.
Examples should use fake local credentials, placeholders, or local bearer tokens that cannot be mistaken for reusable secrets.
A successful local tutorial proves the documented workflow and expected output. It does not expand product maturity, limits, or evidence status.
Standard
Tutorial standardsReview the required tutorial sections, command rules, expected output rules, cleanup, troubleshooting, evidence, and limits.
Products
Product chooserPick the product path that matches your first local workflow.