Skip to content

Commit ef049e0

Browse files
committed
doc: Satisfied the markdown linter
Signed-off-by: Hofi <[email protected]>
1 parent 66942da commit ef049e0

File tree

1 file changed

+41
-42
lines changed

1 file changed

+41
-42
lines changed

README.md

+41-42
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The simplest configuration accepts system logs from /dev/log (from
1616
applications or forwarded by systemd) and writes everything to a single
1717
file:
1818

19-
```
19+
``` config
2020
@version: 4.7
2121
@include "scl.conf"
2222
@@ -28,7 +28,7 @@ log {
2828

2929
This one additionally processes logs from the network (TCP/514 by default):
3030

31-
```
31+
``` config
3232
@version: 4.7
3333
@include "scl.conf"
3434
@@ -42,7 +42,7 @@ log {
4242
```
4343
This config is designed for structured/application logging, using local submission via JSON, and outputting in key=value format:
4444

45-
```
45+
``` config
4646
@version: 4.7
4747
@include "scl.conf"
4848
@@ -54,59 +54,59 @@ log {
5454

5555
To submit a structured log using `logger`, you might run:
5656

57-
```
57+
```shell
5858
$ logger '@cim: {"name1":"value1", "name2":"value2"}'
5959
```
6060

6161
In which case the resulting message will be:
6262

63-
```
63+
``` text
6464
name1=value1 name2=value2
6565
```
66-
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).
6766

67+
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).
6868

6969
## Features
7070

71-
* Receive and send [RFC3164](https://tools.ietf.org/html/rfc3164)
72-
and [RFC5424](https://tools.ietf.org/html/rfc5424) style syslog
73-
messages
74-
* Receive and send [JSON](http://json.org/) formatted messages
75-
* Work with any kind of unstructured data
76-
* Classify and structure logs using built-in parsers (csv-parser(),
77-
db-parser(), kv-parser(), etc.)
78-
* Normalize, crunch, and process logs as they flow through the system
79-
* Hand over logs for further processing using files, message queues (like
80-
[AMQP](http://www.amqp.org/)), or databases (like
81-
[PostgreSQL](http://www.postgresql.org/) or
82-
[MongoDB](http://www.mongodb.org/))
83-
* Forward logs to big data tools (like [Elasticsearch](https://www.elastic.co/),
84-
[Apache Kafka](http://kafka.apache.org/), or
85-
[Apache Hadoop](http://hadoop.apache.org/))
71+
* Receive and send [RFC3164](https://tools.ietf.org/html/rfc3164)
72+
and [RFC5424](https://tools.ietf.org/html/rfc5424) style syslog
73+
messages
74+
* Receive and send [JSON](http://json.org/) formatted messages
75+
* Work with any kind of unstructured data
76+
* Classify and structure logs using built-in parsers (csv-parser(),
77+
db-parser(), kv-parser(), etc.)
78+
* Normalize, crunch, and process logs as they flow through the system
79+
* Hand over logs for further processing using files, message queues (like
80+
[AMQP](http://www.amqp.org/)), or databases (like
81+
[PostgreSQL](http://www.postgresql.org/) or
82+
[MongoDB](http://www.mongodb.org/))
83+
* Forward logs to big data tools (like [Elasticsearch](https://www.elastic.co/),
84+
[Apache Kafka](http://kafka.apache.org/), or
85+
[Apache Hadoop](http://hadoop.apache.org/))
8686

8787
### Performance
8888

89-
* syslog-ng provides performance levels comparable to a large
90-
cluster when running on a single node
91-
* In the simplest use case, it scales up to 600-800k messages per
92-
second
93-
* But classification, parsing, and filtering still produce several
94-
tens of thousands of messages per second
89+
* syslog-ng provides performance levels comparable to a large
90+
cluster when running on a single node
91+
* In the simplest use case, it scales up to 600-800k messages per
92+
second
93+
* But classification, parsing, and filtering still produce several
94+
tens of thousands of messages per second
9595

9696
### Community
9797

98-
* syslog-ng is developed by a community of volunteers, the best way to
99-
contact us is via our [github project page](http://github.com/syslog-ng/syslog-ng)
100-
project, our [gitter channel](https://gitter.im/syslog-ng/syslog-ng) or
101-
our [mailing list](https://lists.balabit.hu/mailman/listinfo/syslog-ng).
102-
* syslog-ng is integrated into almost all Linux distributions and BSDs, it
103-
is also incorporated into a number of products, see our [powered by
104-
syslog-ng](https://syslog-ng.com/powered-by-syslog-ng) page for more details.
98+
* syslog-ng is developed by a community of volunteers, the best way to
99+
contact us is via our [github project page](http://github.com/syslog-ng/syslog-ng)
100+
project, our [gitter channel](https://gitter.im/syslog-ng/syslog-ng) or
101+
our [mailing list](https://lists.balabit.hu/mailman/listinfo/syslog-ng).
102+
* syslog-ng is integrated into almost all Linux distributions and BSDs, it
103+
is also incorporated into a number of products, see our [powered by
104+
syslog-ng](https://syslog-ng.com/powered-by-syslog-ng) page for more details.
105105

106106
### Sponsors
107107

108108
- [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.
109-
- [Axoflow](https://axoflow.com) is the company of Balazs Scheidler, the original creator and main developer of syslog-ng.
109+
- Axoflow is the company of Balazs Scheidler, the original creator and main developer of syslog-ng.
110110

111111
## Feedback
112112

@@ -145,7 +145,6 @@ development libraries are present. The configure script displays a
145145
summary of enabled features at the end of its run.
146146
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).
147147

148-
149148
## Installation from binaries
150149

151150
Binaries are available in various Linux distributions and contributors
@@ -183,13 +182,13 @@ syslog-ng packages are released for the following distribution versions (x86-64)
183182

184183
1. Download and install the release signing key:
185184

186-
```
185+
``` shell
187186
wget -qO - https://ose-repo.syslog-ng.com/apt/syslog-ng-ose-pub.asc | sudo apt-key add -
188187
```
189188

190189
2. Add the repository containing the latest build of syslog-ng to the APT sources. For example, stable releases on Ubuntu 22.04:
191190

192-
```
191+
``` shell
193192
echo "deb https://ose-repo.syslog-ng.com/apt/ stable ubuntu-noble" | sudo tee -a /etc/apt/sources.list.d/syslog-ng-ose.list
194193
```
195194

@@ -201,15 +200,15 @@ Nightly packages are built and released from the git `master` branch everyday.
201200

202201
Use `nightly` instead of `stable` in step 2 to use the nightly APT repository. E.g.:
203202

204-
```
203+
``` shell
205204
echo "deb https://ose-repo.syslog-ng.com/apt/ nightly ubuntu-noble" | sudo tee -a /etc/apt/sources.list.d/syslog-ng-ose.list
206205
```
207206

208207
Nightly builds can be used for testing purposes (obtaining new features and bugfixes) at the risk of breakage.
209208

210209
### Arch Linux
211210

212-
```
211+
``` shell
213212
# pacman -S syslog-ng
214213
```
215214

@@ -218,7 +217,7 @@ Nightly builds can be used for testing purposes (obtaining new features and bugf
218217
syslog-ng is available as a Fedora package that you can install using
219218
dnf:
220219

221-
# dnf install syslog-ng
220+
#### dnf install syslog-ng
222221

223222
You can download packages for the latest versions from [here](https://copr.fedoraproject.org/coprs/czanik/).
224223

@@ -228,7 +227,7 @@ If you wish to install the latest RPM package that comes from a recent commit in
228227

229228
### macOS
230229

231-
```
230+
``` shell
232231
# brew install syslog-ng
233232
```
234233

0 commit comments

Comments
 (0)