Local setup
Private BetaStart 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 setup each product path asks you to confirm before the first command.
These tools are the baseline for local tutorials. Product pages repeat any extra package, container, SDK, or collector requirement near the first command that needs it.
| 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. |
| 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 |
|---|---|---|---|
| Container runtime | ObjectDB beta container quickstart | docker --version or the runtime-specific version command | Required when the quickstart starts a local product container. Use tutorial-scoped names and remove created state during cleanup. |
| Message Broker CLI | Message Broker private beta local node | mq --version | Required for the packaged local broker quickstart. The tutorial names the beta package and local data directory before startup. |
| Rust toolchain | Rust SDK examples | rustc --version && cargo --version | Required only when an example or guide builds Rust SDK code. Product quickstarts name a package or container path when one is available. |
| 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. |
| 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, Container runtime, AWS CLI or S3-compatible client
Required here: curl, Message Broker CLI
Required here: curl, OpenTelemetry Collector when the workflow uses it
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 review status.
Tutorials
Start a tutorialPick an ObjectDB, Message Broker, or LogDB path and run the product-specific setup from that page.
Products
Product chooserPick the product path that matches your first local workflow.