Skip to content

Commit

Permalink
Merge pull request #1063 from bobidle/fix_urls
Browse files Browse the repository at this point in the history
Fix URLs
  • Loading branch information
rgerhards authored Oct 20, 2024
2 parents 82c2f58 + f59731c commit 994db8a
Show file tree
Hide file tree
Showing 41 changed files with 62 additions and 62 deletions.
6 changes: 3 additions & 3 deletions BUILDS_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ steps in this document.
1. Review the [`README.md`](README.md) file for instructions that cover
installing `pip`, setting up the virtual environment and installing
the latest version of the Sphinx package.
1. Clone the https://github.com/rsyslog-doc.git repo
1. Clone the https://github.com/rsyslog/rsyslog-doc.git repo
1. Merge `master` into the current stable branch (e.g., `v8-stable`)
1. Tag the stable branch
1. Push all changes to the remote
Expand Down Expand Up @@ -105,7 +105,7 @@ is not already installed and known to your installation of Python.
1. Review the [`README.md`](README.md) file for instructions that cover
installing `pip`, setting up the virtual environment and installing
the latest version of the Sphinx package.
1. Run `git clone https://github.com/rsyslog-doc.git`
1. Run `git clone https://github.com/rsyslog/rsyslog-doc.git`
1. Run `git checkout v8.33.0`
1. Run `sphinx -D version="8.33" release="8.33.0" -b html source build`

Expand Down Expand Up @@ -156,7 +156,7 @@ and is useful to identify a dev build from a release set of documentation.
1. Review the [`README.md`](README.md) file for instructions that cover
installing `pip`, setting up the virtual environment and installing
the latest version of the Sphinx package.
1. Run `git clone https://github.com/rsyslog-doc.git`
1. Run `git clone https://github.com/rsyslog/rsyslog-doc.git`
1. Run `git checkout master`
1. Run `sphinx -b html source build` to generate HTML format and
`sphinx -b epub source build` to build an epub file.
2 changes: 1 addition & 1 deletion source/community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ interested in the "backstage", you may find
`Rainer <https://rainer.gerhards.net/>`_'s
`blog <https://rainer.gerhards.net/>`_ an interesting read (filter on
syslog and rsyslog tags). Or meet `Rainer Gerhards at
Facebook <http://www.facebook.com/people/Rainer-Gerhards/1349393098>`_.
Facebook <https://www.facebook.com/rainer.gerhards.1/>`_.
If you would like to use rsyslog source code inside your open source
project, you can do that without any restriction as long as your license
is GPLv3 compatible. If your license is incompatible to GPLv3, you may
Expand Down
2 changes: 1 addition & 1 deletion source/compatibility/v3compatibility.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Compatibility Notes for rsyslog v3
==================================

*Written by* `Rainer Gerhards <http://www.gerhards.net/rainer>`_
*Written by* `Rainer Gerhards <https://rainer.gerhards.net/>`_
*(2008-03-28)*

Rsyslog aims to be a drop-in replacement for sysklogd. However, version
Expand Down
2 changes: 1 addition & 1 deletion source/compatibility/v4compatibility.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Compatibility Notes for rsyslog v4
==================================

*Written by* `Rainer Gerhards <http://www.gerhards.net/rainer>`_
*Written by* `Rainer Gerhards <https://rainer.gerhards.net/>`_
*(2009-07-15)*

The changes introduced in rsyslog v4 are numerous, but not very
Expand Down
2 changes: 1 addition & 1 deletion source/compatibility/v5compatibility.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Compatibility Notes for rsyslog v5
==================================

*Written by* `Rainer Gerhards <http://www.gerhards.net/rainer>`_
*Written by* `Rainer Gerhards <https://rainer.gerhards.net/>`_
*(2009-07-15)*

The changes introduced in rsyslog v5 are numerous, but not very
Expand Down
8 changes: 4 additions & 4 deletions source/concepts/messageparser.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Message parsers in rsyslog
==========================

Written by `Rainer Gerhards <http://www.gerhards.net/rainer>`_
Written by `Rainer Gerhards <https://rainer.gerhards.net/>`_
(2009-11-06)

Intro
Expand Down Expand Up @@ -30,7 +30,7 @@ contributing something back to the project.
But that doesn't answer what a message parser really is. What does it
mean to "parse a message" and, maybe more importantly, what is a
message? To answer these questions correctly, we need to dig down into
the relevant standards. `RFC5424 <http://tools.ietf.org/html/rfc5424>`_
the relevant standards. `RFC5424 <https://datatracker.ietf.org/doc/html/rfc5424>`_
specifies a layered architecture for the syslog protocol:

