forked from librenms/librenms
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
267 lines (257 loc) · 9.97 KB
/
mkdocs.yml
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
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
site_name: LibreNMS Docs
docs_dir: doc
theme:
name: material
logo: img/librenms.svg
language: en
font:
text: 'Roboto'
code: 'Roboto Mono'
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
accent: indigo
toggle:
icon: material/lightbulb-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/lightbulb
name: Switch to light mode
features:
- navigation.instant
- navigation.sections
- navigation.tracking
- navigation.top
- content.tabs.link
site_dir: out
site_url: https://docs.librenms.org
markdown_extensions:
- tables
- admonition
- pymdownx.tasklist
- pymdownx.tilde
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
- pymdownx.highlight:
extend_pygments_lang:
- name: php
lang: php
options:
startinline: true
plugins:
- macros:
j2_variable_start_string: '@='
j2_variable_end_string: '=@'
- search
- exclude:
glob:
- "General/Changelogs/*"
- "Dockerfile"
- redirects:
redirect_maps:
'Alerting/Introduction.md': 'Alerting/index.md'
'API/API-Docs.md': 'API/index.md'
'Extensions/Alerting.md': 'Alerting/index.md'
'Extensions/Email-Alerting.md': 'Alerting/Transports.md'
'Extensions/Graphite.md': 'Extensions/metrics/Graphite.md'
'Extensions/InfluxDB.md': 'Extensions/metrics/InfluxDB.md'
'Extensions/OpenTSDB.md': 'Extensions/metrics/OpenTSDB.md'
'Extensions/Poller-Service.md': 'Extensions/Dispatcher-Service.md'
'Extensions/Port-Description-Parser.md': 'Extensions/Interface-Description-Parsing.md'
'Extensions/Prometheus.md': 'Extensions/metrics/Prometheus.md'
'General/Contributing.md': 'Developing/Getting-Started.md'
'Installation/CentOS-image.md': 'Installation/Images.md'
'Installation/index.md': 'Installation/Install-LibreNMS.md'
'Installation/Installing-LibreNMS.md': 'Installation/Install-LibreNMS.md'
'Installation/Ubuntu-image.md': 'Installation/Images.md'
'Support/Support-New-OS.md': 'Developing/Support-New-OS.md'
- minify:
minify_html: true
minify_js: true
minify_css: true
htmlmin_opts:
remove_comments: true
js_files:
- js/docs-settings-links.js
css_files:
- librenms.css
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css
- librenms.css
extra_javascript:
- js/docs-settings-links.js
extra:
analytics:
provider: google
property: UA-79149977-2
article_nav_top: false
article_nav_bottom: true
php:
version_min: 8.1
site_author: LibreNMS
site_description: LibreNMS user and developer documentation
repo_url: https://github.com/librenms/librenms/
edit_uri: edit/master/doc
repo_name: GitHub
nav:
- General:
- Home: index.md
- Features: Support/Features.md
- Changelog: General/Changelog.md
- Welcome to Observium users: General/Welcome-to-Observium-users.md
- 3rd Party Libraries: General/Acknowledgement.md
- Installing:
- Installing LibreNMS: Installation/Install-LibreNMS.md
- Other Methods:
- Docker: Installation/Docker.md
- Virtual machines: Installation/Images.md
- Older guides:
- RHEL / CentOS 6: Installation/Installation-CentOS-6-Apache-Nginx.md
- RHEL / CentOS 7 - Apache: Installation/Installation-CentOS-7-Apache.md
- RHEL / CentOS 7 - Nginx: Installation/Installation-CentOS-7-Nginx.md
- Ubuntu 16.04 - Apache: Installation/Installation-Ubuntu-1604-Apache.md
- Ubuntu 16.04 - Nginx: Installation/Installation-Ubuntu-1604-Nginx.md
- Ubuntu 18.04 - Apache: Installation/Installation-Ubuntu-1804-Apache.md
- Ubuntu 18.04 - Nginx: Installation/Installation-Ubuntu-1804-Nginx.md
- Choosing a release: General/Releases.md
- Updating: General/Updating.md
- Getting started:
- Adding a device: Support/Adding-a-Device.md
- Grouping Devices: Extensions/Device-Groups.md
- Submitting stats: General/Callback-Stats-and-Privacy.md
- Migrating from Observium: Installation/Migrating-from-Observium.md
- Setup:
- Applications: Extensions/Applications.md
- Billing Module: Extensions/Billing-Module.md
- Check_MK Setup: Extensions/Agent-Setup.md
- Dashboards: Extensions/Dashboards.md
- Interface Description Parsing: Extensions/Interface-Description-Parsing.md
- Network Map: Extensions/Network-Map.md
- Syslog: Extensions/Syslog.md
- World Map: Extensions/World-Map.md
- Advanced Setup:
- 1 Minute Polling: Support/1-Minute-Polling.md
- Authentication Options: Extensions/Authentication.md
- Auto-discovery Setup: Extensions/Auto-Discovery.md
- Bare Dashboard: Support/Bare-Dashboard.md
- Cleanup Options: Support/Cleanup-options.md
- Configuration Docs: Support/Configuration.md
- Customizing the Web UI: Extensions/Customizing-the-Web-UI.md
- Dispatcher Service (RC): Extensions/Dispatcher-Service.md
- Environment Variables: Support/Environment-Variables.md
- Fast Ping Checking: Extensions/Fast-Ping-Check.md
- Galera Database Cluster: Extensions/Galera-Cluster.md
- IRC Bot Extensions: Extensions/IRC-Bot-Extensions.md
- IRC Bot: Extensions/IRC-Bot.md
- Oauth/SAML support: Extensions/OAuth-SAML.md
- RRDCached: Extensions/RRDCached.md
- RRDTune: Extensions/RRDTune.md
- Scaling LibreNMS: Extensions/Distributed-Poller.md
- SNMP Proxy: Extensions/SNMP-Proxy.md
- SNMP Trap Handler: Extensions/SNMP-Trap-Handler.md
- Sub-directory Support: Extensions/Sub-Directory.md
- Two-Factor Auth: Extensions/Two-Factor-Auth.md
- Varnish: Extensions/Varnish.md
- Alerting:
- Introduction: Alerting/index.md
- Setup:
- Rules: Alerting/Rules.md
- Templates: Alerting/Templates.md
- Transports: Alerting/Transports.md
- Creating Transports: Alerting/Creating-Transport.md
- Entities: Alerting/Entities.md
- Macros: Alerting/Macros.md
- Testing: Alerting/Testing.md
- Device Dependencies: Alerting/Device-Dependencies.md
- 3rd Party Integration:
- Integrations:
- Gateone: Extensions/Gateone.md
- Graylog: Extensions/Graylog.md
- Nagios Plugins: Extensions/Services.md
- NFSen: Extensions/NFSen.md
- Oxidized: Extensions/Oxidized.md
- PeeringDB: Extensions/PeeringDB.md
- Proxmox: Extensions/Proxmox.md
- Rancid: Extensions/Rancid.md
- Smokeping: Extensions/Smokeping.md
- Weathermap: Extensions/Weathermap.md
- Storing Metrics:
- Intro: Extensions/Metric-Storage.md
- Graphite: Extensions/metrics/Graphite.md
- InfluxDB: Extensions/metrics/InfluxDB.md
- OpenTSDB: Extensions/metrics/OpenTSDB.md
- Prometheus: Extensions/metrics/Prometheus.md
- API:
- Using the API: API/index.md
- Endpoints:
- Alerts: API/Alerts.md
- ARP: API/ARP.md
- Bills: API/Bills.md
- DeviceGroups: API/DeviceGroups.md
- Devices: API/Devices.md
- Inventory: API/Inventory.md
- Locations: API/Locations.md
- Logs: API/Logs.md
- Port_Groups: API/Port_Groups.md
- PortGroups: API/PortGroups.md
- Ports: API/Ports.md
- Routing: API/Routing.md
- Services: API/Services.md
- Switching: API/Switching.md
- System: API/System.md
- Getting help:
- How to get help: Support/index.md
- FAQ: Support/FAQ.md
- Install Validation: Support/Install Validation.md
- Performance: Support/Performance.md
- Discovery Support: Support/Discovery Support.md
- Poller Support: Support/Poller Support.md
- Example Hardware Setups: Support/Example-Hardware-Setup.md
- Remote Monitoring VPN: Support/Remote-Monitoring-VPN.md
- SNMP Configuration Examples: Support/SNMP-Configuration-Examples.md
- Device Troubleshooting: Support/Device-Troubleshooting.md
- Device Sensors: Support/Device-Sensors.md
- Contributing + Developing:
- Contributing:
- Getting Started: Developing/Getting-Started.md
- Using Git: Developing/Using-Git.md
- Validating Code: Developing/Validating-Code.md
- Code Structure: Developing/Code-Structure.md
- Creating Documentation: Developing/Creating-Documentation.md
- Component: Extensions/Component.md
- Support for a new OS:
- Intro: Developing/Support-New-OS.md
- Initial Detection: Developing/os/Initial-Detection.md
- Mem/CPU Information: Developing/os/Mem-CPU-Information.md
- Test Units: Developing/os/Test-Units.md
- Health Information: Developing/os/Health-Information.md
- Wireless Sensors: Developing/os/Wireless-Sensors.md
- Custom Graphs: Developing/os/Custom-Graphs.md
- Settings: Developing/os/Settings.md
- Sensor State Support: Developing/Sensor-State-Support.md
- SNMP Traps: Developing/SNMP-Traps.md
- Dynamic Config: Developing/Dynamic-Config.md
- Plugin System: Extensions/Plugin-System.md
- Developer notes:
- Merging Pull Requests: Developing/Merging-Pull-Requests.md
- Creating Release: Developing/Creating-Release.md
- Applications: Developing/Application-Notes.md
- Miscellaneous:
- Security information: General/Security.md
- CLI Scripts: Support/CLI-Tools.md
- Device Notes:
- Asuswrt-Merlin: Support/Device-Notes/AsuswrtMerlin.md
- Carel pCOweb: Support/Device-Notes/Carel-pCOweb-Devices.md
- Dell OpenManage: Extensions/Dell-OpenManage.md
- OpenWRT: Support/Device-Notes/Openwrt.md
- RouterOS: Support/Device-Notes/Routeros.md
- Supermicro: Extensions/Supermicro.md