Merge branch 'master' into doc-parser-no-PB

Author: zsoltgyulai94

.github/ISSUE_TEMPLATE/10-bug-report.md

@@ -0,0 +1,22 @@
+---
+name: Bug report
+about: Use this template for reporting a bug related to building the documentation.
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Platform
+<!-- Name and version of OS -->
+
+# Issue
+
+## Failure
+
+## Steps to reproduce
+<!-- A description of how to trigger this bug. -->
+
+## Configuration
+
+## Input and output logs (if possible)

.github/ISSUE_TEMPLATE/20-documentation-issue.md

@@ -0,0 +1,17 @@
+---
+name: Documentation issue
+about: Use this template for reporting an issue in the documentation.
+title: ''
+labels: 'documentation'
+assignees: ''
+
+---
+
+## Incorrect section
+<!-- Which section of the documentation is wrong? Please include a link to it, if that is possible. -->
+
+## Description of the problem
+<!-- Which statements of the documentation are inaccurate? -->
+
+## Proposed solution
+<!-- What do you think the correction should be? -->

.github/ISSUE_TEMPLATE/30-feature-request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Use this template for raising a feature request.
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+## Description of the problem
+<!-- Is your feature request related to a problem? Please describe. Ex. I'm always frustrated when [...] -->
+
+## Proposed solution
+<!-- Describe the solution you'd like. -->
+
+## Alternatives
+<!-- Describe any alternative solutions or features you've considered. -->
+
+## Additional context
+<!-- Add any other context or screenshots about the feature request here. -->

.github/workflows/jekyll-gh-pages.yml

@@ -29,7 +29,7 @@ concurrency:
 jobs:
   # Build job
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -96,6 +96,20 @@ jobs:
           ./_tools/pack debug
           ls -AlR _site/assets/js
 
+          # Generate and add Doxygen source documentation
+          sudo apt-get install doxygen graphviz -y
+
+          OSE_SRC_REPO=https://github.com/syslog-ng/syslog-ng.git
+          OSE_SRC_REPO_BRANCH=develop  # as this is a developer documentation use the latest develop branch instead of the master
+          git clone --branch ${OSE_SRC_REPO_BRANCH} --single-branch ${OSE_SRC_REPO} ./_work
+
+          pushd ./_work
+          # How to override Doxygen options from command line
+          # https://www.doxygen.nl/manual/faq.html#faq_cmdline
+          ( cat ./Doxyfile; echo "OUTPUT_DIRECTORY=../_site/dev-guide/chapter_9/" ) | doxygen -
+          popd
+          rm -Rf ./_work
+
       - name: Upload artifact
         # Automatically uploads an artifact from the './_site' directory by default
         uses: actions/upload-pages-artifact@v3
@@ -105,7 +119,7 @@ jobs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     needs: build
     steps:
       - name: Deploy to GitHub Pages

Gemfile

@@ -111,5 +111,6 @@ group :jekyll_plugins do
     # https://github.com/HofiOne/minimal-mistakes
     #
     gem "jekyll-include-cache"
+	gem "jekyll-github-metadata"
     # gem "github-pages"
 end

_config.yml

@@ -258,4 +258,4 @@ product:
   name: 'syslog-ng Open Source Edition'
   short_name: 'syslog-ng OSE'
 
-repository: syslog-ng/syslog-ng
+repository: syslog-ng/syslog-ng.github.io

_data/external_links.yml

@@ -107,6 +107,12 @@ sn-ose-adminguide:
   url: https://syslog-ng.github.io/admin-guide/README
   title: [ "The syslog-ng OSE Administration Guide" ]
 
+sn-ose-source-doc:
+  id: sn-ose-source-doc
+  url: /dev-guide/chapter_9/html/index.html
+  title: [ "syslog-ng OSE source code documentation" ]
+  open_in_blank: true
+
 sn-ose-upgrade:
   id: sn-ose-upgrade
   url: https://syslog-ng.com/blog/upgrading-from-syslog-ng-open-source-to-premium-edition/
@@ -122,6 +128,10 @@ sn-selinux:
   url: https://syslog-ng.com/blog/using-syslog-ng-with-selinux-in-enforcing-mode/
   title: [ "Using syslog-ng OSE with SELinux in enforcing mode" ]
 
