From a197422f6a576749eb3d3d3501e656243539401c Mon Sep 17 00:00:00 2001
From: realaravinth <realaravinth@batsense.net>
Date: Sat, 11 Jun 2022 18:22:04 +0530
Subject: [PATCH] feat: docs: rm_unverified_users cronjob

---
 docs/INSTALL.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 docs/INSTALL.md

diff --git a/docs/INSTALL.md b/docs/INSTALL.md
new file mode 100644
index 0000000..03afaf0
--- /dev/null
+++ b/docs/INSTALL.md
@@ -0,0 +1,22 @@
+# Installation instructions
+
+## Cron jobs
+
+Run cron job at an interval of your choosing with the following comamnd:
+
+```bash
+python manage.py rm_unverified_users
+```
+
+It will delete all users that are below maximum tolerated duration
+unverified users, as configured in settings.py:
+
+```python
+HOSTEA = {
+	# <--snip--->
+    "ACCOUNTS": {"MAX_VERIFICATION_TOLERANCE_PERIOD": 60 * 60 * 24},  # in seconds
+}
+```
+
+In future, the cronjob will be run as part of the Hostea/Dashbaord and
+hence the current redundancy in configuration and cronjob duration.