[tor-commits] [sbws/master] Add system physical requirements

[pastly at torproject.org]

commit 5601e2d891d4a4e7302e127eb3c2e0045c0b066c
Author: juga0 <juga at riseup.net>
Date:   Mon Sep 3 12:43:02 2018 +0000

    Add system physical requirements
---
 INSTALL.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/INSTALL.rst b/INSTALL.rst
index 3821aaf..9d5c8f5 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -98,6 +98,31 @@ To build the documentation diagrams::
 
 The generated diagrams will be in ``docs/build/_images/``.
 
+System physical requirements
+-----------------------------
+
+- Bandwidth: at least 20MB/s (160 Mbit/s). The more the better.
+- Free RAM: at least 1.5GB
+- Free disk: at least 3GB
+
+``sbws`` and its dependencies need around 20MB of disk space.
+After 90 days ``sbws`` data files use around 3GB.
+If ``sbws`` is configured to log to files (by default will log to the
+system log), it will need a maximum of 500MB.
+
+It is recommended to set up an automatic disk space monitoring on ``sbws`` data
+and log partitions.
+
+Details about ``sbws`` data:
+
+``sbws`` produces around 100MB of data a day.
+By default raw results' files are compressed after 10 days and deleted after 90.
+The bandwidth files are compressed after 7 days and deleted after 1.
+After 90 days, the disk space used by the data will be aproximately 3GB.
+It will not increase further.
+If ``sbws`` is configured to log to files, logs will be rotated after they
+are 10MB and it will keep 50 rotated log files.
+
 .. _virtualenv: https://virtualenv.pypa.io/en/stable/installation/
 .. _Stem: https://stem.torproject.org/
 .. _socks: http://docs.python-requests.org/en/master/user/advanced/#socks