Skip to content

Commit

Permalink
docs: update url to docs.suricata.io
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonish authored and victorjulien committed May 30, 2023
1 parent 33827be commit f8620d0
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ endif
@echo "updated and managed with the suricata-update tool."
@echo ""
@echo "For more information please see:"
@echo " https://suricata.readthedocs.io/en/latest/rule-management/index.html"
@echo " https://docs.suricata.io/en/latest/rule-management/index.html"
@echo ""

install-library:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Introduction
Installation
------------

https://suricata.readthedocs.io/en/latest/install.html
https://docs.suricata.io/en/latest/install.html

User Guide
----------

You can follow the [Suricata user guide](https://suricata.readthedocs.io/en/latest/) to get started.
You can follow the [Suricata user guide](https://docs.suricata.io/en/latest/) to get started.

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion doc/INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ See doc/userguide/install.rst

An hosted version of this can be found at Read The Docs:

https://suricata.readthedocs.io/en/latest/install.html
https://docs.suricata.io/en/latest/install.html
2 changes: 1 addition & 1 deletion doc/Setting_up_IPSinline_for_Linux.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Autogenerated on 2012-11-29
from - https://suricata.readthedocs.io/en/latest/setting-up-ipsinline-for-linux.html
from - https://docs.suricata.io/en/latest/setting-up-ipsinline-for-linux.html


Setting up IPS/inline for Linux
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ If you are writing or updating *documentation pages*, please:
* when adding diagrams or images, we prefer alternatives that can be generated
automatically, if possible;
* bear in mind that our documentation is published on `Read the Docs <https:/
/suricata.readthedocs.io/en/latest/#suricata-user-guide>`_ and can also be
/docs.suricata.io/en/latest/#suricata-user-guide>`_ and can also be
built to pdf, so it is important that it looks good in such formats.


Expand Down
4 changes: 2 additions & 2 deletions doc/userguide/devguide/codebase/unittests-c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If you would like to compile Suricata with unit tests, enter the following durin

./configure --enable-unittests

The unit tests specific command line options can be found at `Command Line Options <https://suricata.readthedocs.io/en/suricata-6.0.3/command-line-options.html#unit-tests>`_.
The unit tests specific command line options can be found at `Command Line Options <https://docs.suricata.io/en/suricata-6.0.3/command-line-options.html#unit-tests>`_.

Example:
You can run tests specifically on flowbits. This is how you should do that::
Expand All @@ -42,7 +42,7 @@ This will be very verbose. You can also add the ``SC_LOG_OP_FILTER`` to limit th
SC_LOG_LEVEL=Debug SC_LOG_OP_FILTER="(something|somethingelse)" suricata -u

This example will show all lines (debug, info, and all other levels) that contain either something or something else.
Keep in mind the `log level <https://suricata.readthedocs.io/en/latest/manpages/suricata.html#id1>`_ precedence: if you choose *Info* level, for instance, Suricata won't show messages from the other levels.
Keep in mind the `log level <https://docs.suricata.io/en/latest/manpages/suricata.html#id1>`_ precedence: if you choose *Info* level, for instance, Suricata won't show messages from the other levels.

Writing Unit Tests - C codebase
===============================
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Application Layer Frame Support
Baseline
========

- `Suricata rules format <https://suricata.readthedocs.io/en/latest/rules/intro.html>`_
- `Suricata rules format <https://docs.suricata.io/en/latest/rules/intro.html>`_

General Concepts
================
Expand Down
2 changes: 1 addition & 1 deletion lua/fast.lua
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

-- To learn more about all the API functions suricata provides for your lua scripts
-- and the lua output extension in general see:
-- http://suricata.readthedocs.io/en/latest/output/lua-output.html
-- http://docs.suricata.io/en/latest/output/lua-output.html

function init()
local needs = {}
Expand Down
2 changes: 1 addition & 1 deletion src/suricata.h
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
#define DEFAULT_PID_BASENAME "suricata.pid"
#define DEFAULT_PID_FILENAME DEFAULT_PID_DIR DEFAULT_PID_BASENAME

#define DOC_URL "https://suricata.readthedocs.io/en/"
#define DOC_URL "https://docs.suricata.io/en/"
const char *GetDocURL(void);

/* runtime engine control flags */
Expand Down
6 changes: 3 additions & 3 deletions suricata.yaml.in
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# Suricata configuration file. In addition to the comments describing all
# options in this file, full documentation can be found at:
# https://suricata.readthedocs.io/en/latest/configuration/suricata-yaml.html
# https://docs.suricata.io/en/latest/configuration/suricata-yaml.html

# This configuration file generated by Suricata @PACKAGE_VERSION@.
suricata-version: "@MAJOR_MINOR@"
Expand Down Expand Up @@ -217,7 +217,7 @@ outputs:
- dns:
# This configuration uses the new DNS logging format,
# the old configuration is still available:
# https://suricata.readthedocs.io/en/latest/output/eve/eve-json-output.html#dns-v1-format
# https://docs.suricata.io/en/latest/output/eve/eve-json-output.html#dns-v1-format

# As of Suricata 5.0, version 2 of the eve dns output
# format is the default.
Expand Down Expand Up @@ -539,7 +539,7 @@ outputs:
# Lua Output Support - execute lua script to generate alert and event
# output.
# Documented at:
# https://suricata.readthedocs.io/en/latest/output/lua-output.html
# https://docs.suricata.io/en/latest/output/lua-output.html
- lua:
enabled: no
#scripts-dir: /etc/suricata/lua-output/
Expand Down
4 changes: 2 additions & 2 deletions threshold.config
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@
# suppress gen_id <gid>, sig_id <sid>
# suppress gen_id <gid>, sig_id <sid>, track <by_src|by_dst>, ip <ip|subnet>
#
# The options are documented at https://suricata.readthedocs.io/en/latest/configuration/global-thresholds.html
# The options are documented at https://docs.suricata.io/en/latest/configuration/global-thresholds.html
#
# Please note that thresholding can also be set inside a signature. The interaction between rule based thresholds
# and global thresholds is documented here:
# https://suricata.readthedocs.io/en/latest/configuration/global-thresholds.html#global-thresholds-vs-rule-thresholds
# https://docs.suricata.io/en/latest/configuration/global-thresholds.html#global-thresholds-vs-rule-thresholds

# Limit to 10 alerts every 10 seconds for each source host
#threshold gen_id 0, sig_id 0, type limit, track by_src, count 10, seconds 10
Expand Down

0 comments on commit f8620d0

Please sign in to comment.