update docs

1 files changed, 27 insertions, 1 deletions

diff --git a/README.md b/README.md
index f5d89be..d99b0aa 100644
--- a/README.md
+++ b/README.md
@@ -21,9 +21,11 @@ To configure acit, use environment variables. Here's an overview of them, includ
  ACIT_IMAP_USER="bugs@example.com"
  ACIT_IMAP_PASSWD="SuperSecurePassword"
  ACIT_IMAP_SERVER="mail.example.com"
- ACIT_IMAP_PORT=0 # if set to 0, uses default port (993)
+ ACIT_IMAP_PORT=993
  # note we only support IMAP with Implicit TLS.
  # usage of IMAP using STARTTLS and unencrypted imap aren't implemented.
+ ACIT_IMAP_POOL_SIZE=4 # the amount of IMAP connections to make. Note at least 2 is recommended.
+ # a pool size of 1 can lead to it taking ridiculously long to process new email or generate pages.
 
 #
 # SMTP login
@@ -36,6 +38,13 @@ To configure acit, use environment variables. Here's an overview of them, includ
  # note only SMTP using Implicit TLS is supported.
  # STARTTLS and unencrypted SMTP are, just like with IMAP, not implemented.
 
+#
+# Database
+# --------
+MYSQL_USER=acit # username for the mariadb server
+MYSQL_PASSWORD=AnotherSecurePassword # password for said server
+MYSQL_DATABASE=acit # the database to use
+MYSQL_HOST=localhost # the hostname/ip of the server. to define a port, use host:port syntax.
 
 #
 # Email matching/formatting
@@ -62,6 +71,23 @@ To configure acit, use environment variables. Here's an overview of them, includ
  if ACIT_MAIL_DOMAIN is unset, it uses everything behind the at (@) in ACIT_IMAP_USER.
  DOC
 
+#
+# Settings
+# --------
+ACIT_HOME_REDIRECT=about:blank # where to redirect to when someone queries the webroot
+
+# the following option should be the full path to an executable.
+# said executable should return a table of trackers and urls.
+# see #acit-list-trackers below in this README.md # TODO: write mentioned section
+ACIT_LIST_TRACKERS=/usr/lib/acit-list-trackers
 
 ```
 
+# crawling
+Acit makes use of the fact that crawlers will probably often crawl the index page for running certain tasks once in a while. If you are planning on blocking crawlers or want to ensure these tasks run regularly regardless of trackers, curl the webroot (`https://bugs.example.com/` if `bugs.example.com` is your domain) once in a while (every 5 minutes would be nice). Note some of these tasks will also happen when needing relevant resources.
+
+Currently these tasks include:
+
+- Updating the projectlist
+
+