summaryrefslogtreecommitdiffstats
path: root/docs/aoa/header.rst
diff options
context:
space:
mode:
authorRazCrimson <52282402+RazCrimson@users.noreply.github.com>2022-04-11 01:44:06 +0530
committerRazCrimson <52282402+RazCrimson@users.noreply.github.com>2022-04-11 02:47:06 +0530
commit0a9b9f5f360840b6a47eaf73027db993aa46ece6 (patch)
treebeb11ac3833f19f147dd424c22443bf5fb52c4aa /docs/aoa/header.rst
parent4ea4e4bec581319af2d56d1b8b06a68ce8fdb6b0 (diff)
docs: header - update public address every `t` seconds
Diffstat (limited to 'docs/aoa/header.rst')
-rw-r--r--docs/aoa/header.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/aoa/header.rst b/docs/aoa/header.rst
index f5e7ada8..07819967 100644
--- a/docs/aoa/header.rst
+++ b/docs/aoa/header.rst
@@ -11,6 +11,17 @@ Additionally, on GNU/Linux, it also shows the kernel version.
In client mode, the server connection status is also displayed.
+It is possible to define time interval to be used for refreshing the
+public IP address (default is 300 seconds) from the configuration
+file under the ``[ip]`` section:
+
+.. code-block:: ini
+ [ip]
+ public_refresh_interval=240
+
+**NOTE:** Setting low values will result in frequent HTTP request to
+the IP detection servers. Recommended range: 120-600 seconds
+
**Connected**:
.. image:: ../_static/connected.png