+sn-freebsd-audit:
+  id: sn-freebsd-audit
+  url: https://www.syslog-ng.com/community/b/blog/posts/freebsd-audit-source-for-syslog-ng
+  title: [ "FreeBSD audit source for syslog-ng" ]
 
 ### One Identity site links ###
 
@@ -378,6 +388,16 @@ gh-hy:
   url: https://github.com/hylang/hy
   title: [ "hy" ]
 
+gh-libdbi-master:
+  id: gh-libdbi-master
+  url: https://github.com/balabit-deps/libdbi/tree/master
+  title: [ "libdbi master" ]
+  
+gh-libdbi-drivers:
+ id: gh-libdbi-drivers
+ url: https://github.com/balabit-deps/libdbi-drivers
+ title: [ "libdbi drivers" ]
+
 gh-mon-src:
   id: gh-mon-src
   url: https://github.com/syslog-ng/syslog-ng-incubator/tree/master/modules/monitor-source/
@@ -608,6 +628,11 @@ gh-es:
   url: https://github.com/syslog-ng/syslog-ng/tree/master/scl/elasticsearch
   title: [ "Elasticsearch configuration snippet on GitHub" ]
 
+gh-es-ds:
+  id: gh-es-ds
+  url: https://github.com/syslog-ng/syslog-ng/blob/master/scl/elasticsearch/elastic-datastream.conf
+  title: [ "Elasticsearch datastream configuration snippet on GitHub" ]
+  
 gh-fortigate:
   id: gh-fortigate
   url: https://github.com/syslog-ng/syslog-ng/blob/master/scl/fortigate/fortigate.conf
@@ -712,6 +737,11 @@ gh-sumo:
   id: gh-sumo
   url: https://github.com/syslog-ng/syslog-ng/blob/master/scl/sumologic/sumologic.conf
   title: [ "Sumo Logic configuration snippet on GitHub" ]
+  
+gh-webhook:
+  id: gh-webhook
+  url: https://github.com/syslog-ng/syslog-ng/blob/develop/modules/python-modules/syslogng/modules/webhook/scl/webhook.conf
+  title: [ "Webhook config file on GitHub" ]
 
 gh-websense:
   id: gh-websense
@@ -790,12 +820,22 @@ discord-wh-intro:
   id: discord-wh-intro
   url: https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
   title: [ "Discord: Intro to Webhooks" ]
-  
+
+doxygen-home:
+  id: doxygen-home
+  url: https://www.doxygen.nl/
+  title: [ "Doxygen HomePage" ]
+
 ebpf:
   id: ebpf
   url: https://ebpf.io/
   title: [ "Extended Berkeley Packet Filter" ]
 
+elastic-ds:
+  id: elastic-ds
+  url: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
+  title: [ "Elasticsearch data streams" ]
+
 gcp-ser:
   id: gcp-ser
   url: https://cloud.google.com/iam/docs/service-account-overview
@@ -1076,6 +1116,11 @@ postgresql:
   url: https://www.postgresql.org/docs/current/runtime-config-logging.html#RUNTIME-CONFIG-LOGGING-CSVLOG
   title: [ "PostgreSQL" ]
 
+prometheus-scraper:
+  id: prometheus-scraper
+  url: https://prometheus.io/docs/prometheus/latest/getting_started/#configure-prometheus-to-monitor-the-sample-targets
+  title: [ "/[Pp]rometheus [Ss]craper/" ]
+
 qbittorrent:
   id: qbittorrent
   url: https://www.qbittorrent.org/
@@ -1142,7 +1187,7 @@ sn-graphite:
   title: [ "Collecting syslog-ng statistics to Graphite" ]
 
 sn-grouping-by:
-  id: sn--grouping-by
+  id: sn-grouping-by
   url: https://www.syslog-ng.com/community/b/blog/posts/the-grouping-by-parser-in-syslog-ng-3-8
   title: [ "The grouping-by() parser in syslog-ng blog post" ]
 

_data/link_aliases.yml

@@ -99,8 +99,155 @@ adm-about-glossary#bsd-syslog-protocol:
 adm-about-glossary#ietf-syslog-protocol:
   aliases: [ "IETF-syslog protocol", "IETF-syslog" ]
 
+adm-src-stats-exporter:
+  aliases: [ "stats-exporter-dont-log()" ]
+
 adm-src-wild:
   aliases: [ "/wildcard-file(?:\\(\\))? source[s]?/" ]
 
 adm-src-file:
   aliases: [ "/file(?:\\(\\))? source[s]?/" ]
