summaryrefslogtreecommitdiffstats
path: root/doc/update-sources.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/update-sources.rst')
-rw-r--r--doc/update-sources.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/update-sources.rst b/doc/update-sources.rst
new file mode 100644
index 0000000..ade1246
--- /dev/null
+++ b/doc/update-sources.rst
@@ -0,0 +1,40 @@
+########################################
+update-sources - Update the source index
+########################################
+
+Synopsis
+========
+
+::
+
+ suricata-update update-sources
+
+Description
+===========
+
+The ``update-sources`` command downloads the latest index of available
+sources.
+
+Options
+=======
+
+.. include:: common-options.rst
+
+Files and Directories
+=====================
+
+``/var/lib/suricata/rules/.cache/index.yaml``
+ Where the downloaded source index is cached.
+
+Environment Variables
+=====================
+
+**SOURCE_INDEX_URL**
+ This environment variable allows the specification of an alternate
+ URL to download the index from.
+
+URLs
+====
+
+``https://www.openinfosecfoundation.org/rules/index.yaml``
+ The default URL used to download the index from.