Skip to content

Commit 07ed735

Browse files
committed
FreeBSD: add FreeBSD build info
Signed-off-by: Hofi <hofione@gmail.com>
1 parent 7ed46a4 commit 07ed735

File tree

4 files changed

+492
-10
lines changed

4 files changed

+492
-10
lines changed

_data/external_links.yml

Lines changed: 5 additions & 0 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

_data/navigation.yml

Lines changed: 8 additions & 4 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"
@@ -841,13 +839,13 @@ admin-guide-nav:
841839
url: /admin-guide/120_Parser/014_panos_parser/001_Panos_parser_options
842840
- title: "Sudo parser"
843841
url: /admin-guide/120_Parser/015_sudo_parser
844-
- title: "MariaDB parser"
845-
url: /admin-guide/120_Parser/016_mariadb_parser
846842
- title: "PostgreSQL parser"
847843
url: /admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/README
848844
subnav:
849845
- title: "PostgreSQL csvlog parser options"
850846
url: /admin-guide/120_Parser/016_PostgreSQL_csvlog_parser/001_PostgreSQL_parser_options
847+
- title: "MariaDB parser"
848+
url: /admin-guide/120_Parser/016_mariadb_parser
851849
- title: "metrics-probe()"
852850
url: /admin-guide/120_Parser/017_metrics_probe_parser/README
853851
subnav:
@@ -1193,6 +1191,9 @@ dev-guide-nav:
11931191
url: /dev-guide/chapter_4/section_2/macos-testing-status/afuser
11941192
- title: "elasticsearch-http"
11951193
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:
11961197
- title: "http"
11971198
url: /dev-guide/chapter_4/section_2/macos-testing-status/http
11981199
- title: "mod-python"
@@ -1217,6 +1218,9 @@ dev-guide-nav:
12171218
url: /dev-guide/chapter_4/section_2/macos-testing-status/system-source/01_collecting-native-logs
12181219
- title: "Collecting local macOS logs"
12191220
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:
12201224
- title: "Contribution"
12211225
url: /dev-guide/chapter_5/README
12221226
subnav:

doc/_dev-guide/chapter_4/section_2/README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -268,11 +268,11 @@ sudo port install \
268268
export PKG_CONFIG_PATH=${HOMEBREW_PREFIX}/opt/openssl/lib/pkgconfig:${HOMEBREW_PREFIX}/opt/net-snmp/lib/pkgconfig:${HOMEBREW_PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}
269269
```
270270

271-
Some of the modules will not, or will incorrectly provide pkg-config support (even if added to `PKG\_CONFIG\_PATH`, e.g. libmaxminddb), to help the automatic configurations find them you can add brew to `CFLAGS`, `CPPFLAGS`, and `LDFLAGS`
271+
Some of the modules will not, or will incorrectly provide pkg-config support (even if added to `PKG\_CONFIG\_PATH`, e.g. libmaxminddb), to help the automatic configurations find them you can add brew to `CFLAGS`, `CXXFLAGS`, and `LDFLAGS`
272272

273273
```shell
274274
export CFLAGS="-I${HOMEBREW_PREFIX}/include/ ${CFLAGS}"
275-
export CPPFLAGS="${CFLAGS} ${CPPFLAGS}"
275+
export CXXFLAGS="${CFLAGS} ${CXXFLAGS}"
276276
export LDFLAGS="-L${HOMEBREW_PREFIX}/lib ${LDFLAGS}"
277277
```
278278

@@ -304,11 +304,11 @@ sudo port install \
304304
export PKG_CONFIG_PATH=${MACPORTS_PREFIX}/opt/openssl/lib/pkgconfig:${MACPORTS_PREFIX}/opt/net-snmp/lib/pkgconfig:${MACPORTS_PREFIX}/lib/pkgconfig:${PKG_CONFIG_PATH}
305305
```
306306

307-
Some of the modules will not, or will incorrectly provide pkg-config support (even if added to `PKG\_CONFIG\_PATH`, e.g. libmaxminddb), to help the automatic configurations find them you can add brew to `CFLAGS`, `CPPFLAGS`, and `LDFLAGS`
307+
Some of the modules will not, or will incorrectly provide pkg-config support (even if added to `PKG\_CONFIG\_PATH`, e.g. libmaxminddb), to help the automatic configurations find them you can add brew to `CFLAGS`, `CXXFLAGS`, and `LDFLAGS`
308308