+
+adm-src-program:
+  aliases: [ "program() source" ]
+
+adm-dest-program:
+  aliases: [ "program() destination" ]
+
+adm-src-mqtt:
+  aliases: [ "mqtt() source" ]
+
+adm-dest-mqtt:
+  aliases: [ "mqtt() destination" ]
+
+adm-src-netw:
+  aliases: [ "network() source" ]
+  
+adm-dest-netw:
+  aliases: [ "network() destination" ]
+
+adm-src-optel:
+  aliases: [ "opentelemetry() source" ]
+
+adm-dest-optel:
+  aliases: [ "opentelemetry() destination" ]
+
+adm-src-osquery:
+  aliases: [ "osquery() source" ]
+  
+adm-dest-osquery:
+  aliases: [ "osquery() destination" ]
+  
+adm-src-syslog:
+  aliases: [ "syslog() source" ]
+
+adm-dest-syslog:
+  aliases: [ "syslog() destination" ]
+
+adm-src-sng-otlp:
+  aliases: [ "syslog-ng-otlp() source" ]
+
+adm-dest-sng-otlp:
+  aliases: [ "syslog-ng-otlp() destination" ]
+
+adm-src-unix:
+  aliases: [ "unix-dgram() source", "unix-stream() source", "unix-dgram() and unix-stream() source" ]  
+
+adm-dest-unix:
+  aliases: [ "unix-dgram() destination", "unix-stream() destination", "unix-dgram() and unix-stream() destination" ]  
+
+adm-man-ctl:
+  aliases: [ "syslog-ng-ctl" ]
+
+adm-src-hypr:
+  aliases: [ "hypr-app-audit-trail()" ]
+
+adm-src-macOS:
+  aliases: [ "darwin-oslog()", "darwin-oslog-stream()" ]
+
+adm-dest-google-bq:
+  aliases: [ "bigquery()" ]
+
+adm-parser-kv:
+  aliases: [ "kv-parser()" ]
+
+adm-parser-csv:
+  aliases: [ "csv-parser()" ]
+
+adm-parser-syslog:
+  aliases: [ "syslog-parser()" ]
+
+adm-parser-json:
+  aliases: [ "json-parser()" ]
+
+adm-parser-xml:
+  aliases: [ "xml()" ]
+
+adm-parser-date:
+  aliases: [ "date-parser()" ]
+
+adm-parser-tags:
+  aliases: [ "tags-parser()" ]
+
+adm-parser-apache:
+  aliases: [ "apache-accesslog-parser()" ]
+
+adm-parser-linux:
+  aliases: [ "linux-audit-parser()" ]
+
+adm-parser-cisco:
+  aliases: [ "cisco-parser()" ]
+
+adm-parser-ewmm:
+  aliases: [ "ewmm-parser()" ]
+
+adm-parser-iptables:
+  aliases: [ "iptables-parser()" ]
+
+adm-parser-netskope:
+  aliases: [ "netskope-parser()" ]
+
+adm-parser-panos:
+  aliases: [ "panos-parser()" ]
+
+adm-parser-sudo:
+  aliases: [ "sudo-parser()" ]
+
+adm-parser-postrgresql:
+  aliases: [ "postgresql-csvlog-parser()" ]
+
+adm-parser-mariadb:
+  aliases: [ "mariadb-audit-parser()" ]
+
+adm-metrics-probe:
+  aliases: [ "metrics-probe()" ]
+
+adm-parser-websense:
+  aliases: [ "websense-parser()" ]
+
+adm-parser-evtx:
+  aliases: [ "windows-eventlog-xml-parser()" ]
+
+adm-parser-fortigate:
+  aliases: [ "fortigate-parser()" ]
+
+adm-parser-checkpoint:
+  aliases: [ "checkpoint-parser()" ]
+
+adm-parser-regexp:
+  aliases: [ "regexp-parser()" ]
+
+adm-parser-db:
+  aliases: [ "db-parser()" ]
+
+adm-parser-optel:
+  aliases: [ "opentelemetry-parser()" ]
+
+adm-correlate:
+  aliases: [ "grouping-by()" ]
+
+adm-stats:
+  aliases: [ "syslog-ng-ctl stats", "syslog-ng-ctl query" ]
+
+doxygen-home:
+  aliases: [ "/[Dd]oxygen/" ]