Merge branch 'master' into doc-pipe-fifo

Author: zsoltgyulai94

.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
@@ -105,7 +105,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

@@ -89,7 +89,9 @@ gem "faraday-retry"
 # that could lead to build error:
 # /opt/homebrew/Cellar/ruby/3.3.0/lib/ruby/3.3.0/logger.rb:384:in `level': undefined method `[]' for nil (NoMethodError)
 #    @level_override[Fiber.current] || @level
+gem "logger"
 gem "mercenary", "~> 0.4"
+gem "ostruct"
 
 # self made plugins dependencies
 gem "nokogiri"
@@ -100,6 +102,7 @@ gem "nokogiri"
 group :jekyll_plugins do
 
     gem "jekyll-remote-theme"
+	gem "jekyll-github-metadata"
     # gem "jekyll-paginate"
     # gem "jekyll-sitemap"
     # gem "jekyll-gist"

_config.yml

@@ -24,6 +24,7 @@ plugins:
   - jekyll-sitemap        # Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site.
   - jekyll-gist 	        # Liquid tag for displaying GitHub Gists in Jekyll sites.
   - jekyll-include-cache  # Liquid tag that caches Liquid includes.
+  - jekyll-github-metadata
 
 # Whitelist plugins under safe mode.
 whitelist:
@@ -256,3 +257,5 @@ footer:
 product:
   name: 'syslog-ng Open Source Edition'
   short_name: 'syslog-ng OSE'
+
+repository: syslog-ng/syslog-ng

_data/external_links.yml

@@ -343,6 +343,11 @@ flask:
   url: http://flask.pocoo.org/
   title: [ "Flask" ]
 
+freebsd-ports:
+  id: freebsd-ports
+  url: https://ports.freebsd.org/cgi/ports.cgi
+  title: [ "/FreeBSD [Pp]orts/" ]
+
 freepascal-launchd:
   id: freepascal-launchd
   url: https://wiki.freepascal.org/macOS_daemons_and_agents
@@ -411,12 +416,22 @@ grpc-keep:
 homebrew:
   id: homebrew
   url: http://brew.sh
-  title: [ "Homebrew" ]
+  title: [ "/[Hh]ome[Bb]rew/" ]
 
 homebrew-inst-detailed:
   id: homebrew-inst-detailed
   url: https://mac.install.guide/homebrew/3.html
-  title: [ "Homebrew" ]
+  title: [ "/[Hh]ome[Bb]rew [Ii]nstallation/", "/[Ii]nstall [Hh]ome[Bb]rew/" ]
+
+macports:
+  id: macports
+  url: https://www.macports.org
+  title: [ "/[Mm]ac[Pp]orts/" ]
+
+macports-inst-detailed:
+  id: macports-inst-detailed
+  url: https://www.macports.org/install.php
+  title: [ "/[Mm]ac[Pp]orts [Ii]nstallation/", "/[Ii]nstall [Mm]ac[Pp]orts/" ]
 
 iptables:
   id: iptables
@@ -593,6 +608,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
@@ -781,6 +801,11 @@ 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

_data/navigation.yml

@@ -81,8 +81,6 @@ admin-guide-nav:
     - title: "Configuring {{ site.product.short_name }} relays"
       url: /admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/README
       subnav:
-      - title: "Configuring {{ site.product.short_name }} on relay hosts"
-        url: /admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts
       - title: "How relaying log messages works"
         url: /admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/001_How_relaying_works
     - title: "Managing and checking {{ site.product.short_name }} service on Linux"
@@ -140,12 +138,12 @@ admin-guide-nav:
     - title: "file"
       url: /admin-guide/060_Sources/020_File/README
       subnav:
-      - title: "Notes on reading kernel messages"
-        url: /admin-guide/060_Sources/020_File/000_Notes_on_reading_kernel_messages
+      - title: "file() source options"
+        url: /admin-guide/060_Sources/020_File/000_File_source_options
       - title: "How file sources are followed"
         url: /admin-guide/060_Sources/020_File/001_File_following
-      - title: "file() source options"
-        url: /admin-guide/060_Sources/020_File/002_File_source_options
+      - title: "Notes on reading kernel messages"
+        url: /admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages
     - title: "Arr logs"
       url: /admin-guide/060_Sources/025_Arr_logs/README
       subnav:
@@ -154,6 +152,11 @@ admin-guide-nav:
       subnav:
       - title: "wildcard-file() source options"
         url: /admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options
+    - title: "hypr"
+      url: /admin-guide/060_Sources/031_Hypr/README
+      subnav:
+      - title: "hypr-audit-trail() and hypr-app-audit-trail() source options"
+        url: /admin-guide/060_Sources/031_Hypr/000_Hypr_options
     - title: "Jellyfin"
       url: /admin-guide/060_Sources/035_Jellyfin/README
       subnav:
@@ -1188,6 +1191,9 @@ dev-guide-nav:
           url: /dev-guide/chapter_4/section_2/macos-testing-status/afuser
         - title: "elasticsearch-http"
           url: /dev-guide/chapter_4/section_2/macos-testing-status/elasticsearch-http