309309
```shell
310310
export CFLAGS="-I${MACPORTS_PREFIX}/include/ ${CFLAGS}"
311-
export CPPFLAGS="${CFLAGS} ${CPPFLAGS}"
311+
export CXXFLAGS="${CFLAGS} ${CXXFLAGS}"
312312
export LDFLAGS="-L${MACPORTS_PREFIX}/lib ${LDFLAGS}"
313313
```
314314

@@ -329,7 +329,7 @@ git clone https://github.com/syslog-ng/syslog-ng .
329329
Latest version of {{ site.product.short_name }} [has dropped support of gcc](https://github.com/syslog-ng/syslog-ng/pull/4897), so now the platform default llvm/clang must be used to complie the source.\
330330
`gcc` still might compile {{ site.product.short_name }} and most of its modules, but there is no guarantie and support of it anymore
331331

332-
**Hint:** You can turn off any problematic module via its feature switch
332+
**Hint:** You can always turn off any problematic module via its feature switch
333333
{: .notice--info}
334334

335335
To make sure clang is used you can use (optional):
@@ -395,7 +395,7 @@ syslog-ng Open Source Edition 4.8.0.155.g8590bdc.dirty configured
395395
C++ compiler : clang++ -std=gnu++11 -std=gnu++17 - Apple clang version 15.0.0 (clang-1500.3.9.4) - /usr/bin/clang++
396396
C++ compiler options : -fno-omit-frame-pointer -O2 -g
397397
linker flags : -L/opt/homebrew/opt/ruby/lib -L/opt/homebrew/opt/openssl@3/lib -L/opt/homebrew/lib -L/opt/local/lib
398-
prefix : /Users/hofi/Develop/Balabit/syslog-ng/build/install
398+
prefix : /full_path_of_your/installdir
399399
linking mode : dynamic
400400
classic linking mode : no
401401
embedded crypto : no
@@ -563,6 +563,34 @@ make install
563563
cmake --build build/. --target install -j4
564564
```
565565

566+
After a succesful build you can check the built and supported modules via
567+
568+
```shell
569+
`/full_path_of_your/installdir`/syslog-ng -V
570+
```
571+
572+
The `Available-Modules:` entry of the output of the above command will show the available modules
573+
574+
```shell
575+
syslog-ng 4.8.0.240.gcf39eb3.dirty
576+
Config version: 4.2
577+
Installer-Version: 4.8.0.240.gcf39eb3.dirty
578+
Revision: 4.8.0.240.gcf39eb3.dirty
579+
Compile-Date: Sep 24 2024 17:57:15
580+
Module-Directory: /full_path_of_your/installdir/lib/syslog-ng
581+
Module-Path: /full_path_of_your/installdir/lib/syslog-ng
582+
Include-Path: /full_path_of_your/installdir/share/syslog-ng/include
583+
Available-Modules: bigquery,timestamp,darwinosl,kvformat,redis,riemann,afamqp,appmodel,afprog,loki,examples,metrics-probe,cef,map_value_pairs,otel,afsnmp,kafka,stardate,system-source,confgen,afuser,xml,disk-buffer,tfgetent,linux-kmsg-format,cloud_auth,correlation,json-plugin,pseudofile,affile,afsmtp,csvparser,basicfuncs,syslogformat,hook-commands,mqtt,afmongodb,graphite,tags-parser,geoip2-plugin,afstomp,http,secure-logging,afsql,mod-python,afsocket,add_contextual_data,mod-java,cryptofuncs,azure-auth-header,regexp-parser,rate_limit_filter
584+
Enable-Debug: on
585+
Enable-GProf: off
586+
Enable-Memtrace: off
587+
Enable-IPv6: on
588+
Enable-Spoof-Source: on
589+
Enable-TCP-Wrapper: off
590+
Enable-Linux-Caps: off
591+
Enable-Systemd: off
592+
```
593+
566594
### Testing
567595

568596
In order to run the tests, you have to install first the Criterion testing framework (for example: `brew install criterion`), and re-[configure](#configuration) the build with testing enabled (`--enable-tests` or `-DBUILD_TESTING=ON`). After that use the command below:

0 commit comments

Comments
 (0)