nview/config.yaml.example at main · blinklabs-io/nview · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
---
# Example config file for nview
# The values shown below correspond to the in-code defaults

app:
  # Display name for the node
  #
  # This can also be set via the NODE_NAME environment variable
  nodeName: Cardano Node

  # Named Cardano network for the node
  #
  # This is a short-cut to select the NetworkMagic and can be used to
  # select mainnet, preprod, preview, musashi, or sancho networks.
  #
  # This can also be set via the NETWORK environment variable and overrides
  # the node specific setting below
  network:

node:
  # Name of the node you are running.
  #
  # Valid values are:
  # - `amaru`
  # - `cardano-node`
  # - `dingo`
  #
  # This can also be set via the CARDANO_NODE_BINARY environment variable
  binary: cardano-node

  # Named Cardano network for the node
  #
  # This is a short-cut to select the NetworkMagic and can be used to
  # select mainnet, preprod, preview, musashi, or sancho networks.
  #
  # This can also be set via the CARDANO_NETWORK environment variable
  network: mainnet

  # NetworkMagic for network for the node
  #
  # This selects the correct network for operation and can be configured to
  # any network, not just the named networks.
  #
  # This can also be set via the CARDANO_NODE_NETWORK_MAGIC environment
  # variable
  networkMagic:

  # Port for the node
  #
  # Listening port for the node for NtN communication.
  #
  # This can also be set via the CARDANO_PORT environment variable
  port: 3001

  # Path to the PID file for the node
  #
  # This is only used when the `binary` value is `amaru`.
  # Otherwise it is ignored.
  #
  # This can also be set via the CARDANO_NODE_PID_FILE environment variable
  pidFile:

  # PID for the node process
  #
  # When set to a non-zero value, this bypasses all automatic PID detection
  # mechanisms and directly uses the specified PID for process metrics.
  #
  # - For cardano-node: Bypasses name/port-based detection
  # - For Dingo: Overrides the default PID 1 (when set to non-zero)
  # - For Amaru: Skips reading from pidFile and uses this PID directly
  #
  # This can also be set via the CARDANO_NODE_PID environment variable
  pid: 0

prometheus:
  # host/port for the node Prometheus metrics
  #
  # These can also be set via the PROM_HOST and PROM_PORT environment variables
  host: 127.0.0.1
  port: 12798

  # Timeout for connections to the node
  #
  # This can also be set via the PROM_TIMEOUT environment variable
  timeout: 3

# Example configurations for different node implementations:
#
# For Dingo:
# node:
#   binary: dingo
#   network: mainnet
#
# For Dingo with custom PID:
# node:
#   binary: dingo
#   network: mainnet
#   pid: 1234  # Override default PID 1
#
# For Amaru:
# node:
#   binary: amaru
#   network: mainnet
#   pidFile: /path/to/amaru.pid  # Required for Amaru
#
# For Amaru with direct PID (skips pidFile):
# node:
#   binary: amaru
#   network: mainnet
#   pid: 5678  # Use this PID directly, ignore pidFile
#
# For cardano-node with direct PID:
# node:
#   binary: cardano-node
#   network: mainnet
#   port: 3001
#   pid: 9999  # Bypass name/port detection
#
# For custom Prometheus port:
# prometheus:
#   host: 127.0.0.1
#   port: 9090
#   timeout: 5