+        - title: "grpc"
+          url: /dev-guide/chapter_4/section_2/macos-testing-status/grpc/README
+          subnav:
         - title: "http"
           url: /dev-guide/chapter_4/section_2/macos-testing-status/http
         - title: "mod-python"
@@ -1212,6 +1218,9 @@ dev-guide-nav:
             url: /dev-guide/chapter_4/section_2/macos-testing-status/system-source/01_collecting-native-logs
           - title: "Collecting local macOS logs"
             url: /dev-guide/chapter_4/section_2/macos-testing-status/system-source/02_collecting-local-logs
+    - title: "FreeBSD"
+      url: /dev-guide/chapter_4/section_3/README
+      subnav:
   - title: "Contribution"
     url: /dev-guide/chapter_5/README
     subnav:

_includes/doc/admin-guide/options/create-dirs.md

@@ -5,3 +5,6 @@
 
 *Description:* Enable creating non-existing directories when creating
 files or socket files.
+
+**NOTE:** If syslog-ng cannot create the pipe, it aborts and produces an error. This could be caused by the lack of a write permission, or missing directory. The latter of the two can be fixed by using the `create-dirs(yes)` option.
+{: .notice--info}

_includes/doc/admin-guide/options/headers-gRPC.md

@@ -0,0 +1,17 @@
+## headers()
+
+|  Type: |      arrow list|
+|Default:|           empty|
+
+Available in syslog-ng OSE 4.8 and later versions.
+
+*Description:* Adds custom gRPC headers to each RPC call. Currently only static header names and values are supported.
+
+```config
+headers(
+    "organization" => "org-name"
+    "stream-name" => "org-stream"
+  )
+```
+
+> *Copyright © 2024 Axoflow*

_includes/doc/admin-guide/options/persist-name.md

@@ -9,6 +9,10 @@ drivers:
 
 > Error checking the uniqueness of the persist names, please override it with persist-name option. Shutting down.
 
+or
+
+> Automatic assignment of persist names failed, as conflicting persist names were found. Please override the automatically assigned identifier using an explicit persist-name() option or remove the duplicated configuration elements.
+
 This error happens if you use identical drivers in multiple sources, for
 example, if you configure two file sources to read from the same file.
 In this case, set the persist-name() of the drivers to a custom string,

_includes/doc/admin-guide/options/source-flags.md

@@ -23,7 +23,7 @@
     this information is not available in the message. Works when the
     incoming message stream is close to real time, and the timezone
     information is missing from the timestamp.
-
+- *ignore-aux-data*: This flag enables the source to ignore  auxiliary data.
 - *kernel*: The kernel flag makes the source default to the LOG_KERN
     | LOG_NOTICE priority if not specified otherwise.
 

_includes/doc/common_snippets

@@ -12,6 +12,8 @@ that contains the include tag, further inherited e.g. layouts will not see the i
 
 {% assign img_folder = '/assets/images' | relative_url %}
 
+{% assign ose_latest = site.github.latest_release.name | remove: '.tar.gz' | remove: 'syslog-ng-' %}
+
 {% include doc/dev-guide/common_snippets %}
 
 {% include doc/admin-guide/common_snippets %}

doc/_admin-guide/010_Introduction_to_syslog-ng/001_What_syslog-ng_is_not.md

@@ -1,11 +1,11 @@
 ---
 title: What {{ site.product.short_name }} is not
 id: adm-intro-whatnot
+description: >-
+    The {{ site.product.short_name }} application is not log analysis software. It can filter
+    log messages and select only the ones matching certain criteria. It can
+    even convert the messages and restructure them to a predefined format,
+    or parse the messages and segment them into different fields. But
+    {{ site.product.short_name }} cannot interpret and analyze the meaning behind the messages,
+    or recognize patterns in the occurrence of different messages.
 ---
-
-The {{ site.product.short_name }} application is not log analysis software. It can filter
-log messages and select only the ones matching certain criteria. It can
-even convert the messages and restructure them to a predefined format,
-or parse the messages and segment them into different fields. But
-{{ site.product.short_name }} cannot interpret and analyze the meaning behind the messages,
-or recognize patterns in the occurrence of different messages.

doc/_admin-guide/010_Introduction_to_syslog-ng/003_Who_uses_syslog-ng.md

@@ -1,12 +1,13 @@
 ---
 title: Who uses {{ site.product.short_name }}?
 id: adm-intro-who
+description: >-
+    The {{ site.product.short_name }} application is used worldwide by companies and
+    institutions who collect and manage the logs of several hosts, and want
+    to store them in a centralized, organized way.
 ---
 
-The {{ site.product.short_name }} application is used worldwide by companies and
-institutions who collect and manage the logs of several hosts, and want
-to store them in a centralized, organized way. Using {{ site.product.short_name }} is
-particularly advantageous for:
+Using {{ site.product.short_name }} is particularly advantageous for:
 
 - Internet Service Providers
 