.. figure:: rfc5424layers.png
Expand All @@ -53,7 +53,7 @@ no two messages can travel within a single UDP packet). In "plain tcp
syslog", the industry standard, LF is used as a frame delimiter (which
also means that no multi-line message can properly be transmitted, a
"design" flaw in plain tcp syslog). In
`RFC5425 <http://tools.ietf.org/html/rfc5425>`_ there is a header in
`RFC5425 <https://datatracker.ietf.org/doc/html/rfc5425>`_ there is a header in
front of each frame that contains the size of the message. With this
framing, any message content can properly be transferred.

Expand Down Expand Up @@ -263,7 +263,7 @@ Which message parsers are available

As of this writing, there exist only two message parsers, one for
RFC5424 format and one for legacy syslog (loosely described in
`RFC3164 <http://tools.ietf.org/html/rfc3164>`_). These parsers are
`RFC3164 <https://datatracker.ietf.org/doc/html/rfc3164>`_). These parsers are
built-in and must not be explicitly loaded. However, message parsers can
be added with relative ease by anyone knowing to code in C. Then, they
can be loaded via $ModLoad just like any other loadable module. It is
Expand Down
2 changes: 1 addition & 1 deletion source/configuration/modules/imdtls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ Used to pass additional OpenSSL configuration commands. This can be used to fine
settings by passing configuration commands to the openssl libray.
OpenSSL Version 1.0.2 or higher is required for this feature.
A list of possible commands and their valid values can be found in the documentation:
https://www.openssl.org/docs/man1.0.2/man3/SSL_CONF_cmd.html
https://docs.openssl.org/1.0.2/man3/SSL_CONF_cmd/

The setting can be single or multiline, each configuration command is separated by linefeed (\n).
Command and value are separated by equal sign (=). Here are a few samples:
Expand Down
2 changes: 1 addition & 1 deletion source/configuration/modules/imhiredis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Purpose
=======

Imhiredis is an input module reading arbitrary entries from Redis.
It uses the `hiredis library <https://github.com/redis/hiredis.git>`_ to query Redis instances using 3 modes:
It uses the `hiredis library <https://github.com/redis/hiredis>`_ to query Redis instances using 3 modes:

- **queues**, using `LIST <https://redis.io/commands#list>`_ commands
- **channels**, using `SUBSCRIBE <https://redis.io/commands#pubsub>`_ commands
Expand Down
2 changes: 1 addition & 1 deletion source/configuration/modules/imhttp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ SupportOctetCountedFraming

"binary", "no", "", "off"

Useful to send data using syslog style message framing, disabled by default. Message framing is described by `RFC 6587 <https://tools.ietf.org/html/rfc6587#section-3.4.1>`_ .
Useful to send data using syslog style message framing, disabled by default. Message framing is described by `RFC 6587 <https://datatracker.ietf.org/doc/html/rfc6587#section-3.4.1>`_ .


RateLimit.Interval
Expand Down
2 changes: 1 addition & 1 deletion source/configuration/modules/immark.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ immark: Mark Message Input Module

=========================== ===========================================================================
**Module Name:**  **immark**
**Author:** `Rainer Gerhards <http://www.gerhards.net/rainer>`_ <[email protected]>
**Author:** `Rainer Gerhards <https://rainer.gerhards.net/>`_ <[email protected]>
=========================== ===========================================================================

Purpose
Expand Down
2 changes: 1 addition & 1 deletion source/configuration/modules/impcap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ file
"word", "none", "no", "none"

This parameter specifies a pcap file to read.
The file must respect the `pcap file format specification <https://www.tcpdump.org/pcap/pcap.html>`_. **If 'file' is not specified, 'interface' must be in order
The file must respect the `pcap file format specification <https://www.tcpdump.org/manpages/pcap-savefile.5.html>`_. **If 'file' is not specified, 'interface' must be in order
for the module to run.**

.. Warning::
Expand Down
2 changes: 1 addition & 1 deletion source/configuration/modules/imrelp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ The setting can be used if tls.tlslib is set to "openssl" to pass configuration
the openssl libray.
OpenSSL Version 1.0.2 or higher is required for this feature.
A list of possible commands and their valid values can be found in the documentation:
https://www.openssl.org/docs/man1.0.2/man3/SSL_CONF_cmd.html
https://docs.openssl.org/1.0.2/man3/SSL_CONF_cmd/

