summaryrefslogtreecommitdiffstats
path: root/doc/add-source.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:43:34 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:43:34 +0000
commit0fcce96a175531ec6042cde1b11a0052aa261dd5 (patch)
tree898a1e161c4984b41e6a732866bd73b24f0f7b7a /doc/add-source.rst
parentInitial commit. (diff)
downloadsuricata-update-0fcce96a175531ec6042cde1b11a0052aa261dd5.tar.xz
suricata-update-0fcce96a175531ec6042cde1b11a0052aa261dd5.zip
Adding upstream version 1.3.2.upstream/1.3.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/add-source.rst')
-rw-r--r--doc/add-source.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/add-source.rst b/doc/add-source.rst
new file mode 100644
index 0000000..c49692c
--- /dev/null
+++ b/doc/add-source.rst
@@ -0,0 +1,45 @@
+################################
+add-source - Add a source by URL
+################################
+
+Synopsis
+========
+
+::
+
+ suricata-update add-source <name> <url>
+
+Description
+===========
+
+The ``add-source`` adds a source to the set of enabled sources by
+URL. It is useful to add a source that is not provided in the index.
+
+Options
+=======
+
+.. option:: --http-header "Header: Value"
+
+ Add an additional HTTP header to requests for this rule source such
+ as a custom API key. Example::
+
+ add-source --http-header "X-API-Key: 1234"
+
+ HTTP basic authentication can be achieved by setting the HTTP Basic
+ Authentication header with ``base64(user1:password1)``. Example::
+
+ add-source --http-header "Authorization: Basic dXNlcjE6cGFzc3dvcmQx"
+
+ HTTP Bearer authentication can be used by setting the HTTP Bearer Authentication header
+ with a OAuth2 token containing printable ASCII characters. Example::
+
+ add-source --http-header "Auhorization: Bearer NjA2MTUOTAx?D+wOm4U/vpXQy0xhl!hSaR7#ENVpK59"
+
+.. option:: --no-checksum
+
+ Skips downloading the checksum URL for the rule source.
+
+Common Options
+==============
+
+.. include:: ./common-options.rst