Skip to content

Commit 8617fc1

Browse files
Merge branch 'master' into doc-pipe-fifo
2 parents 86ea2f6 + 2343a93 commit 8617fc1

File tree

227 files changed

+1779
-471
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

227 files changed

+1779
-471
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ concurrency:
2929
jobs:
3030
# Build job
3131
build:
32-
runs-on: ubuntu-latest
32+
runs-on: ubuntu-22.04
3333
steps:
3434
- name: Checkout
3535
uses: actions/checkout@v4
@@ -105,7 +105,7 @@ jobs:
105105
environment:
106106
name: github-pages
107107
url: ${{ steps.deployment.outputs.page_url }}
108-
runs-on: ubuntu-latest
108+
runs-on: ubuntu-22.04
109109
needs: build
110110
steps:
111111
- name: Deploy to GitHub Pages

Gemfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,9 @@ gem "faraday-retry"
8989
# that could lead to build error:
9090
# /opt/homebrew/Cellar/ruby/3.3.0/lib/ruby/3.3.0/logger.rb:384:in `level': undefined method `[]' for nil (NoMethodError)
9191
# @level_override[Fiber.current] || @level
92+
gem "logger"
9293
gem "mercenary", "~> 0.4"
94+
gem "ostruct"
9395

9496
# self made plugins dependencies
9597
gem "nokogiri"
@@ -100,6 +102,7 @@ gem "nokogiri"
100102
group :jekyll_plugins do
101103

102104
gem "jekyll-remote-theme"
105+
gem "jekyll-github-metadata"
103106
# gem "jekyll-paginate"
104107
# gem "jekyll-sitemap"
105108
# gem "jekyll-gist"

_config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ plugins:
2424
- jekyll-sitemap # Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site.
2525
- jekyll-gist # Liquid tag for displaying GitHub Gists in Jekyll sites.
2626
- jekyll-include-cache # Liquid tag that caches Liquid includes.
27+
- jekyll-github-metadata
2728

2829
# Whitelist plugins under safe mode.
2930
whitelist:
@@ -256,3 +257,5 @@ footer:
256257
product:
257258
name: 'syslog-ng Open Source Edition'
258259
short_name: 'syslog-ng OSE'
260+
261+
repository: syslog-ng/syslog-ng

_data/external_links.yml

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,11 @@ flask:
343343
url: http://flask.pocoo.org/
344344
title: [ "Flask" ]
345345

346+
freebsd-ports:
347+
id: freebsd-ports
348+
url: https://ports.freebsd.org/cgi/ports.cgi
349+
title: [ "/FreeBSD [Pp]orts/" ]
350+
346351
freepascal-launchd:
347352
id: freepascal-launchd
348353
url: https://wiki.freepascal.org/macOS_daemons_and_agents
@@ -411,12 +416,22 @@ grpc-keep:
411416
homebrew:
412417
id: homebrew
413418
url: http://brew.sh
414-
title: [ "Homebrew" ]
419+
title: [ "/[Hh]ome[Bb]rew/" ]
415420

416421
homebrew-inst-detailed:
417422
id: homebrew-inst-detailed
418423
url: https://mac.install.guide/homebrew/3.html
419-
title: [ "Homebrew" ]
424+
title: [ "/[Hh]ome[Bb]rew [Ii]nstallation/", "/[Ii]nstall [Hh]ome[Bb]rew/" ]
425+
426+
macports:
427+
id: macports
428+
url: https://www.macports.org
429+
title: [ "/[Mm]ac[Pp]orts/" ]
430+
431+
macports-inst-detailed:
432+
id: macports-inst-detailed
433+
url: https://www.macports.org/install.php
434+
title: [ "/[Mm]ac[Pp]orts [Ii]nstallation/", "/[Ii]nstall [Mm]ac[Pp]orts/" ]
420435

421436
iptables:
422437
id: iptables
@@ -593,6 +608,11 @@ gh-es:
593608
url: https://github.com/syslog-ng/syslog-ng/tree/master/scl/elasticsearch
594609
title: [ "Elasticsearch configuration snippet on GitHub" ]
595610

611+
gh-es-ds:
612+
id: gh-es-ds
613+
url: https://github.com/syslog-ng/syslog-ng/blob/master/scl/elasticsearch/elastic-datastream.conf
614+
title: [ "Elasticsearch datastream configuration snippet on GitHub" ]
615+
596616
gh-fortigate:
597617
id: gh-fortigate
598618
url: https://github.com/syslog-ng/syslog-ng/blob/master/scl/fortigate/fortigate.conf
@@ -781,6 +801,11 @@ ebpf:
781801
url: https://ebpf.io/
782802
title: [ "Extended Berkeley Packet Filter" ]
783803

804+
elastic-ds:
805+
id: elastic-ds
806+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
807+
title: [ "Elasticsearch data streams" ]
808+
784809
gcp-ser:
785810
id: gcp-ser
786811
url: https://cloud.google.com/iam/docs/service-account-overview

