Merge pull request syslog-ng#5007 from HofiOne/Update-readme

folti · web-flow · commit 07e05248d41d · 2024-06-26T15:22:19.000+02:00
Update main README.md
diff --git a/README.md b/README.md
@@ -1,4 +1,3 @@
-[![Discord](https://img.shields.io/discord/1082023686028148877?label=Discord&logo=discord&logoColor=white)](https://discord.gg/qmq53uBm2c)
 [![Build Status](https://github.com/syslog-ng/syslog-ng/actions/workflows/devshell.yml/badge.svg)](https://github.com/syslog-ng/syslog-ng/actions/workflows/devshell.yml)
 [![Nightly](https://github.com/syslog-ng/syslog-ng/actions/workflows/nightly-release.yml/badge.svg)](https://github.com/syslog-ng/syslog-ng/actions/workflows/nightly-release.yml)
 [![Binary packages](https://github.com/syslog-ng/syslog-ng/actions/workflows/packages.yml/badge.svg)](https://github.com/syslog-ng/syslog-ng/actions/workflows/packages.yml)
@@ -17,7 +16,7 @@ The simplest configuration accepts system logs from /dev/log (from
 applications or forwarded by systemd) and writes everything to a single
 file:
 
-```
+``` config
 @version: 4.7
 @include "scl.conf"
 
@@ -29,7 +28,7 @@ log {
 
 This one additionally processes logs from the network (TCP/514 by default):
 
-```
+``` config
 @version: 4.7
 @include "scl.conf"
 
@@ -43,7 +42,7 @@ log {
 ```
 This config is designed for structured/application logging, using local submission via JSON, and outputting in key=value format:
 
-```
+``` config
 @version: 4.7
 @include "scl.conf"
 
@@ -55,59 +54,59 @@ log {
 
 To submit a structured log using `logger`, you might run:
 
-```
+```shell
 $ logger '@cim: {"name1":"value1", "name2":"value2"}'
 ```
 
 In which case the resulting message will be:
 
-```
+``` text
 name1=value1 name2=value2
 ```
-For a brief introduction to configuring the syslog-ng application, see the [quickstart guide](https://syslog-ng.github.io/admin-guide/040_Quick-start_guide/README).
 
+For a brief introduction to configuring the syslog-ng application, see the [quickstart guide](https://syslog-ng.github.io/admin-guide/040_Quick-start_guide/README).
 
 ## Features
 
-  * Receive and send [RFC3164](https://tools.ietf.org/html/rfc3164)
-    and [RFC5424](https://tools.ietf.org/html/rfc5424) style syslog
-    messages
-  * Receive and send [JSON](http://json.org/) formatted messages
-  * Work with any kind of unstructured data
-  * Classify and structure logs using built-in parsers (csv-parser(),
-    db-parser(), kv-parser(), etc.)
-  * Normalize, crunch, and process logs as they flow through the system
-  * Hand over logs for further processing using files, message queues (like
-    [AMQP](http://www.amqp.org/)), or databases (like
-    [PostgreSQL](http://www.postgresql.org/) or
-    [MongoDB](http://www.mongodb.org/))
-  * Forward logs to big data tools (like [Elasticsearch](https://www.elastic.co/),
-    [Apache Kafka](http://kafka.apache.org/), or
-    [Apache Hadoop](http://hadoop.apache.org/))
+* Receive and send [RFC3164](https://tools.ietf.org/html/rfc3164)
+  and [RFC5424](https://tools.ietf.org/html/rfc5424) style syslog
+  messages
+* Receive and send [JSON](http://json.org/) formatted messages
+* Work with any kind of unstructured data
+* Classify and structure logs using built-in parsers (csv-parser(),
+  db-parser(), kv-parser(), etc.)
+* Normalize, crunch, and process logs as they flow through the system
+* Hand over logs for further processing using files, message queues (like
+  [AMQP](http://www.amqp.org/)), or databases (like
+  [PostgreSQL](http://www.postgresql.org/) or
+  [MongoDB](http://www.mongodb.org/))
+* Forward logs to big data tools (like [Elasticsearch](https://www.elastic.co/),
+  [Apache Kafka](http://kafka.apache.org/), or
+  [Apache Hadoop](http://hadoop.apache.org/))
 
 ### Performance
 
-  * syslog-ng provides performance levels comparable to a large
-    cluster when running on a single node
-  * In the simplest use case, it scales up to 600-800k messages per
-    second
-  * But classification, parsing, and filtering still produce several
-    tens of thousands of messages per second
+* syslog-ng provides performance levels comparable to a large
+  cluster when running on a single node
+* In the simplest use case, it scales up to 600-800k messages per
+  second
+* But classification, parsing, and filtering still produce several
+  tens of thousands of messages per second
 
 ### Community
 
-  * syslog-ng is developed by a community of volunteers, the best way to
-    contact us is via our [github project page](http://github.com/syslog-ng/syslog-ng)
-    project, our [gitter channel](https://gitter.im/syslog-ng/syslog-ng) or
-    our [mailing list](https://lists.balabit.hu/mailman/listinfo/syslog-ng).
-  * syslog-ng is integrated into almost all Linux distributions and BSDs, it
-    is also incorporated into a number of products, see our [powered by
-    syslog-ng](https://syslog-ng.com/powered-by-syslog-ng) page for more details.
+* syslog-ng is developed by a community of volunteers, the best way to
+  contact us is via our [github project page](http://github.com/syslog-ng/syslog-ng)
+  project, our [gitter channel](https://gitter.im/syslog-ng/syslog-ng) or
+  our [mailing list](https://lists.balabit.hu/mailman/listinfo/syslog-ng).
+* syslog-ng is integrated into almost all Linux distributions and BSDs, it
+  is also incorporated into a number of products, see our [powered by
+  syslog-ng](https://syslog-ng.com/powered-by-syslog-ng) page for more details.
 
 ### Sponsors
 
-- [Axoflow](https://axoflow.com) is the company of Balazs Scheidler, the original creator and main developer of syslog-ng, and the creators of the Kubernetes Logging Operator. Currently Axoflow is the most active contributor of syslog-ng, and offers commercial support, professional services, and related products.
 - [Balabit](http://www.balabit.com/) is the original commercial sponsor of the syslog-ng project, and was acquired by One Identity in 2018. One Identity offers a commercial edition for syslog-ng, called the syslog-ng Premium Edition.
+- Axoflow is the company of Balazs Scheidler, the original creator and main developer of syslog-ng.
 
 ## Feedback
 
@@ -146,7 +145,6 @@ development libraries are present. The configure script displays a
 summary of enabled features at the end of its run.
 For details, see the [syslog-ng compiling instructions](https://syslog-ng.github.io/admin-guide/030_Installing_syslog-ng/000_Compiling_syslog-ng_from_source).
 
-
 ## Installation from binaries
 
 Binaries are available in various Linux distributions and contributors
@@ -184,13 +182,13 @@ syslog-ng packages are released for the following distribution versions (x86-64)
 
 1. Download and install the release signing key:
 
-    ```
+    ``` shell
     wget -qO - https://ose-repo.syslog-ng.com/apt/syslog-ng-ose-pub.asc | sudo apt-key add -
     ```
 
 2. Add the repository containing the latest build of syslog-ng to the APT sources. For example, stable releases on Ubuntu 22.04:
 
-    ```
+    ``` shell
     echo "deb https://ose-repo.syslog-ng.com/apt/ stable ubuntu-noble" | sudo tee -a /etc/apt/sources.list.d/syslog-ng-ose.list
     ```
 
@@ -202,15 +200,15 @@ Nightly packages are built and released from the git `master` branch everyday.
 
 Use `nightly` instead of `stable` in step 2 to use the nightly APT repository. E.g.:
 
-```
+``` shell
 echo "deb https://ose-repo.syslog-ng.com/apt/ nightly ubuntu-noble" | sudo tee -a /etc/apt/sources.list.d/syslog-ng-ose.list
 ```
 
 Nightly builds can be used for testing purposes (obtaining new features and bugfixes) at the risk of breakage.
 
 ### Arch Linux
 
-```
+``` shell
 # pacman -S syslog-ng
 ```
 
@@ -219,7 +217,7 @@ Nightly builds can be used for testing purposes (obtaining new features and bugf
 syslog-ng is available as a Fedora package that you can install using
 dnf:
 
-# dnf install syslog-ng
+#### dnf install syslog-ng
 
 You can download packages for the latest versions from [here](https://copr.fedoraproject.org/coprs/czanik/).
 
@@ -229,7 +227,7 @@ If you wish to install the latest RPM package that comes from a recent commit in
 
 ### macOS
 
-```
+``` shell
 # brew install syslog-ng
 ```
 
@@ -244,25 +242,12 @@ official [third party page][3rd-party].
 
 Binaries are also available as a Docker image. To find out more, check out the blog post, [Your central log server in Docker](https://syslog-ng.com/blog/central-log-server-docker/).
 
-There are alternatives to the upstream provided, bare syslog-ng image, such
-as the [AxoSyslog image](https://github.com/axoflow/axosyslog-docker/pkgs/container/axosyslog)
-for running syslog-ng in Kubernetes.
-
-  * [AxoSyslog, a cloud native distribution for syslog-ng announcement](https://axoflow.com/cloud-ready-syslog-ng-images/)
-  * [AxoSyslog log collection for Kubernetes](https://axoflow.com/axosyslog-log-collection-for-kubernetes/)
-  * [AxoSyslog Documentation](https://axoflow.com/docs/axosyslog/)
-  * [GitHub](https://github.com/axoflow/axosyslog-docker)
-
 ## Documentation
 
-For the latest, markdown based version, see the [syslog-ng documentation](https://syslog-ng.github.io) center.
+For the latest, markdown based version, see the [syslog-ng documentation](https://syslog-ng.github.io) center. \
 The official documentation of the earlier versions of syslog-ng Open Source Edition provided by One Identity is available
 [here](https://www.syslog-ng.com/technical-documents/doc/syslog-ng-open-source-edition/).
 
-An alternative, markdown based, improved, community maintained version of the
-documentation is available [as AxoSyslog Core documentation](https://axoflow.com/docs/axosyslog-core/).
-[Source code](https://github.com/axoflow/axosyslog-core-docs/)
-
 ## Contributing
 
 If you would like to contribute to syslog-ng, to fix a bug or create a new module, the [syslog-ng pages](https://syslog-ng.github.io/dev-guide/README) helps you take the first steps to working with the code base.