doc/_admin-guide/010_Introduction_to_syslog-ng/004_Supported_platforms.md

@@ -1,14 +1,14 @@
 ---
 title: Supported platforms
 id: adm-intro-supp
+description: >-
+    The {{ site.product.short_name }} application is highly
+    portable and is known to run on a wide range of hardware architectures
+    (x86, x86_64, SUN Sparc, PowerPC 32 and 64, Alpha, ARM64) and operating
+    systems, including Linux, BSD, Solaris, IBM AIX, HP-UX, macOS,
+    Cygwin, and others.
 ---
 
-The {{ site.product.short_name }} application is highly
-portable and is known to run on a wide range of hardware architectures
-(x86, x86_64, SUN Sparc, PowerPC 32 and 64, Alpha, ARM64) and operating
-systems, including Linux, BSD, Solaris, IBM AIX, HP-UX, macOS,
-Cygwin, and others.
-
 - The [[source code|gh-syslog-ng]] of {{ site.product.name }} is released under the GPLv2 license
 
 - For the available binary installation packages, see {{ site.product.name }} installation packages.

doc/_admin-guide/010_Introduction_to_syslog-ng/README.md

@@ -1,8 +1,8 @@
 ---
 title: Introduction to syslog-ng
 id: adm-intro
+description: >-
+    This chapter introduces the {{ site.product.name }} application in
+    a non-technical manner, discussing how and why is it useful, and the
+    benefits it offers to an existing IT infrastructure.
 ---
-
-This chapter introduces the {{ site.product.name }} application in
-a non-technical manner, discussing how and why is it useful, and the
-benefits it offers to an existing IT infrastructure.

doc/_admin-guide/020_The_concepts_of_syslog-ng/003_Global_objects.md

@@ -1,6 +1,8 @@
 ---
 title: Global objects
 id: adm-conc-glob
+description: >-
+    This section explains some basic terminology used in {{ site.product.short_name }}. 
 ---
 
 ## Source driver

doc/_admin-guide/030_Installing_syslog-ng/001_Compiling_options.md

@@ -1,6 +1,8 @@
 ---
 title: Compiling options of {{ site.product.short_name }}
 id: adm-inst-compopt
+description: >-
+    This chapter describes the compiling options of {{ site.product.short_name }}.
 ---
 
 When compiling {{ site.product.short_name }} from source, you can use the following

doc/_admin-guide/030_Installing_syslog-ng/002_Uninstalling_syslog-ng.md

@@ -1,6 +1,8 @@
 ---
 title: Uninstalling {{ site.product.short_name }}
 id: adm-inst-uninst
+description: >-
+    This chapter gives you instructions about the uninstallation of {{ site.product.short_name }}.
 ---
 
 If you need to uninstall {{ site.product.short_name }} for some reason, you have the

doc/_admin-guide/030_Installing_syslog-ng/003_Configuring_MSSQL_server.md

@@ -1,14 +1,16 @@
 ---
-title: Configuring Microsoft SQL Server to accept logs from syslog-ng
+title: Configuring Microsoft SQL Server to accept logs from {{ site.product.short_name }}
 short_title: Configuring MSSQL Server
 id: adm-inst-mssql
+description: >-
+    This chapter explains how to configure an MSSQL Server to work with {{ site.product.short_name }}.
 ---
 
 {% assign crumb = page.url | split: '/' %}
 {% assign img_folder = crumb[-2] | prepend: '/assets/images/admin-guide/'%}
 
 Complete the following steps to configure your Microsoft SQL Server to
-enable remote logins and accept log messages from syslog-ng.
+enable remote logins and accept log messages from {{ site.product.short_name }}.
 
 1. Start the SQL Server Management Studio application. Select
     **Start \> Programs \> Microsoft SQL Server 2005 \> SQL Server

doc/_admin-guide/040_Quick-start_guide/000_Configuring_syslog-ng_on_client_hosts.md

@@ -2,9 +2,11 @@
 title: Configuring {{ site.product.short_name }} on client hosts
 id: adm-qs-client-conf
 description: >-
-    To configure {{ site.product.short_name }} on a client host, complete the following steps.
+    This section explains how to configure {{ site.product.short_name }} on a client host.
 ---
 
+To configure {{ site.product.short_name }} on a client host, complete the following steps.
+
 ## Steps
 
 1. Install the {{ site.product.short_name }} application on the host. For details

doc/_admin-guide/040_Quick-start_guide/001_Configuring_syslog-ng_on_server_hosts.md

@@ -2,9 +2,11 @@
 title: Configuring {{ site.product.short_name }} on server hosts
 id: adm-qs-server-conf
 description: >-
-    To configure {{ site.product.short_name }} on a server host, complete the following steps.
+    This section explains how to configure {{ site.product.short_name }} on a server host.
 ---
 
+To configure {{ site.product.short_name }} on a server host, complete the following steps.
+
 ## Steps
 
 1. Install the {{ site.product.short_name }} application on the host. For details