mirror of https://github.com/OISF/suricata
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
34f53f85bc
One of the lessons of the XZ backdoor story was that just linking to libsystemd to call sd_notify is discouraged by the systemd project: Lennart Poettering: "PSA: In context of the xzpocalypse we now added an example reimplementation of sd_notify() to our man page: https://www.freedesktop.org/software/systemd/man/devel/sd_notify.html#Notes It's pretty comprehensive (i.e. uses it for reload notification too), but still relatively short. In the past, I have been telling anyone who wanted to listen that if all you want is sd_notify() then don't bother linking to libsystemd, since the protocol is stable and should be considered the API, not our C wrapper around it. After all, the protocol is so trivial" From: https://mastodon.social/@pid_eins/112202687764571433 This commit takes the example code and uses it to reimplement the notify logic. The code is enabled if Linux is detected in configure. Since the code won't do anything if the NOTIFY_SOCKET env var isn't set, this should also work fine on systems w/o systemd. Ticket: #6913. |
1 year ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | ||
| _static | ||
| capture-hardware | 2 years ago | |
| configuration | 1 year ago | |
| devguide | ||
| file-extraction | 2 years ago | |
| licenses | ||
| lua | ||
| manpages | 2 years ago | |
| output | ||
| partials | 2 years ago | |
| performance | 2 years ago | |
| reputation | ||
| rule-management | ||
| rules | 1 year ago | |
| setting-up-ipsinline-for-linux | 9 years ago | |
| upgrade | ||
| .gitignore | ||
| Makefile.am | 1 year ago | |
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | ||
| command-line-options.rst | ||
| conf.py | ||
| convert.py | ||
| docutils.conf | ||
| index.rst | ||
| initscripts.rst | ||
| install.rst | ||
| make-sense-alerts.rst | ||
| public-data-sets.rst | ||
| quickstart.rst | ||
| requirements.txt | ||
| security.rst | ||
| setting-up-ipsinline-for-linux.rst | ||
| setting-up-ipsinline-for-windows.rst | ||
| support-status.rst | ||
| unix-socket.rst | ||
| upgrade.rst | 1 year ago | |
| what-is-suricata.rst | ||
README.md
Suricata User Guide
This directory contains the Suricata Guide. The Suricata Developer's guide is included as a chapter of the Guide. The Sphinx Document Generator is used to build the documentation. For a primer os reStructuredText see the reStructuredText Primer.
Verifying Changes
There are a number of output formats to choose from when making the source documentation locally (e.g. html, pdf, man).
The documentation source can be built with make -f Makefile.sphinx html. Substitute the 'html' word for desired output format.
There are different application dependencies based on the output desired.