summaryrefslogtreecommitdiffstats
path: root/docs/aoa
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2022-08-14 10:39:32 +0200
committernicolargo <nicolas@nicolargo.com>2022-08-14 10:39:32 +0200
commite00bb4f3365c3eaf2d23ad00042afdda72104e08 (patch)
tree9baee77d2cc3a8748c885542ba106b64a211b73e /docs/aoa
parent9b4afb84cf210774a465cc8698c548c3f3249610 (diff)
parent2ee2ffbd2478301bfb3c03478f237ac7a13576ba (diff)
Merge from develop
Diffstat (limited to 'docs/aoa')
-rw-r--r--docs/aoa/header.rst23
1 files changed, 22 insertions, 1 deletions
diff --git a/docs/aoa/header.rst b/docs/aoa/header.rst
index 2e723413..162c2598 100644
--- a/docs/aoa/header.rst
+++ b/docs/aoa/header.rst
@@ -17,12 +17,33 @@ file under the ``[ip]`` section:
.. code-block:: ini
[ip]
- public_refresh_interval=240
+ public_refresh_interval=300
public_ip_disabled=True
+
**NOTE:** Setting low values for `public_refresh_interval` will result in frequent
HTTP requests to the IP detection servers. Recommended range: 120-600 seconds
+If the Censys options are configured, the public IP address is also analysed (with the same interval)
+and additional information is displayed.
+
+.. code-block:: ini
+ [ip]
+ public_refresh_interval=300
+ public_ip_disabled=True
+ censys_url=https://search.censys.io/api
+ # Get your own credential here: https://search.censys.io/account/api
+ censys_username=CENSYS_API_ID
+ censys_password=CENSYS_API_SECRET
+ # List of fields to be displayed in user interface (comma separated)
+ censys_fields=location:continent,location:country,autonomous_system:name
+
+**Note:** Access to the Censys Search API need an account (https://censys.io/login).
+
+Example:
+
+.. image:: ../_static/ip.png
+
**Connected**:
.. image:: ../_static/connected.png