You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The `APP_NILAUTH_INSTANCES` variable configures which nilauth instances this node trusts for builder authentication. Each instance is specified as `baseUrl/publicKey`, with multiple instances separated by commas.
| OTEL_ENDPOINT | OTLP endpoint URL |http://localhost| No |
66
67
| OTEL_SERVICE_NAME | Service name for telemetry | nildb | No |
67
68
| OTEL_TEAM_NAME | Team responsible for the service | nildb | No |
@@ -95,6 +96,7 @@ Values set via `OTEL_RESOURCE_ATTRIBUTES` take precedence over programmatically
95
96
**Disabling OpenTelemetry SDK:**
96
97
97
98
To disable OpenTelemetry SDK and prevent telemetry emission while keeping the `otel` feature flag enabled, set the following environment variable:
99
+
98
100
```bash
99
101
OTEL_SDK_DISABLED=true
100
102
```
@@ -113,6 +115,7 @@ docker compose -f local/docker-compose.yaml up -d
113
115
```
114
116
115
117
This stack includes:
118
+
116
119
-**nilDB**: The main API service (port 40080, metrics port 40091)
117
120
-**MongoDB**: Database backend (port 40017)
118
121
-**nilauth**: Authentication service for NUC tokens (port 40921)
@@ -124,6 +127,7 @@ This stack includes:
124
127
The nilDB API will be available at `http://localhost:40080`.
125
128
126
129
The local stack is configured with `APP_ENABLED_FEATURES=openapi,otel,migrations`, which means:
130
+
127
131
- Metrics, traces, and logs are sent to the OTel Collector (visible in `docker compose logs otel-collector`)
128
132
- No `/metrics` endpoint is exposed (OTLP push only)
129
133
@@ -176,6 +180,7 @@ The following endpoints provide operational information:
176
180
177
181
> ![NOTE]
178
182
> The `/metrics` endpoint behavior depends on feature flags:
183
+
>
179
184
> -**`metrics` only**: Serves metrics at `:9091/metrics` using OpenTelemetry PrometheusExporter
180
185
> -**`otel` enabled**: No `/metrics` endpoint; all telemetry pushed to OTLP collector
181
186
>
@@ -225,8 +230,8 @@ For user-facing operations, there is an OpenAPI documentation interface hosted a
225
230
226
231
Configure MongoDB with the following backup/snapshot policy. This policy applies to both MongoDB Atlas and self-hosted MongoDB. Details specific to each are mentioned further below.
227
232
228
-
* Full hourly snapshots with 1-day retention
229
-
* Full daily snapshots with 7-day retention; configured snapshot time: 04:00 UTC
233
+
- Full hourly snapshots with 1-day retention
234
+
- Full daily snapshots with 7-day retention; configured snapshot time: 04:00 UTC
Copy file name to clipboardExpand all lines: docs/build-on-nildb.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,6 @@ This section outlines specific builder-related tasks and is deliberately utilita
6
6
7
7
An OpenAPI documentation site is available at `{APP_NODE_PUBLIC_ENDPOINT}/openapi.json` when the node is running and the `openapi-spec` feature is enabled.
8
8
9
-
10
9
## Running nilDB Locally
11
10
12
11
### Quick Start
@@ -20,7 +19,7 @@ docker compose -f local/docker-compose.yaml up -d
20
19
This starts a single nilDB node along with all required supporting services:
> ![NOTE] Data encryption is applied using [nilQL-ts](https://github.com/nillionnetwork/nilql-ts) or [nilQL-py](https://github.com/nillionnetwork/nilql-py) before transmission.
68
+
> ![NOTE] Data encryption is applied using [nilQL-ts](https://github.com/nillionnetwork/nilql-ts) or [nilQL-py](https://github.com/nillionnetwork/nilql-py) before transmission.
0 commit comments