summaryrefslogtreecommitdiffstats
path: root/doc/add-source.rst
blob: c49692c214c01d8be45a29f3e4b5442e4927934e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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