The setting can be single or multiline, each configuration command is separated by linefeed (\n).
Command and value are separated by equal sign (=). Here are a few samples:
Expand Down
4 changes: 2 additions & 2 deletions source/configuration/modules/imtcp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ Specifies the allowed maximum depth for the certificate chain verification.
Support added in v8.2001.0, supported by GTLS and OpenSSL driver.
If not set, the API default will be used.
For OpenSSL, the default is 100 - see the doc for more:
https://www.openssl.org/docs/man1.1.1/man3/SSL_set_verify_depth.html
https://docs.openssl.org/1.1.1/man3/SSL_CTX_set_verify/
For GnuTLS, the default is 5 - see the doc for more:
https://www.gnutls.org/manual/gnutls.html

Expand Down Expand Up @@ -434,7 +434,7 @@ In GNUTLS, this setting determines the handshake algorithms and options for the

**OpenSSL Configuration**

This feature is compatible with OpenSSL Version 1.0.2 and above. It enables the passing of configuration commands to the OpenSSL library. You can find a comprehensive list of commands and their acceptable values in the OpenSSL Documentation, accessible at [OpenSSL Documentation](https://www.openssl.org/docs/man1.0.2/man3/SSL_CONF_cmd.html).
This feature is compatible with OpenSSL Version 1.0.2 and above. It enables the passing of configuration commands to the OpenSSL library. You can find a comprehensive list of commands and their acceptable values in the OpenSSL Documentation, accessible at [OpenSSL Documentation](https://docs.openssl.org/1.0.2/man3/SSL_CONF_cmd/).

**General Configuration Guidelines**

Expand Down
2 changes: 1 addition & 1 deletion source/configuration/modules/imuxsock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ imuxsock: Unix Socket Input Module

=========================== ===========================================================================
**Module Name:**  **imuxsock**
**Author:** `Rainer Gerhards <http://www.gerhards.net/rainer>`_ <[email protected]>
**Author:** `Rainer Gerhards <https://rainer.gerhards.net/>`_ <[email protected]>
=========================== ===========================================================================


Expand Down
2 changes: 1 addition & 1 deletion source/configuration/modules/mmanon.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ obtained. Note that anonymization will break digital signatures on the
message, if they exist.

Please note that log files can also be anonymized via
`SLFA <http://jan.gerhards.net/p/slfa.html>`_ after they
`SLFA <https://jan.gerhards.net/2017/10/12/slfa-release/>`_ after they
have been created.

*How are IP-Addresses defined?*
Expand Down
2 changes: 1 addition & 1 deletion source/configuration/modules/mmpstrucdata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ RFC5424 structured data parsing module (mmpstrucdata)

**Description**:

The mmpstrucdata parses the structured data of `RFC5424 <https://tools.ietf.org/html/rfc5424>`_ into the message json variable tree. The data parsed, if available, is stored under "jsonRoot!rfc5424-sd!...". Please note that only RFC5424 messages will be processed.
The mmpstrucdata parses the structured data of `RFC5424 <https://datatracker.ietf.org/doc/html/rfc5424>`_ into the message json variable tree. The data parsed, if available, is stored under "jsonRoot!rfc5424-sd!...". Please note that only RFC5424 messages will be processed.

The difference of RFC5424 is in the message layout: the SYSLOG-MSG part only contains the structured-data part instead of the normal message part. Further down you can find a example of a structured-data part.

Expand Down
2 changes: 1 addition & 1 deletion source/configuration/modules/omdtls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Used to pass additional OpenSSL configuration commands. This can be used to fine
settings by passing configuration commands to the openssl libray.
OpenSSL Version 1.0.2 or higher is required for this feature.
A list of possible commands and their valid values can be found in the documentation:
https://www.openssl.org/docs/man1.0.2/man3/SSL_CONF_cmd.html
https://docs.openssl.org/1.0.2/man3/SSL_CONF_cmd/

The setting can be single or multiline, each configuration command is separated by linefeed (\n).
Command and value are separated by equal sign (=). Here are a few samples:
Expand Down
4 changes: 2 additions & 2 deletions source/configuration/modules/omfwd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -638,7 +638,7 @@ Specifies the allowed maximum depth for the certificate chain verification.
Support added in v8.2001.0, supported by GTLS and OpenSSL driver.
If not set, the API default will be used.
For OpenSSL, the default is 100 - see the doc for more:
https://www.openssl.org/docs/man1.1.1/man3/SSL_set_verify_depth.html
https://docs.openssl.org/1.1.1/man3/SSL_CTX_set_verify/
For GnuTLS, the default is 5 - see the doc for more:
https://www.gnutls.org/manual/gnutls.html

Expand Down Expand Up @@ -808,7 +808,7 @@ information about priority Strings
For OpenSSL, the setting can be used to pass configuration commands to openssl library.
OpenSSL Version 1.0.2 or higher is required for this feature.
A list of possible commands and their valid values can be found in the documentation:
https://www.openssl.org/docs/man1.0.2/man3/SSL_CONF_cmd.html
https://docs.openssl.org/1.0.2/man3/SSL_CONF_cmd/

The setting can be single or multiline, each configuration command is separated by linefeed (\n).
Command and value are separated by equal sign (=). Here are a few samples:
Expand Down
8 changes: 4 additions & 4 deletions source/configuration/modules/omhttp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Notable Features
- `Message Batching`_, supports several formats.
- Newline concatenation, like the Elasticsearch bulk format.
- JSON Array as a generic batching strategy.
- Kafka REST Proxy format, to support sending data through the `Confluent Kafka REST API <https://docs.confluent.io/current/kafka-rest/docs/index.html>`_ to a Kafka cluster.
- Kafka REST Proxy format, to support sending data through the `Confluent Kafka REST API <https://docs.confluent.io/platform/current/kafka-rest/index.html>`_ to a Kafka cluster.

Configuration Parameters
========================
Expand Down Expand Up @@ -333,14 +333,14 @@ Each message on the "Inputs" line is the templated log line that is fed into the
Inputs: {"msg": "message 1"} {"msg"": "message 2"} {"msg": "message 3"}
Output: [{"msg": "message 1"}, {"msg"": "message 2"}, {"msg": "message 3"}]
3. *kafkarest* - Builds a JSON object that conforms to the `Kafka Rest Proxy specification <https://docs.confluent.io/current/kafka-rest/docs/quickstart.html>`_. This mode requires that each message is parsable JSON, since the plugin parses each message as JSON while building the batch object.
3. *kafkarest* - Builds a JSON object that conforms to the `Kafka Rest Proxy specification <https://docs.confluent.io/platform/current/kafka-rest/quickstart.html>`_. This mode requires that each message is parsable JSON, since the plugin parses each message as JSON while building the batch object.

.. code-block:: text
Inputs: {"msg": "message 1"} {"msg"": "message 2"} {"msg": "message 3"}
Output: {"records": [{"value": {"msg": "message 1"}}, {"value": {"msg": "message 2"}}, {"value": {"msg": "message 3"}}]}
4. *lokirest* - Builds a JSON object that conforms to the `Loki Rest specification <https://github.com/grafana/loki/blob/master/docs/api.md#post-lokiapiv1push>`_. This mode requires that each message is parsable JSON, since the plugin parses each message as JSON while building the batch object. Additionally, the operator is responsible for providing index keys, and message values.
4. *lokirest* - Builds a JSON object that conforms to the `Loki Rest specification <https://github.com/grafana/loki/blob/main/docs/sources/reference/loki-http-api.md#ingest-logs>`_. This mode requires that each message is parsable JSON, since the plugin parses each message as JSON while building the batch object. Additionally, the operator is responsible for providing index keys, and message values.

.. code-block:: text
Expand Down Expand Up @@ -489,7 +489,7 @@ Here you can set the name of a file where all errors will be written to. Any req
{
"request": {
"url": "https://url.com:443/path",
"url": "https://example.com:443/path",
"postdata": "mypayload"
},
"response" : {
Expand Down
2 changes: 1 addition & 1 deletion source/configuration/modules/ommail.rst
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,6 @@ Additional Resources
A more advanced example plus a discussion on using the email feature
inside a reliable system can be found in Rainer's blogpost "`Why is
native email capability an advantage for a
syslogd? <http://rgerhards.blogspot.com/2008/04/why-is-native-email-capability.html>`_\ "
syslogd? <https://rainer.gerhards.net/2008/04/why-is-native-email-capability-an-advantage-for-a-syslogd.html>`_\ "


2 changes: 1 addition & 1 deletion source/configuration/modules/omrelp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ The setting can be used if tls.tlslib is set to "openssl" to pass configuration
the openssl libray.
OpenSSL Version 1.0.2 or higher is required for this feature.
A list of possible commands and their valid values can be found in the documentation:
https://www.openssl.org/docs/man1.0.2/man3/SSL_CONF_cmd.html
https://docs.openssl.org/1.0.2/man3/SSL_CONF_cmd/

The setting can be single or multiline, each configuration command is separated by linefeed (\n).
Command and value are separated by equal sign (=). Here are a few samples:
Expand Down
4 changes: 2 additions & 2 deletions source/configuration/modules/omsnmp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@ In order to decode this OID, you will need to have the
ADISCON-MONITORWARE-MIB and ADISCON-MIB mibs installed on the
receiver side. Downloads of these mib files can be found here:

`http://www.adiscon.org/download/ADISCON-MIB.txt <http://www.adiscon.org/download/ADISCON-MIB.txt>`_
`https://www.adiscon.org/download/ADISCON-MIB.txt <https://www.adiscon.org/download/ADISCON-MIB.txt>`_

`http://www.adiscon.org/download/ADISCON-MONITORWARE-MIB.txt <http://www.adiscon.org/download/ADISCON-MONITORWARE-MIB.txt>`_
`https://www.adiscon.org/download/ADISCON-MONITORWARE-MIB.txt <https://www.adiscon.org/download/ADISCON-MONITORWARE-MIB.txt>`_
Thanks to the net-snmp mailinglist for the help and the
recommendations ;).

Expand Down
2 changes: 1 addition & 1 deletion source/configuration/property_replacer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ options are defined:

**csv**
formats the resulting field (after all modifications) in CSV format as
specified in `RFC 4180 <http://www.ietf.org/rfc/rfc4180.txt>`_. Rsyslog
specified in `RFC 4180 <https://datatracker.ietf.org/doc/html/rfc4180>`_. Rsyslog
will always use double quotes. Note that in order to have full
CSV-formatted text, you need to define a proper template. An example is
this one:
Expand Down
4 changes: 2 additions & 2 deletions source/configuration/templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Template processing
===================

Due to lack of standardization regarding logs formats, when a template is
specified it's supposed to include HEADER, as defined in `RFC5424 <https://tools.ietf.org/html/rfc5424>`_
specified it's supposed to include HEADER, as defined in `RFC5424 <https://datatracker.ietf.org/doc/html/rfc5424>`_

It's very important to have this in mind, and also to understand how
`rsyslog parsing <http://www.rsyslog.com/doc/syslog_parsing.html>`_ works.
Expand Down Expand Up @@ -734,7 +734,7 @@ messages to rsyslog 3.12.5 or above.
**RSYSLOG_SyslogProtocol23Format** - the format specified in IETF's
internet-draft ietf-syslog-protocol-23, which is very close to the actual
syslog standard `RFC5424 <https://tools.ietf.org/html/rfc5424>`_ (we couldn't
syslog standard `RFC5424 <https://datatracker.ietf.org/doc/html/rfc5424>`_ (we couldn't
update this template as things were in production for quite some time when
RFC5424 was finally approved). This format includes several improvements.
You may use this format with all relatively recent versions of rsyslog or syslogd.
Expand Down
2 changes: 1 addition & 1 deletion source/development/generic_design.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Generic design of a syslogd
---------------------------

Written 2007-04-10 by `Rainer Gerhards <https://rainer.gerhards.net>`_
Written 2007-04-10 by `Rainer Gerhards <https://rainer.gerhards.net/>`_

The text below describes a generic approach on how a syslogd can be
implemented. I created this description for some other project, where it
Expand Down
2 changes: 1 addition & 1 deletion source/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ customers to your business!**
applications. You may also read my blog post on the future of
liblogging, which contains interesting information about the `future
of RFC 3195 in
rsyslog <http://rgerhards.blogspot.com/2007/09/where-is-liblogging-heading-to.html>`_.
rsyslog <https://rainer.gerhards.net/2007/09/where-is-liblogging-heading-to.html>`_.

To see when each feature was added, see the `rsyslog change
log <http://www.rsyslog.com/Topic4.phtml>`_ (online only).
2 changes: 1 addition & 1 deletion source/historical/module_devel.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Developing rsyslog modules (outdated)
=====================================

*Written by `Rainer Gerhards* <https://rainer.gerhards.net>`_ *(2007-07-28)*
*Written by `Rainer Gerhards* <https://rainer.gerhards.net/>`_ *(2007-07-28)*

**This document is outdated and primarily contains historical
information. Do not trust it to build code. It currently is under
Expand Down
Loading

0 comments on commit 994db8a

Please sign in to comment.