From 62fb181920a80ae5e5889a47999aa13806ee6e0e Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@unibe.ch>
Date: Thu, 31 Oct 2024 15:18:36 +0100
Subject: [PATCH] fix starting h1
---
docs/20_Checks/_index.md | 7 --
docs/20_Checks/about.md | 4 +-
docs/20_Checks/check_apache_requests.md | 4 +-
docs/20_Checks/check_ceph_diskfree.md | 6 +-
docs/20_Checks/check_ceph_io.md | 6 +-
docs/20_Checks/check_ceph_osd.md | 4 +-
docs/20_Checks/check_ceph_status.md | 4 +-
docs/20_Checks/check_clientbackup.md | 4 +-
docs/20_Checks/check_couchdb.md | 4 +-
docs/20_Checks/check_cpu.md | 6 +-
docs/20_Checks/check_cronstatus.md | 4 +-
docs/20_Checks/check_disk_io.md | 4 +-
docs/20_Checks/check_dns_responsetime.md | 4 +-
docs/20_Checks/check_docker_info.md | 4 +-
docs/20_Checks/check_docker_stats.md | 4 +-
docs/20_Checks/check_dockercontainer_top.md | 4 +-
docs/20_Checks/check_eol.md | 20 +++---
docs/20_Checks/check_fs_errors.md | 4 +-
docs/20_Checks/check_fs_writable.md | 4 +-
docs/20_Checks/check_gitlab_tokens.md | 4 +-
docs/20_Checks/check_haproxy_health.md | 4 +-
docs/20_Checks/check_haproxy_status.md | 4 +-
docs/20_Checks/check_http.md | 4 +-
docs/20_Checks/check_iml_backup_server.md | 4 +-
docs/20_Checks/check_journallog.md | 4 +-
docs/20_Checks/check_memory.md | 6 +-
docs/20_Checks/check_mysqlserver.md | 4 +-
docs/20_Checks/check_netio.md | 6 +-
docs/20_Checks/check_netstat.md | 4 +-
docs/20_Checks/check_onehost.md | 4 +-
docs/20_Checks/check_onevm.md | 4 +-
docs/20_Checks/check_opencpu.md | 4 +-
docs/20_Checks/check_packages2install.md | 4 +-
docs/20_Checks/check_php-fpm-status.md | 6 +-
docs/20_Checks/check_proc_mem.md | 4 +-
docs/20_Checks/check_proc_ressources.md | 4 +-
docs/20_Checks/check_proc_zombie.md | 4 +-
docs/20_Checks/check_psqlserver.md | 4 +-
docs/20_Checks/check_rearbackup.md | 4 +-
docs/20_Checks/check_reboot_required.md | 4 +-
docs/20_Checks/check_requirements.md | 4 +-
docs/20_Checks/check_smartstatus.md | 4 +-
docs/20_Checks/check_snmp_data.md | 4 +-
docs/20_Checks/check_snmp_synology.md | 4 +-
docs/20_Checks/check_ssl_certs.md | 4 +-
docs/20_Checks/check_systemdunit.md | 4 +-
docs/20_Checks/fix_h1.sh | 54 +++++++++++++++
docs/20_Checks/zz_template_check_.md | 6 +-
docs/30_Shared_functions/_index.md | 5 ++
.../inc_pluginfunctions.md | 4 +-
docs/_index.md | 4 +-
docs/style.css | 67 +++++++++++++------
52 files changed, 178 insertions(+), 177 deletions(-)
create mode 100755 docs/20_Checks/fix_h1.sh
create mode 100644 docs/30_Shared_functions/_index.md
rename docs/{20_Checks => 30_Shared_functions}/inc_pluginfunctions.md (99%)
diff --git a/docs/20_Checks/_index.md b/docs/20_Checks/_index.md
index 9187142..53a6c04 100644
--- a/docs/20_Checks/_index.md
+++ b/docs/20_Checks/_index.md
@@ -1,10 +1,3 @@
-# Checks
-
-## Shared functions
-
-There is one include script used by all checks:
-[inc_pluginfunctions](inc_pluginfunctions.md)
-
## Check scripts
* [about](about.md)
diff --git a/docs/20_Checks/about.md b/docs/20_Checks/about.md
index 4012e25..4cd1d41 100644
--- a/docs/20_Checks/about.md
+++ b/docs/20_Checks/about.md
@@ -1,6 +1,6 @@
-# About
+## About
-## Introduction
+Script: `about`
This check shows a short summary for the current system.
Its status is always OK.
diff --git a/docs/20_Checks/check_apache_requests.md b/docs/20_Checks/check_apache_requests.md
index e5eab23..8b80c1d 100644
--- a/docs/20_Checks/check_apache_requests.md
+++ b/docs/20_Checks/check_apache_requests.md
@@ -1,6 +1,6 @@
-# Check_apache_requests
+## Check_apache_requests
-## Introduction
+Script: `check_apache_requests`
After requesting the apache servre status page you get
diff --git a/docs/20_Checks/check_ceph_diskfree.md b/docs/20_Checks/check_ceph_diskfree.md
index 811cf5c..cbe5b0e 100644
--- a/docs/20_Checks/check_ceph_diskfree.md
+++ b/docs/20_Checks/check_ceph_diskfree.md
@@ -1,8 +1,8 @@
-# Check Ceph diskfree
+## Check Ceph diskfree
-## Introduction
+Script: `check_ceph_diskfree`
-**check_ceph_diskfree** is a plugin to show the available and free diskspace.
+It is a plugin to show the available and free diskspace.
It returns a single line for the status, data and performance data.
## Requirements
diff --git a/docs/20_Checks/check_ceph_io.md b/docs/20_Checks/check_ceph_io.md
index 550b7cf..dfc6744 100644
--- a/docs/20_Checks/check_ceph_io.md
+++ b/docs/20_Checks/check_ceph_io.md
@@ -1,8 +1,8 @@
-# Check Ceph IO
+## Check Ceph IO
-## Introduction
+Script: `check_ceph_io`
-**check_ceph_io** is a plugin to show read and written bytes per second.
+It is a plugin to show read and written bytes per second.
It returns a single line for the status and performance data.
## Requirements
diff --git a/docs/20_Checks/check_ceph_osd.md b/docs/20_Checks/check_ceph_osd.md
index 5c4bf60..de1d49c 100644
--- a/docs/20_Checks/check_ceph_osd.md
+++ b/docs/20_Checks/check_ceph_osd.md
@@ -1,6 +1,6 @@
-# Check Ceph OSDs
+## Check Ceph OSDs
-## Introduction
+Script: `check_ceph_osd`
Show cheph osd status: how many OSDs exist and how many are up/ down.
This check sends performance data.
diff --git a/docs/20_Checks/check_ceph_status.md b/docs/20_Checks/check_ceph_status.md
index e4e8d41..4f45b73 100644
--- a/docs/20_Checks/check_ceph_status.md
+++ b/docs/20_Checks/check_ceph_status.md
@@ -1,6 +1,6 @@
-# Check Ceph Status
+## Check Ceph Status
-## Introduction
+Script: `check_ceph_statusbb`
**check_ceph_status** is a plugin to show ceph status.
It switches the state in dependency of the HEALTH_* value.
diff --git a/docs/20_Checks/check_clientbackup.md b/docs/20_Checks/check_clientbackup.md
index b4dae32..727f171 100644
--- a/docs/20_Checks/check_clientbackup.md
+++ b/docs/20_Checks/check_clientbackup.md
@@ -1,6 +1,6 @@
-# Check Client backup
+## Check Client backup
-## Introduction
+Script: `check_clientbackup`
**check_client_backup** is a plugin to show the backup status of IML Backup.
diff --git a/docs/20_Checks/check_couchdb.md b/docs/20_Checks/check_couchdb.md
index eb6cd51..ce672b0 100644
--- a/docs/20_Checks/check_couchdb.md
+++ b/docs/20_Checks/check_couchdb.md
@@ -1,6 +1,6 @@
-# check_couchdb
+## Check_couchdb
-## Introduction
+Script: `check_couchdb`
Check couchdb status.
diff --git a/docs/20_Checks/check_cpu.md b/docs/20_Checks/check_cpu.md
index d59c2cd..9133cb3 100644
--- a/docs/20_Checks/check_cpu.md
+++ b/docs/20_Checks/check_cpu.md
@@ -1,8 +1,8 @@
-# check CPU
+## Check CPU
-## Introduction
+Script: `check_cpu`
-**check_cpu** is a plugin to check cpu usage and cpu io wait.
+It is a plugin to check cpu usage and cpu io wait.
It reads cpu data from output of top command and shows
hwi - Time spent handling hardware interrupt routines. (Whenever a peripheral unit want attention form the CPU, it literally pulls a line, to signal the CPU to service it)
diff --git a/docs/20_Checks/check_cronstatus.md b/docs/20_Checks/check_cronstatus.md
index e03fbca..8459cea 100644
--- a/docs/20_Checks/check_cronstatus.md
+++ b/docs/20_Checks/check_cronstatus.md
@@ -1,6 +1,6 @@
-# Check Cronstatus
+## Check Cronstatus
-## Introduction
+Script: `check_cronstatus`
Show status of all Cronjobs using Axels Cronwrapper
diff --git a/docs/20_Checks/check_disk_io.md b/docs/20_Checks/check_disk_io.md
index bc3c906..90e67e6 100644
--- a/docs/20_Checks/check_disk_io.md
+++ b/docs/20_Checks/check_disk_io.md
@@ -1,6 +1,4 @@
-# CHECK_DISK-IO
-
-## Introduction
+## CHECK_DISK-IO
**check_disk-io** is a plugin to show io, ticks and wait time.
It shows a multiline output and sends performance data.
diff --git a/docs/20_Checks/check_dns_responsetime.md b/docs/20_Checks/check_dns_responsetime.md
index bf25cd5..2c9232d 100644
--- a/docs/20_Checks/check_dns_responsetime.md
+++ b/docs/20_Checks/check_dns_responsetime.md
@@ -1,6 +1,4 @@
-# CHECK_DNS_RESPONSETIME
-
-## Introduction
+## CHECK_DNS_RESPONSETIME
**check_dns_responsetime** check dns response time of all dns servers found in local /etc/resolv.conf
diff --git a/docs/20_Checks/check_docker_info.md b/docs/20_Checks/check_docker_info.md
index 1d8230f..0978217 100644
--- a/docs/20_Checks/check_docker_info.md
+++ b/docs/20_Checks/check_docker_info.md
@@ -1,6 +1,4 @@
-# CHECK_DOCKER_INFO
-
-## Introduction
+## CHECK_DOCKER_INFO
**check_docker_info_** shows the docker version and count of containers.
You get the count of containers by state running, paused or stopped.
diff --git a/docs/20_Checks/check_docker_stats.md b/docs/20_Checks/check_docker_stats.md
index 2cd82d0..c0667fe 100644
--- a/docs/20_Checks/check_docker_stats.md
+++ b/docs/20_Checks/check_docker_stats.md
@@ -1,6 +1,4 @@
-# CHECK_DOCKER_STATS
-
-## Introduction
+## CHECK_DOCKER_STATS
**check_docker_stats** shows the docker resources of containers.
This check sends performance data.
diff --git a/docs/20_Checks/check_dockercontainer_top.md b/docs/20_Checks/check_dockercontainer_top.md
index af3d9d9..30eb888 100644
--- a/docs/20_Checks/check_dockercontainer_top.md
+++ b/docs/20_Checks/check_dockercontainer_top.md
@@ -1,6 +1,4 @@
-# CHECK_DOCKERCONTAINER_TOP
-
-## Introduction
+## CHECK_DOCKERCONTAINER_TOP
**check_dockercontaeiner_top** shows the docker top output for each container.
diff --git a/docs/20_Checks/check_eol.md b/docs/20_Checks/check_eol.md
index 0436321..fb47429 100644
--- a/docs/20_Checks/check_eol.md
+++ b/docs/20_Checks/check_eol.md
@@ -1,6 +1,4 @@
-## check EOL
-
-### Introduction
+## Check EOL
**check_eol** is a plugin for Icinga/ Nagios. It detects the end of life of an OS or a product.
@@ -10,7 +8,7 @@ The status is "unknown" if a product or the eol date was not detected.
It is customizable / extendable to detect other products that are not included in the delivered basic config.
-### Syntax
+## Syntax
```txt
./check_eol
@@ -60,7 +58,7 @@ EXAMPLES
```
-#### Parameters
+### Parameters
PRODUCT set a product; known product keys are listed below
VERSION set a version.
@@ -70,12 +68,12 @@ VERSION set a version.
You can set "os" as product to detect the (linux) distribution.
See examples below.
-#### Options
+### Options
-c set critical limit; default 90
-w set warning limit; default 365
-### Examples
+## Examples
``check_eol php 7.4``
Show end of life for given php version 7.4
@@ -89,7 +87,7 @@ VERSION set a version.
``check_eol php detect``
Show the end of life for the detected php version
-### Extend/ customize
+## Extend/ customize
The check is build to be customizable. You can add
@@ -116,7 +114,7 @@ detect-postgres*
detect-ruby*
```
-#### End of life dates
+### End of life dates
The dates are defined in the files *check_eol-*.cfg*.
Those contain lines with parsed information that must start at the begin of line:
@@ -156,7 +154,7 @@ website https://www.centos.org/
Limit Info: warn below 365 days; critical below 90 days
```
-#### Files
+### Files
* check_eol-data/os.cfg - contains eol dates for debian, centos, ubuntu
* check_eol-data/check_eol-databases.cfg - Mariadb, PostgreSql
@@ -166,7 +164,7 @@ You can add your custom products and dates - it just must match *check_eol-*.cfg
Suggestion: *check_eol-data/custom-[my category].cfg*
-#### Version detection
+### Version detection
If you use ``check_eol [product] [version]`` with an already known version in your monitoring check then the search for an eol date is done directly in the *cfg files (see above).
diff --git a/docs/20_Checks/check_fs_errors.md b/docs/20_Checks/check_fs_errors.md
index 75df3e2..3c3eb28 100644
--- a/docs/20_Checks/check_fs_errors.md
+++ b/docs/20_Checks/check_fs_errors.md
@@ -1,6 +1,4 @@
-# Check filesystem errors
-
-## Introduction
+## Check filesystem errors
**check_fs_errors** checks if kernel logs inconsistency messages in the journallog.
It requires sudo permission on /bin/journalctl
diff --git a/docs/20_Checks/check_fs_writable.md b/docs/20_Checks/check_fs_writable.md
index 9646a75..2bfba93 100644
--- a/docs/20_Checks/check_fs_writable.md
+++ b/docs/20_Checks/check_fs_writable.md
@@ -1,6 +1,4 @@
-# Check writable filesystem
-
-## Introduction
+## Check writable filesystem
**check_fs_writebale** checks in the given directories a file can be touched.
The response is critical of one of the directory is not writable for the icinga client user.
diff --git a/docs/20_Checks/check_gitlab_tokens.md b/docs/20_Checks/check_gitlab_tokens.md
index 818c705..5b4c51f 100644
--- a/docs/20_Checks/check_gitlab_tokens.md
+++ b/docs/20_Checks/check_gitlab_tokens.md
@@ -1,6 +1,4 @@
-# Check Gitlab tokens
-
-## Introduction
+## Check Gitlab tokens
**check_gitlab_tokens** checks all newer tokens of projects and groups if they expire soon. You can set a warning and a critical level in days.
diff --git a/docs/20_Checks/check_haproxy_health.md b/docs/20_Checks/check_haproxy_health.md
index ca7b59c..444232b 100644
--- a/docs/20_Checks/check_haproxy_health.md
+++ b/docs/20_Checks/check_haproxy_health.md
@@ -1,6 +1,4 @@
-# Check HA-Proxy health
-
-## Introduction
+## Check HA-Proxy health
**check_haproxy_health** checks health url of haproxy service.
The url of it will be detected from /etc/haproxy/haproxy.cfg.
diff --git a/docs/20_Checks/check_haproxy_status.md b/docs/20_Checks/check_haproxy_status.md
index a9465d7..789c71b 100644
--- a/docs/20_Checks/check_haproxy_status.md
+++ b/docs/20_Checks/check_haproxy_status.md
@@ -1,6 +1,4 @@
-# Check HA-Proxy Status
-
-## Introduction
+## Check HA-Proxy Status
**check_haproxy_health** show status and connections count on frontend and backend.
This check sends performance data.
diff --git a/docs/20_Checks/check_http.md b/docs/20_Checks/check_http.md
index de5a486..e739583 100644
--- a/docs/20_Checks/check_http.md
+++ b/docs/20_Checks/check_http.md
@@ -1,6 +1,4 @@
-# Check Httpd
-
-## Introduction
+## Check Httpd
Makes an http request with a given method (like HEAD or GET; GET is default).
Additionally you can verify the response:
diff --git a/docs/20_Checks/check_iml_backup_server.md b/docs/20_Checks/check_iml_backup_server.md
index 6227e4d..5fd2212 100644
--- a/docs/20_Checks/check_iml_backup_server.md
+++ b/docs/20_Checks/check_iml_backup_server.md
@@ -1,6 +1,4 @@
-# Check IML backup server
-
-## Introduction
+## Check IML backup server
This check is for IML Backup server.
This check executes the script 'storage_helper.sh' to get thebackup status.
diff --git a/docs/20_Checks/check_journallog.md b/docs/20_Checks/check_journallog.md
index 1b5517b..9b383f2 100644
--- a/docs/20_Checks/check_journallog.md
+++ b/docs/20_Checks/check_journallog.md
@@ -1,6 +1,4 @@
-# Check Systemd unit
-
-## Introduction
+## Check Systemd unit
This check shows the count of written entries in the journallog per minute.
This check requires access to journalctl.
diff --git a/docs/20_Checks/check_memory.md b/docs/20_Checks/check_memory.md
index 56ffa3b..6381670 100644
--- a/docs/20_Checks/check_memory.md
+++ b/docs/20_Checks/check_memory.md
@@ -1,6 +1,4 @@
-# Check Memory (RAM)
-
-## Introduction
+## Check Memory (RAM)
**check_memory** Check memory usage incl. free, used and total memory.
@@ -19,7 +17,7 @@ It reads /proc/meminfo and fetches the needed values.
This plugin sends all values as performance data.
-### Requirements
+## Requirements
* bc
diff --git a/docs/20_Checks/check_mysqlserver.md b/docs/20_Checks/check_mysqlserver.md
index 640b644..00c763e 100644
--- a/docs/20_Checks/check_mysqlserver.md
+++ b/docs/20_Checks/check_mysqlserver.md
@@ -1,6 +1,4 @@
-# check Mysql / mariadb server
-
-## Introduction
+## Check Mysql / mariadb server
**check_mysqlserver** is a plugin execute different checks on a mysql server instance.
The kind of check is defined by a parameter `-m METHOD`.
diff --git a/docs/20_Checks/check_netio.md b/docs/20_Checks/check_netio.md
index 0c52dd0..6975cb7 100644
--- a/docs/20_Checks/check_netio.md
+++ b/docs/20_Checks/check_netio.md
@@ -1,12 +1,10 @@
-# check_netio
-
-## Introduction
+## Check_netio
Show network io for all or selected interfaces.
This plugin scans `/proc/net/dev` with the regex `eth|en[ops][0-9]*` to show a few types of interfaces.
-### Requirements
+## Requirements
* none
diff --git a/docs/20_Checks/check_netstat.md b/docs/20_Checks/check_netstat.md
index 2dd0f32..df04c32 100644
--- a/docs/20_Checks/check_netstat.md
+++ b/docs/20_Checks/check_netstat.md
@@ -1,6 +1,4 @@
-# check netstat
-
-## Introduction
+## Check netstat
Count number of network connections.
diff --git a/docs/20_Checks/check_onehost.md b/docs/20_Checks/check_onehost.md
index bfb34e9..34c2b79 100644
--- a/docs/20_Checks/check_onehost.md
+++ b/docs/20_Checks/check_onehost.md
@@ -1,6 +1,4 @@
-# check OpenNebula hosts
-
-## Introduction
+## Check OpenNebula hosts
**check_onevm** is a plugin to show count of hosts in OpenNebula and warn if a host is down.
diff --git a/docs/20_Checks/check_onevm.md b/docs/20_Checks/check_onevm.md
index 5340443..da56a9e 100644
--- a/docs/20_Checks/check_onevm.md
+++ b/docs/20_Checks/check_onevm.md
@@ -1,6 +1,4 @@
-# Check OpenNebula virtual machines
-
-## Introduction
+## Check OpenNebula virtual machines
**check_onevm** is a plugin to show count of vms in OpenNebula - listed by state and by host.
diff --git a/docs/20_Checks/check_opencpu.md b/docs/20_Checks/check_opencpu.md
index 6113c16..4013842 100644
--- a/docs/20_Checks/check_opencpu.md
+++ b/docs/20_Checks/check_opencpu.md
@@ -1,6 +1,4 @@
-# check_opencpu
-
-## Introduction
+## Check_opencpu
Test if OpenCpu is available via http and test if given packages are installed.
diff --git a/docs/20_Checks/check_packages2install.md b/docs/20_Checks/check_packages2install.md
index f8a2b82..cde17d2 100644
--- a/docs/20_Checks/check_packages2install.md
+++ b/docs/20_Checks/check_packages2install.md
@@ -1,6 +1,4 @@
-# check_packages2install
-
-## Introduction
+## Check_packages2install
Check available package updates.
Found updates will be shown in groups.
diff --git a/docs/20_Checks/check_php-fpm-status.md b/docs/20_Checks/check_php-fpm-status.md
index 8ca858e..5f614f2 100644
--- a/docs/20_Checks/check_php-fpm-status.md
+++ b/docs/20_Checks/check_php-fpm-status.md
@@ -1,10 +1,8 @@
-# check_php-fpm-status
-
-## Introduction
+## Check_php-fpm-status
The check fetches several counters from php-fm-status page.
-### Requirements
+## Requirements
* wget
* running PHP FPM service
diff --git a/docs/20_Checks/check_proc_mem.md b/docs/20_Checks/check_proc_mem.md
index 57623cc..952ec92 100644
--- a/docs/20_Checks/check_proc_mem.md
+++ b/docs/20_Checks/check_proc_mem.md
@@ -1,6 +1,4 @@
-# Check memory consuming processes
-
-## Introduction
+## Check memory consuming processes
Show processes that consume the most memory.
You get a list with process name, total usage of all its processes, count of instances.
diff --git a/docs/20_Checks/check_proc_ressources.md b/docs/20_Checks/check_proc_ressources.md
index e0722fb..99489c3 100644
--- a/docs/20_Checks/check_proc_ressources.md
+++ b/docs/20_Checks/check_proc_ressources.md
@@ -1,6 +1,4 @@
-# Check process resources regarding cpu and memory
-
-## Introduction
+## Check process resources regarding cpu and memory
Show processes that consume the most memory or cpu.
You get a list with usage, process id and process
diff --git a/docs/20_Checks/check_proc_zombie.md b/docs/20_Checks/check_proc_zombie.md
index 499c5a9..e9aa946 100644
--- a/docs/20_Checks/check_proc_zombie.md
+++ b/docs/20_Checks/check_proc_zombie.md
@@ -1,6 +1,4 @@
-# Check_proc_zombie
-
-## Introduction
+## Check_proc_zombie
**check_proc_zombie** is a plugin to show the count of zombie processes.
It sends performance data.
diff --git a/docs/20_Checks/check_psqlserver.md b/docs/20_Checks/check_psqlserver.md
index 96c5869..2329bc3 100644
--- a/docs/20_Checks/check_psqlserver.md
+++ b/docs/20_Checks/check_psqlserver.md
@@ -1,6 +1,4 @@
-# check PostgreSql server
-
-## Introduction
+## Check PostgreSql server
**check_psqlserver** is a plugin execute different checks on a postgreSql server instance.
The kind of check is defined by a parameter `-m METHOD`.
diff --git a/docs/20_Checks/check_rearbackup.md b/docs/20_Checks/check_rearbackup.md
index c718824..f4d97f4 100644
--- a/docs/20_Checks/check_rearbackup.md
+++ b/docs/20_Checks/check_rearbackup.md
@@ -1,6 +1,4 @@
-# Check Rear backup
-
-## Introduction
+## Check Rear backup
This check can verify the age of all iso files in the backup target directory.
diff --git a/docs/20_Checks/check_reboot_required.md b/docs/20_Checks/check_reboot_required.md
index df42859..25e066d 100644
--- a/docs/20_Checks/check_reboot_required.md
+++ b/docs/20_Checks/check_reboot_required.md
@@ -1,6 +1,4 @@
-# Check Reboot required
-
-## Introduction
+## Check Reboot required
Check if a reboot is required.
It works for Centos and Debian/ Ubuntu.
diff --git a/docs/20_Checks/check_requirements.md b/docs/20_Checks/check_requirements.md
index 3aff971..15d5ed8 100644
--- a/docs/20_Checks/check_requirements.md
+++ b/docs/20_Checks/check_requirements.md
@@ -1,6 +1,4 @@
-# Check_requirements
-
-## Introduction
+## Check_requirements
**check_requirements** is a plugin to run different check to show the ability to run an application. You can these checks
diff --git a/docs/20_Checks/check_smartstatus.md b/docs/20_Checks/check_smartstatus.md
index 7131c83..1fac6a4 100644
--- a/docs/20_Checks/check_smartstatus.md
+++ b/docs/20_Checks/check_smartstatus.md
@@ -1,6 +1,4 @@
-# Check_smartstatus
-
-## Introduction
+## Check_smartstatus
**check_smartstatus** is a plugin run a smartctl check to verify the disk status of all local harddisks/ ssds.
diff --git a/docs/20_Checks/check_snmp_data.md b/docs/20_Checks/check_snmp_data.md
index ff88cf2..d54fb2d 100644
--- a/docs/20_Checks/check_snmp_data.md
+++ b/docs/20_Checks/check_snmp_data.md
@@ -1,6 +1,4 @@
-# check SNMP data
-
-## Introduction
+## Check SNMP data
**check_snmp_data** is a plugin for fetching performance data with a set of given OIDs.
diff --git a/docs/20_Checks/check_snmp_synology.md b/docs/20_Checks/check_snmp_synology.md
index ffe4315..df59d94 100644
--- a/docs/20_Checks/check_snmp_synology.md
+++ b/docs/20_Checks/check_snmp_synology.md
@@ -1,6 +1,4 @@
-# check SNMP Synology
-
-## Introduction
+## Check SNMP Synology
**check_snmp_data** is a plugin to check the status of a Synology storage using snmp v2 or v3.
diff --git a/docs/20_Checks/check_ssl_certs.md b/docs/20_Checks/check_ssl_certs.md
index a84bca8..8fbed68 100644
--- a/docs/20_Checks/check_ssl_certs.md
+++ b/docs/20_Checks/check_ssl_certs.md
@@ -1,6 +1,4 @@
-# Check ssl certs
-
-## Introduction
+## Check ssl certs
**check_ssl_certs** is a plugin to check local certificats.
diff --git a/docs/20_Checks/check_systemdunit.md b/docs/20_Checks/check_systemdunit.md
index 3148753..fbe1bcd 100644
--- a/docs/20_Checks/check_systemdunit.md
+++ b/docs/20_Checks/check_systemdunit.md
@@ -1,6 +1,4 @@
-# Check Systemd unit
-
-## Introduction
+## Check Systemd unit
This check shows the status of a systemd unit.
diff --git a/docs/20_Checks/fix_h1.sh b/docs/20_Checks/fix_h1.sh
new file mode 100755
index 0000000..ee2488b
--- /dev/null
+++ b/docs/20_Checks/fix_h1.sh
@@ -0,0 +1,54 @@
+#!/bin/bash
+
+tmpfile=/tmp/tmp_myfile_$USER__$$
+
+cd "$( dirname "$0" )"
+
+for f in *.md; do
+ if head "$f" | grep -q "^# "; then
+ echo
+ echo ">>>>> FIX $f"
+ echo
+ cp -p "$f" "$tmpfile"
+
+ if grep -q "^## Introduction" "$f"; then
+ echo "Replace '## Introduction'"
+ sed -i -e "s/^## Introduction.*//" "$tmpfile"
+ head -1 "$f" | tail -1 | grep "." && sed -i -e '2,3d' "$tmpfile"
+
+ # make 1st h1 smaller
+ sed -i -e "0,/^# /{s/^# /## /}" "$tmpfile"
+
+ else
+ echo "Move Headers"
+ if grep "^###### " "$f"; then
+ echo "ABORT: H6 was found that cannot moved to smaller level."
+ exit 1
+ fi
+ for header in "#####" "####" "###" "##" "#"
+ do
+ sed -i -e "s/^$header /#$header /g" "$tmpfile"
+ done
+ fi
+ diff -u --color "$f" "$tmpfile"
+ echo
+ read -p "Apply changes on '$f' [Y/n]? > " apply
+ if [ "$apply" = "" ] || [ "$apply" = "y" ]|| [ "$apply" = "Y" ]; then
+ echo "Applying ..."
+ mv "$tmpfile" "$f"
+ else
+ echo "Keeping current version."
+ rm "$tmpfile"
+ fi
+ sleep 1
+ echo
+ echo
+ echo
+ echo
+ echo
+ echo
+ echo ----------------------------------------------------------------------
+ else
+ echo "OK $f"
+ fi
+done
\ No newline at end of file
diff --git a/docs/20_Checks/zz_template_check_.md b/docs/20_Checks/zz_template_check_.md
index a512312..7fc3a0c 100644
--- a/docs/20_Checks/zz_template_check_.md
+++ b/docs/20_Checks/zz_template_check_.md
@@ -1,8 +1,8 @@
-# check NAME
+## Check NAME
-## Introduction
+Script: `check_NAME`
-**check_NAME** is a plugin for ...
+It is a plugin for ...
## Syntax
diff --git a/docs/30_Shared_functions/_index.md b/docs/30_Shared_functions/_index.md
new file mode 100644
index 0000000..efc04bc
--- /dev/null
+++ b/docs/30_Shared_functions/_index.md
@@ -0,0 +1,5 @@
+## Shared functions
+
+There is one include script used by all checks:
+[inc_pluginfunctions](inc_pluginfunctions.md)
+
diff --git a/docs/20_Checks/inc_pluginfunctions.md b/docs/30_Shared_functions/inc_pluginfunctions.md
similarity index 99%
rename from docs/20_Checks/inc_pluginfunctions.md
rename to docs/30_Shared_functions/inc_pluginfunctions.md
index 1bcb056..83b3367 100644
--- a/docs/20_Checks/inc_pluginfunctions.md
+++ b/docs/30_Shared_functions/inc_pluginfunctions.md
@@ -1,6 +1,4 @@
-# Shared functions
-
-## Introduction
+## Shared functions
All scripts start with sourcing a shared bash file
diff --git a/docs/_index.md b/docs/_index.md
index 8bf54d2..8cbbc6c 100644
--- a/docs/_index.md
+++ b/docs/_index.md
@@ -1,6 +1,4 @@
-# IML Checks for Icinga / Nagios
-
-## Introduction
+## IML Checks for Icinga / Nagios
IML - Institute for Medical Education at university in Bern, Switzerland.
diff --git a/docs/style.css b/docs/style.css
index 5877f85..cd1b3f0 100644
--- a/docs/style.css
+++ b/docs/style.css
@@ -1,6 +1,6 @@
/*
override css elements of daux.io blue theme
- version 2024-10-24
+ version 2024-10-31
*/
:root {
/* Axels Overrides */
@@ -19,8 +19,9 @@
--sidebar-background: var(--body-background);
--sidebar-border-color: none;
--sidebar-link-active-background: #f0f4f6;
+ --toc--inner-border-color: none;
/* Axels custom values */
- --axel_bg-toc: var(--body-background);
+ --axel_bg-toc: #f8fafa;
--axel_bg-toc-head: #f8f8f8;
--axel_brand-background: none;
--axel_brand-pre-background: rgb(255, 0, 51);
@@ -35,8 +36,8 @@
--axel_h2-hero-bottom: 2px solid #912;
--axel_h3: #333;
--axel_h3-bottom: 0px solid #ddd;
- --axel_h4: #478;
- --axel_h5: #699;
+ --axel_h4: #666;
+ --axel_h5: #888;
--axel_hero_bg: #faf8f6;
--axel_img-border: 2px dashed #ccc;
--axel_nav-bg: #fcfcfc;
@@ -60,6 +61,7 @@
--sidebar-background: var(--body-background);
--sidebar-border-color: none;
--sidebar-link-active-background: #333;
+ --sidebar-link-color: var(--link-color);
/* Axels custom values */
--axel_bg-toc: var(--body-background);
--axel_bg-toc-head: #333;
@@ -126,19 +128,28 @@ a.Brand {
/* ---------- page content ---------- */
.s-content {
- padding-top: 1em;
+ padding-top: 6em;
}
-/* .s-content h1::before{
- background: #fee;
- border: 3px double #f00;
+h1::before{color: #aaa;content: 'h1: ';}
+h2::before{color: #aaa;content: 'h2: ';}
+h3::before{color: #aaa;content: 'h3: ';}
+h4::before{color: #aaa;content: 'h4: ';}
+h5::before{color: #aaa;content: 'h5: ';}
+h6::before{color: #aaa;content: 'h6: ';}
+
+h1::before{color: #aaa;content: '';}
+h2::before{color: #888;content: ': : ';}
+h3::before{color: #aaa;content: '> ';}
+h4::before{color: #aaa;content: '_ ';}
+h5::before{color: #aaa;content: 'h5: ';}
+h6::before{color: #aaa;content: 'h6: ';}
+
+.s-content h1::before{
color: #f00;
content: 'FEHLER: Keine Überschrift 1 in einer Markdown-Datei für Daux verwenden! Mit H2 beginnen!';
- display: block;
- font-size: 50%;
- padding: 0.3em;
- margin-bottom: 2em;
-} */
+ content: '!! h1 !! ';
+}
.s-content h1 {
background: var(--axel_h1-bg);
@@ -159,8 +170,14 @@ a.Brand {
border-bottom: var(--axel_h2-bottom);
}
-h1:first-of-type {
+.Page__header > h1:first-of-type {
margin-top: 0em;
+ margin-left: -1em;
+ padding-left: 1em;
+ position: fixed;
+ min-width: 100%;
+ background: var(--body-background);
+ box-shadow: 0 2em 1em var(--body-background);
}
h2:first-of-type {
@@ -211,6 +228,8 @@ ul.TableOfContents a{
}
.s-content pre {
background: var(--axel_pre-background);
+ border-radius: 0.5em;
+ padding: 1rem;
}
/* FIX smaller fnt size in tables */
@@ -262,14 +281,6 @@ div.hero h2 {
}
/* ---------- TOC ---------- */
-@media(min-width:1700px) {
- .TableOfContentsContainer {
- position: fixed;
- right: 2em;
- top: 1em;
- height: 96%;
- }
-}
.TableOfContentsContainer {
background-color: var(--axel_bg-toc);
@@ -279,9 +290,11 @@ div.hero h2 {
.s-content .TableOfContentsContainer h4 {
background-color: var(--axel_bg-toc-head);
border-top-left-radius: 1em;
+ border-bottom: 2px solid var(--axel_bg-toc-bottom-border);
font-size: 1.1em;
margin: 0;
padding: 0.3em;
+ display: none;
}
.TableOfContentsContainer__content {
@@ -300,6 +313,16 @@ ul.TableOfContents ul {
text-decoration: underline;
}
+@media(min-width:1700px) {
+ .TableOfContentsContainer {
+ background: none;
+ position: fixed;
+ right: 2em;
+ top: 4em;
+ height: 90%;
+ }
+}
+
/* ----- Icons on links --- */
.EditOn a::before{
--
GitLab