nscp/docs/mkdocs.yml at main · mickem/nscp · 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
124
site_name: NSClient++
site_url: https://nsclient.org
repo_url: https://github.com/mickem/nscp
repo_name: GitHub
edit_uri: blob/master/docs/docs
theme:
  name: 'material'
  custom_dir: 'custom_theme'
copyright: "NSClient++ is dual-licensed under Apache-2.0 OR GPL-2.0-only"
extra_css:
  - pygments.css
  - custom.css
extra:
  #disqus: 'your-disqus-shortname'
  palette:
    primary: 'indigo'
    accent: 'green'
  logo: images/FAVICON.PNG
  root_menu:
    title: 0.5.2
    link: version.md
    page: History
nav:
  - Home: index.md
  - Quick Start: quick-start.md
  - Concepts:
      - How NSClient++ Works: concepts/index.md
      - Checks In Depth: concepts/checks.md
      - Settings: concepts/settings.md
      - Permissions: concepts/permissions.md
  - Setup:
      - Installation: setup/installing.md
      - Securing NSClient++: setup/securing.md
      - Web Interface: setup/web-interface.md
  - Monitoring Scenarios:
      - Overview: scenarios/index.md
      - Windows Server Health: scenarios/windows-server-health.md
      - Linux Server Health: scenarios/linux-server-health.md
      - Disk Space Alerting: scenarios/disk-space.md
      - Service & Process Monitoring: scenarios/service-monitoring.md
      - Real-Time System Monitoring: scenarios/realtime-monitoring.md
      - Event Log Monitoring: scenarios/event-log.md
      - Performance Counters (PDH): scenarios/counters.md
      - SQL Server Monitoring: scenarios/sql-server.md
      - Network Checks: scenarios/network-checks.md
      - Host Security Posture: scenarios/security-posture.md
      - Active Monitoring with NRPE: scenarios/nrpe.md
      - Passive Monitoring (NSCA/NRDP): scenarios/passive-monitoring-nsca.md
      - Passive Monitoring (NSCA-NG): scenarios/passive-monitoring-nsca-ng.md
      - Passive Monitoring (Icinga 2): scenarios/passive-monitoring-icinga.md
      - Passive Monitoring (Graphite): scenarios/passive-monitoring-graphite.md
      - Checkmk Agent Integration: scenarios/check-mk.md
      - Prometheus Scraping: scenarios/prometheus.md
      - External Scripts: scenarios/external-scripts.md
  - Reference:
      - Reference: reference/index.md
      - Check commands:
        - CheckDisk: reference/check/CheckDisk.md
        - CheckExternalScripts: reference/check/CheckExternalScripts.md
        - CheckEventLog (Windows): reference/windows/CheckEventLog.md
        - CheckHelpers: reference/check/CheckHelpers.md
        - CheckLogFile: reference/check/CheckLogFile.md
        - CheckMKClient: reference/check/CheckMKClient.md
        - CheckMKServer: reference/check/CheckMKServer.md
        - CheckNet: reference/check/CheckNet.md
        - CheckNSCP: reference/check/CheckNSCP.md
        - CheckSecurity: reference/check/CheckSecurity.md
        - CheckSystem: reference/check/CheckSystem.md
        - CheckMSSQL (Windows): reference/windows/CheckMSSQL.md
        - CheckTaskSched (Windows): reference/windows/CheckTaskSched.md
        - CheckWMI (Windows): reference/windows/CheckWMI.md
      - Clients & Servers:
        - WEBServer: reference/generic/WEBServer.md
        - WEBClient: reference/misc/WEBClient.md
        - NRPEServer: reference/client/NRPEServer.md
        - NRPEClient: reference/client/NRPEClient.md
        - NSClientServer: reference/windows/NSClientServer.md
        - NSCAServer: reference/client/NSCAServer.md
        - NSCAClient: reference/client/NSCAClient.md
        - NRDPClient: reference/client/NRDPClient.md
        - IcingaClient: reference/client/IcingaClient.md
        - SMTPClient: reference/client/SMTPClient.md
        - GraphiteClient: reference/client/GraphiteClient.md
        - SyslogClient: reference/client/SyslogClient.md
        - CollectdClient: reference/misc/CollectdClient.md
        - Op5Client: reference/misc/Op5Client.md
        - ElasticClient: reference/misc/ElasticClient.md
      - Helper modules:
        - Scheduler: reference/generic/Scheduler.md
        - SimpleFileWriter: reference/generic/SimpleFileWriter.md
        - CommandClient: reference/generic/CommandClient.md
        - SimpleCache: reference/generic/SimpleCache.md
        - PythonScript: reference/generic/PythonScript.md
        - LUAScript: reference/generic/LUAScript.md
        - DotnetPlugins: reference/windows/DotnetPlugins.md
  - Extending:
      - Overview: extending/index.md
      - Python Scripts: extending/python.md
      - Zip Modules: extending/zip-modules.md
      - Plugin API Reference: extending/plugin-api.md
  - REST API:
      - Introduction: api/rest/index.md
      - Info: api/rest/info.md
      - Modules: api/rest/modules.md
      - Queries: api/rest/queries.md
      - Aliases: api/rest/aliases.md
      - Scripts: api/rest/scripts.md
      - Logs: api/rest/logs.md
      - Legacy API: api/rest/legacy.md
  - FAQ: faq.md

markdown_extensions:
  - admonition
  - codehilite
  - smarty
  - sane_lists
  - toc:
      permalink: true
  # Content tabs used by the reference docs to show differing Windows vs Linux
  # behaviour side-by-side (generated by scripts/python/docs_generate.py).
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true