GeezerVison is showing github.com — netdata/.env.template at master · netdata/netdata

Expand file tree

.env.template

Copy path

More file actions

Latest commit

History

171 lines (152 loc) · 6.79 KB

.env.template

Copy path

File metadata and controls

171 lines (152 loc) · 6.79 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

# .env.template -- copy to .env and fill in.

# .env is gitignored; .env.template is committed.

# See <repo>/.agents/ENV.md for the full setup guide

# (where each value comes from, sample formats, common

# mistakes).

# Only fill in the keys you need. Each skill checks the

# specific keys it requires and exits with a clear message

# if any are missing.

# ---------------------------------------------------------------

# Netdata Cloud REST API

# ---------------------------------------------------------------

# Used by: query-netdata-cloud, query-netdata-agents,

# triage-agent-events, packaging/tools/automation/mcp

# (the build/run MCP server -- required by setup_mcp.py /

# ninja setup-mcp, and at runtime to mint per-agent bearers

# for the netdata_agent_<name> forwarding tools).

# NETDATA_CLOUD_TOKEN -- long-lived Cloud REST token.

# Get one at: https://app.netdata.cloud

# -> top-right user menu -> Settings -> API Tokens

# -> "Create API Token" with `scope:all` (or at least

# scope:grafana-plugin for read-only queries).

# Sample format: 36-char UUID-shaped token.

NETDATA_CLOUD_TOKEN=""

# NETDATA_CLOUD_HOSTNAME -- Cloud REST API host.

# Almost always app.netdata.cloud.

NETDATA_CLOUD_HOSTNAME="app.netdata.cloud"

# ---------------------------------------------------------------

# Netdata Cloud claiming (for the build-MCP auto-claim)

# ---------------------------------------------------------------

# Used by: packaging/tools/automation/mcp (the build/run MCP

# server). When NETDATA_CLAIM_TOKEN is set, every agent

# it launches claims itself to Netdata Cloud as an

# ephemeral node named mcp-<agent_id>. Leave blank to

# launch unclaimed (local + MCP access still work).

# Must be present in the MCP server's environment.

# NOTE: this server also requires NETDATA_CLOUD_TOKEN

# (above) -- setup_mcp.py / `ninja setup-mcp` fails

# without it, and it's used at runtime to mint per-agent

# Cloud bearers for the netdata_agent_<name> forwarding

# tools.

# NETDATA_CLAIM_TOKEN -- a Space claim token.

# Get one at: https://app.netdata.cloud -> Space settings

# -> Connect Nodes -> copy the --claim-token value

# from the kickstart command.

NETDATA_CLAIM_TOKEN=""

# NETDATA_CLAIM_ROOMS -- comma-separated Room id(s) for the node.

# Optional. The --claim-rooms value from the same dialog.

NETDATA_CLAIM_ROOMS=""

# NETDATA_CLAIM_URL -- Cloud base URL. Optional; defaults to

# https://app.netdata.cloud agent-side.

NETDATA_CLAIM_URL=""

# ---------------------------------------------------------------

# Cross-org repo mirror

# ---------------------------------------------------------------

# Used by: repo-mirror-sources (the sync script + path refs in

# integrations-lifecycle, docs-learn-site-structure, etc.).

# NETDATA_REPOS_DIR -- absolute path to the directory holding

# your local Netdata-org repos mirror. Will be created if you

# run sync-netdata-repos.sh on an empty parent.

# Sample: "$HOME/src/netdata"

NETDATA_REPOS_DIR=""

# ---------------------------------------------------------------

# agent-events ingestion node (for triage-agent-events skill)

# ---------------------------------------------------------------

# Used by: triage-agent-events (and by query-netdata-agents

# as the canonical example for direct-agent calls).

# AGENT_EVENTS_HOSTNAME -- network address of the ingestion node.

# Dual-duty: ssh host AND direct-HTTP host (port 19999). Can be

# a DNS name or an IP literal.

# NOTE: this is NOT the journalctl namespace (hardcoded to

# 'agent-events' on the ingestion server) and NOT the Cloud

# room name (also hardcoded to 'agent-events').

# Sample: "10.20.1.105" or "agent-events.example.org"

AGENT_EVENTS_HOSTNAME=""

# AGENT_EVENTS_NODE_ID -- the Cloud node UUID for the

# agent-events node. Find it by visiting the node in

# app.netdata.cloud and copying the UUID from the URL, or

# by listing nodes via the Cloud API.

AGENT_EVENTS_NODE_ID=""

# AGENT_EVENTS_MACHINE_GUID -- the Netdata machine GUID for

# the agent-events node. Find it on the host with:

# sudo cat /var/lib/netdata/registry/netdata.public.unique.id

AGENT_EVENTS_MACHINE_GUID=""

# ---------------------------------------------------------------

# Coverity Scan triage (for triage-coverity skill)

# ---------------------------------------------------------------

# Used by: triage-coverity. All four required.

# COVERITY_HOST -- the Coverity Scan host. For Netdata, this

# is scan4.scan.coverity.com (newer instance).

COVERITY_HOST="https://scan4.scan.coverity.com"

# COVERITY_PROJECT_ID -- the integer project id.

# Find it in the URL when you click your project in the

# Coverity Scan dashboard, e.g. ?projectId=12345

COVERITY_PROJECT_ID=""

# COVERITY_COOKIE -- the full Cookie header captured from a

# logged-in browser session. Open DevTools (F12) -> Network

# -> click any request to scan4.scan.coverity.com -> Headers

# -> Request Headers -> copy the entire Cookie value

# (including XSRF-TOKEN=...). Refresh roughly every 12-24h

# when keepalive.sh isn't running.

COVERITY_COOKIE=""

# COVERITY_VIEW_OUTSTANDING -- the integer viewId for your

# "Outstanding defects" view. Find it in the URL when you

# open that view, e.g. ?viewId=10001

COVERITY_VIEW_OUTSTANDING=""

# ---------------------------------------------------------------

# SonarCloud triage (for triage-sonarqube skill)

# ---------------------------------------------------------------

# Used by: triage-sonarqube. All four required.

# SONAR_HOST_URL -- the SonarCloud host.

SONAR_HOST_URL="https://sonarcloud.io"

# SONAR_ORG -- your sonarcloud.io organization key.

SONAR_ORG=""

# SONAR_PROJECT -- the projectKey of your project on SonarCloud.

# For Netdata: netdata_netdata

SONAR_PROJECT="netdata_netdata"

# SONAR_TOKEN -- a personal access token.

# Generate at: https://sonarcloud.io/account/security

SONAR_TOKEN=""

# ---------------------------------------------------------------

# Codacy Cloud (for triage-codacy skill)

# ---------------------------------------------------------------

# Used by: triage-codacy (pr-issues.sh and any v3 API wrapper).

# analyze-local.sh runs the CLI anonymously and does NOT need

# CODACY_TOKEN.

# CODACY_TOKEN -- Account API token. Header form is

# `api-token: <value>` (NOT Bearer).

# Get one at: https://app.codacy.com

# -> top-right avatar -> Account -> API tokens

# -> "Create API Token"

CODACY_TOKEN=""

# CODACY_HOST / CODACY_PROVIDER / CODACY_ORG / CODACY_REPO are

# all optional and default to api.codacy.com / gh / netdata /

# netdata. Override only if you point this skill at a different

# Codacy org or repo.

# CODACY_HOST="https://api.codacy.com"

# CODACY_PROVIDER="gh"

# CODACY_ORG="netdata"

# CODACY_REPO="netdata"