_data/navigation.yml

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,6 @@ admin-guide-nav:
8181
- title: "Configuring {{ site.product.short_name }} relays"
8282
url: /admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/README
8383
subnav:
84-
- title: "Configuring {{ site.product.short_name }} on relay hosts"
85-
url: /admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/000_Configuring_syslog-ng_on_relay_hosts
8684
- title: "How relaying log messages works"
8785
url: /admin-guide/040_Quick-start_guide/002_Configuring_syslog-ng_relays/001_How_relaying_works
8886
- title: "Managing and checking {{ site.product.short_name }} service on Linux"
@@ -140,12 +138,12 @@ admin-guide-nav:
140138
- title: "file"
141139
url: /admin-guide/060_Sources/020_File/README
142140
subnav:
143-
- title: "Notes on reading kernel messages"
144-
url: /admin-guide/060_Sources/020_File/000_Notes_on_reading_kernel_messages
141+
- title: "file() source options"
142+
url: /admin-guide/060_Sources/020_File/000_File_source_options
145143
- title: "How file sources are followed"
146144
url: /admin-guide/060_Sources/020_File/001_File_following
147-
- title: "file() source options"
148-
url: /admin-guide/060_Sources/020_File/002_File_source_options
145+
- title: "Notes on reading kernel messages"
146+
url: /admin-guide/060_Sources/020_File/002_Notes_on_reading_kernel_messages
149147
- title: "Arr logs"
150148
url: /admin-guide/060_Sources/025_Arr_logs/README
151149
subnav:
@@ -154,6 +152,11 @@ admin-guide-nav:
154152
subnav:
155153
- title: "wildcard-file() source options"
156154
url: /admin-guide/060_Sources/030_Wildcard-file/000_Wildcard-file_options
155+
- title: "hypr"
156+
url: /admin-guide/060_Sources/031_Hypr/README
157+
subnav:
158+
- title: "hypr-audit-trail() and hypr-app-audit-trail() source options"
159+
url: /admin-guide/060_Sources/031_Hypr/000_Hypr_options
157160
- title: "Jellyfin"
158161
url: /admin-guide/060_Sources/035_Jellyfin/README
159162
subnav:
@@ -1188,6 +1191,9 @@ dev-guide-nav:
11881191
url: /dev-guide/chapter_4/section_2/macos-testing-status/afuser
11891192
- title: "elasticsearch-http"
11901193
url: /dev-guide/chapter_4/section_2/macos-testing-status/elasticsearch-http
1194+
- title: "grpc"
1195+
url: /dev-guide/chapter_4/section_2/macos-testing-status/grpc/README
1196+
subnav:
11911197
- title: "http"
11921198
url: /dev-guide/chapter_4/section_2/macos-testing-status/http
11931199
- title: "mod-python"
@@ -1212,6 +1218,9 @@ dev-guide-nav:
12121218
url: /dev-guide/chapter_4/section_2/macos-testing-status/system-source/01_collecting-native-logs
12131219
- title: "Collecting local macOS logs"
12141220
url: /dev-guide/chapter_4/section_2/macos-testing-status/system-source/02_collecting-local-logs
1221+
- title: "FreeBSD"
1222+
url: /dev-guide/chapter_4/section_3/README
1223+
subnav:
12151224
- title: "Contribution"
12161225
url: /dev-guide/chapter_5/README
12171226
subnav:

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,6 @@
55

66
*Description:* Enable creating non-existing directories when creating
77
files or socket files.
8+
9+
**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.
10+
{: .notice--info}
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## headers()
2+
3+
| Type: | arrow list|
4+
|Default:| empty|
5+
6+
Available in syslog-ng OSE 4.8 and later versions.
7+
8+
*Description:* Adds custom gRPC headers to each RPC call. Currently only static header names and values are supported.
9+
10+
```config
11+
headers(
12+
"organization" => "org-name"
13+
"stream-name" => "org-stream"
14+
)
15+
```
16+
17+
> *Copyright © 2024 Axoflow*

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ drivers:
99

1010
> Error checking the uniqueness of the persist names, please override it with persist-name option. Shutting down.
1111
12+
or
13+
14+
> 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.
15+
1216
This error happens if you use identical drivers in multiple sources, for
1317
example, if you configure two file sources to read from the same file.
1418
In this case, set the persist-name() of the drivers to a custom string,

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
this information is not available in the message. Works when the
2424
incoming message stream is close to real time, and the timezone
2525
information is missing from the timestamp.
26-
26+
- *ignore-aux-data*: This flag enables the source to ignore auxiliary data.
2727
- *kernel*: The kernel flag makes the source default to the LOG_KERN
2828
| LOG_NOTICE priority if not specified otherwise.
2929

_includes/doc/common_snippets

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ that contains the include tag, further inherited e.g. layouts will not see the i
1212

1313
{% assign img_folder = '/assets/images' | relative_url %}
1414

15+
{% assign ose_latest = site.github.latest_release.name | remove: '.tar.gz' | remove: 'syslog-ng-' %}
16+
1517
{% include doc/dev-guide/common_snippets %}
1618

1719
{% include doc/admin-guide/common_snippets %}

0 commit comments

Comments
 (0)