From a496b4e42acdd5f11d45857245a4427afda68fb8 Mon Sep 17 00:00:00 2001 From: William Desportes Date: Mon, 20 Jun 2022 15:48:14 +0200 Subject: [PATCH] Fix documentation typos (#326) Fixes: #325 --- README.rst | 2 +- docs/index.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 54f6dc0..c884ead 100644 --- a/README.rst +++ b/README.rst @@ -184,7 +184,7 @@ The full set of configuration options are: - ``output`` - str: Directory to place JSON and CSV files in - ``aggregate_json_filename`` - str: filename for the aggregate JSON output file - ``forensic_json_filename`` - str: filename for the forensic JSON output file - - ``ip_db_path`` - str: An optional custim path to a MMDB file from MaxMind or DBIP + - ``ip_db_path`` - str: An optional custom path to a MMDB file from MaxMind or DBIP - ``offline`` - bool: Do not use online queries for geolocation or DNS - ``nameservers`` - str: A comma separated list of DNS resolvers (Default: `Cloudflare's public resolvers`_) - ``dns_timeout`` - float: DNS timeout period diff --git a/docs/index.rst b/docs/index.rst index 91a6ddc..f7b49e3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -176,7 +176,7 @@ The full set of configuration options are: - ``output`` - str: Directory to place JSON and CSV files in - ``aggregate_json_filename`` - str: filename for the aggregate JSON output file - ``forensic_json_filename`` - str: filename for the forensic JSON output file - - ``ip_db_path`` - str: An optional custim path to a MMDB file from MaxMind or DBIP + - ``ip_db_path`` - str: An optional custom path to a MMDB file from MaxMind or DBIP - ``offline`` - bool: Do not use online queries for geolocation or DNS - ``nameservers`` - str: A comma separated list of DNS resolvers (Default: `Cloudflare's public resolvers`_) - ``dns_timeout`` - float: DNS timeout period @@ -540,7 +540,7 @@ Installation .. note:: - If your system is behind a web proxy, you neeed to configure your system + If your system is behind a web proxy, you need to configure your system to use that proxy. To do this, edit ``/etc/environment`` and add your proxy details there, for example: