Merge branch 'edge'

.dockerignore

@@ -1,24 +1,8 @@
+Dockerfile
+.dockerignore
+.gitignore
 .git
-logs
+src/logs
 .github
-docs
-node_modules
-coverage
-.nyc_output
-.idea
-*.bak
-*.sqlite
-*.sqlite*
-*.json
-*.json5
-*.yaml
-*.yml
-
-
-# exceptions
-!heroku.yml
-!app.json
-!.nycrc.json
-!.mocharc.json
-!tsconfig.json
-!package*.json
+/docs/
+/node_modules/

.gitignore

@@ -381,9 +381,7 @@ dist
 .pnp.*
 
 **/src/**/*.js
-**/tests/**/*.js
-**/tests/**/*.map
-!src/Web/assets/**
+!src/Web/assets/public/yaml/*
 **/src/**/*.map
 /**/*.sqlite
 /**/*.bak

.idea/redditcontextbot.iml

@@ -2,13 +2,10 @@
 <module type="WEB_MODULE" version="4">
   <component name="NewModuleRootManager">
     <content url="file://$MODULE_DIR$">
-      <sourceFolder url="file://$MODULE_DIR$/tests" isTestSource="true" />
       <excludeFolder url="file://$MODULE_DIR$/temp" />
       <excludeFolder url="file://$MODULE_DIR$/.tmp" />
       <excludeFolder url="file://$MODULE_DIR$/tmp" />
       <excludeFolder url="file://$MODULE_DIR$/src/logs" />
-      <excludeFolder url="file://$MODULE_DIR$/coverage" />
-      <excludeFolder url="file://$MODULE_DIR$/.nyc_output" />
     </content>
     <content url="file://$MODULE_DIR$/node_modules" />
     <orderEntry type="inheritedJdk" />

.mocharc.json

@@ -1,4 +0,0 @@
-{
-  "require": ["./register.js", "source-map-support/register"],
-  "reporter": "dot"
-}

.nvmrc

@@ -1 +0,0 @@
-16.14.2

.nycrc.json

@@ -1,24 +0,0 @@
-{
-  "extends": "@istanbuljs/nyc-config-typescript",
-  "exclude": [
-    "node_modules/",
-    "**/src/Schema/**",
-    "**/src/Web/assets/**",
-    "**/tests/**",
-    "register.js",
-    "**/src/**/*.d.ts"
-  ],
-  "include": [
-    "**/src/**/*.ts",
-    "**/src/**/*.js",
-    "**/src/**/*.js.map"
-  ],
-  "extension": [
-    ".ts"
-  ],
-  "reporter": [
-    "text-summary",
-    "html"
-  ],
-  "report-dir": "./coverage"
-}

Dockerfile

@@ -1,133 +1,41 @@
-FROM lsiobase/alpine:3.15 as base
+FROM node:16-alpine3.14 as base
 
 ENV TZ=Etc/GMT
 
-# borrowed from node/alpine:3.15
-# https://github.com/nodejs/docker-node/blob/main/16/alpine3.15/Dockerfile
-#
-# Start of node docker stuff
-#
-ENV NODE_VERSION 16.14.2
-
-RUN apk add --no-cache \
-        libstdc++ \
-    && apk add --no-cache --virtual .build-deps \
-        curl \
-    && ARCH= && alpineArch="$(apk --print-arch)" \
-      && case "${alpineArch##*-}" in \
-        x86_64) \
-          ARCH='x64' \
-          CHECKSUM="a6dc255e1ef1f20372306eec932b4a3648575c6d3024bcd685b8efc93dc95569" \
-          ;; \
-        *) ;; \
-      esac \
-  && if [ -n "${CHECKSUM}" ]; then \
-    set -eu; \
-    curl -fsSLO --compressed "https://unofficial-builds.nodejs.org/download/release/v$NODE_VERSION/node-v$NODE_VERSION-linux-$ARCH-musl.tar.xz"; \
-    echo "$CHECKSUM  node-v$NODE_VERSION-linux-$ARCH-musl.tar.xz" | sha256sum -c - \
-      && tar -xJf "node-v$NODE_VERSION-linux-$ARCH-musl.tar.xz" -C /usr/local --strip-components=1 --no-same-owner \
-      && ln -s /usr/local/bin/node /usr/local/bin/nodejs; \
-  else \
-    echo "Building from source" \
-    # backup build
-    && apk add --no-cache --virtual .build-deps-full \
-        binutils-gold \
-        g++ \
-        gcc \
-        gnupg \
-        libgcc \
-        linux-headers \
-        make \
-        python3 \
-    # gpg keys listed at https://github.com/nodejs/node#release-keys
-    && for key in \
-      4ED778F539E3634C779C87C6D7062848A1AB005C \
-      141F07595B7B3FFE74309A937405533BE57C7D57 \
-      94AE36675C464D64BAFA68DD7434390BDBE9B9C5 \
-      74F12602B6F1C4E913FAA37AD3A89613643B6201 \
-      71DCFD284A79C3B38668286BC97EC7A07EDE3FC1 \
-      8FCCA13FEF1D0C2E91008E09770F7A9A5AE15600 \
-      C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8 \
-      C82FA3AE1CBEDC6BE46B9360C43CEC45C17AB93C \
-      DD8F2338BAE7501E3DD5AC78C273792F7D83545D \
-      A48C2BEE680E841632CD4E44F07496B3EB3C1762 \
-      108F52B48DB57BB0CC439B2997B01419BD92F80A \
-      B9E2F5981AA6E0CD28160D9FF13993A75599653C \
-    ; do \
-      gpg --batch --keyserver hkps://keys.openpgp.org --recv-keys "$key" || \
-      gpg --batch --keyserver keyserver.ubuntu.com --recv-keys "$key" ; \
-    done \
-    && curl -fsSLO --compressed "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION.tar.xz" \
-    && curl -fsSLO --compressed "https://nodejs.org/dist/v$NODE_VERSION/SHASUMS256.txt.asc" \
-    && gpg --batch --decrypt --output SHASUMS256.txt SHASUMS256.txt.asc \
-    && grep " node-v$NODE_VERSION.tar.xz\$" SHASUMS256.txt | sha256sum -c - \
-    && tar -xf "node-v$NODE_VERSION.tar.xz" \
-    && cd "node-v$NODE_VERSION" \
-    && ./configure \
-    && make -j$(getconf _NPROCESSORS_ONLN) V= \
-    && make install \
-    && apk del .build-deps-full \
-    && cd .. \
-    && rm -Rf "node-v$NODE_VERSION" \
-    && rm "node-v$NODE_VERSION.tar.xz" SHASUMS256.txt.asc SHASUMS256.txt; \
-  fi \
-  && rm -f "node-v$NODE_VERSION-linux-$ARCH-musl.tar.xz" \
-  && apk del .build-deps \
-  # smoke tests
-  && node --version \
-  && npm --version
-#
-# end of docker node stuff
-#
-
 # vips required to run sharp library for image comparison
 RUN echo "http://dl-4.alpinelinux.org/alpine/v3.14/community" >> /etc/apk/repositories \
     && apk --no-cache add vips
 
 RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
 
-ARG data_dir=/config
-VOLUME $data_dir
-ENV DATA_DIR=$data_dir
-
-COPY docker/root/ /
-
-WORKDIR /app
+WORKDIR /usr/app
 
 FROM base as build
 
-COPY --chown=abc:abc package*.json ./
-COPY --chown=abc:abc tsconfig.json .
+COPY package*.json ./
+COPY tsconfig.json .
 
 RUN npm install
 
-COPY --chown=abc:abc . /app
+ADD . /usr/app
 
 RUN npm run build && rm -rf node_modules
 
 FROM base as app
 
-COPY --from=build --chown=abc:abc /app /app
+COPY --from=build /usr/app /usr/app
 
-RUN npm install --production \
-    && npm cache clean --force \
-    && chown abc:abc node_modules \
-    && rm -rf node_modules/ts-node \
-    && rm -rf node_modules/typescript
+RUN npm install --production
 
 ENV NPM_CONFIG_LOGLEVEL debug
 
-# can set database to use more performant better-sqlite3 since we control everything
-ENV DB_DRIVER=better-sqlite3
-
-# NODE_ARGS are expanded after `node` command in the entrypoint IE "node {NODE_ARGS} src/index.js run"
-# by default enforce better memory mangement by limiting max long-lived GC space to 512MB
-ENV NODE_ARGS="--max_old_space_size=512"
+ARG log_dir=/home/node/logs
+RUN mkdir -p $log_dir
+VOLUME $log_dir
+ENV LOG_DIR=$log_dir
 
 ARG webPort=8085
 ENV PORT=$webPort
 EXPOSE $PORT
 
-# convenience variable for more helpful error messages
-ENV IS_DOCKER=true
-
+CMD [ "node", "src/index.js", "run" ]

README.md

@@ -7,44 +7,33 @@ alt="ContextMod logo" width="180" height="176">
 
 It is designed to help fill in the gaps for [automoderator](https://www.reddit.com/wiki/automoderator/full-documentation) in regard to more complex behavior with a focus on **user-history based moderation.**
 
-An example of the above that Context Bot can do:
+An example of the above that Context Bot can do now:
 
 > * On a new submission, check if the user has also posted the same link in **N** number of other subreddits within a timeframe/# of posts
 > * On a new submission or comment, check if the user has had any activity (sub/comment) in **N** set of subreddits within a timeframe/# of posts
 >
 >In either instance Context Bot can then perform any action a moderator can (comment, report, remove, lock, etc...) against that user, comment, or submission.
 
-Feature Highlights for **Moderators:**
-
-* Complete bot **autonomy**. YAML config is [stored in your subreddit's wiki](/docs/subreddit/gettingStarted.md#setup-wiki-page) (like automoderator)
-* Simple rule-action behavior can be combined to create **complex behavior detection**
-* Support Activity filtering based on:
-  * [Author criteria](/docs/subreddit/components/README.md#author-filter) (name, css flair/text, age, karma, moderator status, [Toolbox User Notes](https://www.reddit.com/r/toolbox/wiki/docs/usernotes), and more!)
-  * [Activity state](/docs/subreddit/components/README.md#item-filter) (removed, locked, distinguished, etc...)
-  * State of Subreddit Activity is in [Subreddit](/docs/subreddit/components/README.md#subreddit-filter) (nsfw, name, profile, etc...)
-* Rules and Actions support [named references](/docs/subreddit/components/README.md#named-rules) -- **write once, reference anywhere**
-* Powerful [logic control](/docs/subreddit/components/advancedConcepts/flowControl.md) (if, then, goto)
-* [Delay/re-process activities](/docs/subreddit/components/README.md#dispatch) using arbitrary rules
-* [**Image Comparisons**](/docs/imageComparison.md) via fingerprinting and/or pixel differences
-* [**Repost detection**](/docs/subreddit/components/repost) with support for external services (youtube, etc...)
-* Event notification via Discord
-* [**Web interface**](#web-ui-and-screenshots) for monitoring, administration, and oauth bot authentication
-* [**Placeholders**](/docs/subreddit/actionTemplating.md) (like automoderator) can be configured via a wiki page or raw text and supports [mustache](https://mustache.github.io) templating
-* [**Partial Configurations**](/docs/subreddit/components/README.md#partial-configurations) -- offload parts of your configuration to shared locations to consolidate logic between multiple subreddits
-
-Feature highlights for **Developers and Hosting (Operators):**
-
-* [Server/client architecture](/docs/serverClientArchitecture.md)
+Some feature highlights:
+* Simple rule-action behavior can be combined to create any level of complexity in behavior
+* Server/client architecture
   * Default/no configuration runs "All In One" behavior
   * Additional configuration allows web interface to connect to multiple servers
   * Each server instance can run multiple reddit accounts as bots
-* Global/subreddit-level [**caching**](/docs/operator/caching.md) of Reddit APIs responses and CM results
-* [Database Persistence](/docs/operator/database.md) using SQLite, MySql, or Postgres
-  * Audit trails for bot activity
-  * Historical statistics
-* [Docker container support](/docs/operator/installation.md#docker-recommended)
-* Easy, UI-based [OAuth authentication](/docs/operator/addingBot.md) for adding Bots and moderator dashboard
-* Integration with [InfluxDB](https://www.influxdata.com) for detailed [time-series metrics](/docs/operator/database.md#influx) and a pre-built [Grafana](https://grafana.com) [dashboard](/docs/operator/database.md#grafana)
+* **Per-subreddit configuration** is handled by YAML (**like automoderator!**) or JSON stored in the subreddit wiki
+* Any text-based actions (comment, submission, message, usernotes, ban, etc...) can be configured via a wiki page or raw text and supports [mustache](https://mustache.github.io) [templating](/docs/actionTemplating.md)
+* History-based rules support multiple "valid window" types -- [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations), [Day.js Durations](https://day.js.org/docs/en/durations/creating), and submission/comment count limits.
+* Support Activity skipping based on:
+  * Author criteria (name, css flair/text, age, karma, moderator status, and [Toolbox User Notes](https://www.reddit.com/r/toolbox/wiki/docs/usernotes))
+  * Activity state (removed, locked, distinguished, etc.)
+* Rules and Actions support named references (write once, reference anywhere)
+* [**Image Comparisons**](/docs/imageComparison.md) via fingerprinting and/or pixel differences
+* [**Repost detection**](/docs/examples/repost) with support for external services (youtube, etc...)
+* Global/subreddit-level **API caching**
+* Support for [Toolbox User Notes](https://www.reddit.com/r/toolbox/wiki/docs/usernotes) as criteria or Actions (writing notes)
+* Docker container support
+* Event notification via Discord
+* **Web interface** for monitoring, administration, and oauth bot authentication
 
 # Table of Contents
 
@@ -57,7 +46,7 @@ Feature highlights for **Developers and Hosting (Operators):**
 
 Each subreddit using the RCB bot configures its behavior via their own wiki page. 
 
-When a monitored **Activity** (new comment/submission, new modqueue item, etc.) is detected the bot runs through a list of [**Checks**](/docs/subreddit/components/README.md#checks) to determine what to do with the **Activity** from that Event. Each **Check** consists of :
+When a monitored **Event** (new comment/submission, new modqueue item, etc.) is detected the bot runs through a list of **Checks** to determine what to do with the **Activity** from that Event. Each **Check** consists of :
 
 #### Kind
 
@@ -65,11 +54,11 @@ Is this check for a submission or comment?
 
 #### Rules
 
-A list of [**Rules**](/docs/subreddit/components/README.md#rules) to run against the **Activity**. Triggered Rules can cause the whole Check to trigger and run its **Actions**
+A list of **Rule** objects to run against the **Activity**. Triggered Rules can cause the whole Check to trigger and run its **Actions**
 
 #### Actions
 
-A list of [**Actions**](/docs/subreddit/components/README.md#actions) that describe what the bot should do with the **Activity** or **Author** of the activity (comment, remove, approve, etc.). The bot will run **all** Actions in this list.
+A list of **Action** objects that describe what the bot should do with the **Activity** or **Author** of the activity (comment, remove, approve, etc.). The bot will run **all** Actions in this list.
 
 ___
 
@@ -79,7 +68,7 @@ When an Event occurs all Checks of that type are run in the order they were list
 
 ___
 
-[Learn more about the RCB lifecycle and core concepts in the docs.](/docs/README.md#how-it-works)
+[Learn more about the RCB lifecycle and core concepts in the docs.](/docs#how-it-works)
 
 ## Getting Started
 
@@ -87,20 +76,20 @@ ___
 
 This guide is for users who want to **run their own bot on a ContextMod instance.**
 
-See the [Operator's Getting Started Guide](/docs/operator/gettingStarted.md)
+See the [Operator's Getting Started Guide](/docs/gettingStartedOperator.md)
 
 #### Moderators
 
 This guide is for **reddit moderators** who want to configure an existing CM bot to run on their subreddit.
 
-See the [Moderator's Getting Started Guide](/docs/subreddit/gettingStarted.md)
+See the [Moderator's Getting Started Guide](/docs/gettingStartedMod.md)
 
 ## Configuration and Documentation
 
 Context Bot's configuration can be written in YAML (like automoderator) or [JSON5](https://json5.org/). Its schema conforms to [JSON Schema Draft 7](https://json-schema.org/). Additionally, many **operator** settings can be passed via command line or environmental variables.
 
-* For **operators** (running the bot instance) see the [Operator Configuration](/docs/operator/configuration.md) guide
-* For **moderators** consult the [app schema and examples folder](/docs/README.md#configuration-and-usage)
+* For **operators** (running the bot instance) see the [Operator Configuration](/docs/operatorConfiguration.md) guide
+* For **moderators** consult the [app schema and examples folder](/docs/#configuration-and-usage)
 
 [**Check the full docs for in-depth explanations of all concepts and examples**](/docs)
 
@@ -124,7 +113,7 @@ CM comes equipped with a dashboard designed for use by both moderators and bot o
 
 ### Bot Setup/Authentication
 
-A bot oauth helper allows operators to define oauth credentials/permissions and then generate unique, one-time invite links that allow moderators to authenticate their own bots without operator assistance. [Learn more about using the oauth helper.](docs/operator/addingBot.md#cm-oauth-helper-recommended)
+A bot oauth helper allows operators to define oauth credentials/permissions and then generate unique, one-time invite links that allow moderators to authenticate their own bots without operator assistance. [Learn more about using the oauth helper.](docs/botAuthentication.md#cm-oauth-helper-recommended)
 
 Operator view/invite link generation:
 
@@ -147,13 +136,6 @@ A built-in editor using [monaco-editor](https://microsoft.github.io/monaco-edito
 
 ![Configuration View](docs/images/editor.jpg)
 
-### [Grafana Dashboard](/docs/operator/database.md#grafana)
-
-* Overall stats (active bots/subreddits, api calls, per second/hour/minute activity ingest)
-* Over time graphs for events, per subreddit, and for individual rules/check/actions
-
-![Grafana Dashboard](/docs/images/grafana.jpg)
-
 ## License
 
 [MIT](/LICENSE)

docker/root/etc/cont-init.d/10-config

@@ -1,14 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# used https://github.com/linuxserver/docker-plex as a template
-
-# make data folder if not /config
-if [ ! -d "${DATA_DIR}" ]; then \
-mkdir -p "${DATA_DIR}"
-chown -R abc:abc /config
-fi
-
-# permissions
-chown abc:abc \
-  /config \
-  /config/*

docker/root/etc/services.d/node/run

@@ -1,9 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# used https://github.com/linuxserver/docker-plex as a template
-
-# NODE_ARGS can be passed by ENV in docker command like "docker run foxxmd/context-mod -e NODE_ARGS=--optimize_for_size"
-
-exec \
-	s6-setuidgid abc \
-	/usr/local/bin/node $NODE_ARGS /app/src/index.js run

docs/README.md

@@ -5,25 +5,33 @@
 * [Getting Started](#getting-started)
 * [How It Works](#how-it-works)
 * [Concepts](#concepts)
-  * [Event](#event)
-  * [Activity](#activity)
   * [Run](#runs)
   * [Check](#checks)
   * [Rule](#rule)
-    * [Available Rules](#available-rules)
+    * [Examples](#available-rules)
   * [Rule Set](#rule-set)
+    * [Examples](#rule-set-examples)
   * [Action](#action)
-    * [Available Actions](#available-actions)
+    * [Examples](#available-actions)
   * [Filters](#filters)
 * [Configuration and Usage](#configuration-and-usage)
+* [Common Resources](#common-resources)
+  * [Activities `window`](#activities-window)
+  * [Comparisons](#thresholds-and-comparisons)
+  * [Activity Templating](/docs/actionTemplating.md)
+  * [Image Comparisons](#image-comparisons)
+* [Best Practices](#best-practices)
+  * [Named Rules](#named-rules)
+  * [Rule Order](#rule-order)
+  * [Caching](#caching)
 * FAQ
 
 ## Getting Started
 
 Review **at least** the **How It Works** and **Concepts** below, then:
 
-* For **Operators** (running a bot instance) refer to [**Operator Getting Started**](/docs/operator/gettingStarted.md)  guide
-* For **Moderators** (configuring an existing bot for your subreddit) refer to the [**Moderator Getting Started**](/docs/subreddit/gettingStarted.md) guide
+* For **Operators** (running a bot instance) refer to [**Operator Getting Started**](/docs/gettingStartedOperator.md)  guide
+* For **Moderators** (configuring an existing bot for your subreddit) refer to the [**Moderator Getting Started**](/docs/gettingStartedMod.md) guide
 
 ## How It Works
 
@@ -42,9 +50,9 @@ Expand the section below for a simplified flow diagram of how CM processes an in
 
 CM's lifecycle looks like this:
 
-#### 1) A new Activity in your subreddit is received by CM
+#### 1) A new event in your subreddit is received by CM
 
-The Activities CM watches for are configured by you. These can be new modqueue/unmoderated items, submissions, or comments.
+The events CM watches for are configured by you. These can be new modqueue/unmoderated items, submissions, or comments.
 
 #### 2) CM sequentially processes each Run in your configuration
 
@@ -73,14 +81,6 @@ Until all Runs have been processed.
 
 Core, high-level concepts regarding how CM works.
 
-### Event
-
-An **Event** refers to the [Activity](#activity) (Comment or Submission) CM receives to process as well as the results of processing that Activity.
-
-### Activity
-
-An Activity is a Comment or Submission from Reddit.
-
 ### Runs
 
 A **Run** is made up of a set of **Checks** that represent a group of related behaviors the bot should check for or perform -- that are independent of any other behaviors the Bot should perform.
@@ -90,13 +90,11 @@ An example of Runs:
 * A group of Checks that look for missing flairs on a user or a new submission and flair accordingly
 * A group of Checks that detect spam or self-promotion and then remove those activities
 
-Both group of Checks are independent of each other (don't have any patterns or actions in common).
-
-[Full Documentation for Runs](/docs/subreddit/components/README.md#runs)
+Both group of Checks are independent of each other (don't have any patterns or actions in common). Learn more about using [Runs and **Flow Control** to control how CM behaves.](/docs/examples/advancedConcepts/flowControl.md)
 
 ### Checks
 
-A **Check** is the main logical unit of behavior for the bot. It is equivalent to "if X then Y". A Check is composed of:
+A **Check** is the main logical unit of behavior for the bot. It is equivalent to "if X then Y". A Check is comprised of:
 
 * One or more **Rules** that are tested against an **Activity**
 * One of more **Actions** that are performed when the **Rules** are satisfied
@@ -105,19 +103,37 @@ A Run can be made up of one or more **Checks** that are processed **in the order
 
 Once a Check is **triggered** (its Rules are satisfied and Actions performed) all subsequent Checks are skipped.
 
-[Full Documentation for Checks](/docs/subreddit/components/README.md#checks)
+Some other important concepts regarding Checks:
+
+* All Checks have a **kind** (defined in the configuration) that determine if they should run on **Submissions** or **Comments**
+* Checks have a **condition** property that determines when they are considered **triggered**
+  * If the **condition** is `AND` then ALL of their **Rules** must be **triggered** for the Check to be **triggered**
+  * If the **condition** is `OR` then if ANY **Rules** is triggered **triggered** then the Check is **triggered**
+
+Examples of different types of Checks can be found in the [subreddit-ready examples.](/docs/examples/subredditReady)
   
 ### Rule
 
 A **Rule** is some set of **criteria** (conditions) that are tested against an Activity (comment/submission), a User, or a User's history. A Rule is considered **triggered** when the **criteria** for that rule are found to be **true** for whatever is being tested against.
 
+There are generally three main properties for a Rule:
+
+* **Criteria** -- The conditions/values you want to test for.
+* **Activities Window** -- If applicable, the range of activities that the **criteria** will be tested against.
+* **Rule-specific options** -- Any number of options that modify how the **criteria** are tested.
+
 CM has different **Rules** that can test against different types of behavior and aspects of a User, their history, and the Activity (submission/common) being checked.
 
-[Full Documentation for Rules](/docs/subreddit/components/README.md#rules)
-
 #### Available Rules
+Find detailed descriptions of all the Rules, with examples, below:
 
-All available rules can be found in the [components documentation](/docs/subreddit/components/README.md#rules)
+* [Attribution](/docs/examples/attribution)
+* [Recent Activity](/docs/examples/recentActivity)
+* [Repeat Activity](/docs/examples/repeatActivity)
+* [History](/docs/examples/history)
+* [Author](/docs/examples/author)
+* [Regex](/docs/examples/regex)
+* [Repost](/docs/examples/repost)
 
 ### Rule Set
 
@@ -127,7 +143,34 @@ Rule Sets can be used interchangeably with other **Rules** and **Rule Sets** in
 
 They allow you to create more complex trigger behavior by combining multiple rules into one "parent rule".
 
-[Rule Sets Documentation](/docs/subreddit/components/README.md#rule-sets)
+It consists of:
+
+* **condition** -- Under what condition should the Rule Set be considered triggered?
+  * `AND` -- ALL Rules in the Rule Set must **trigger** in order for the Rule Set to **trigger.**
+  * `OR` -- ANY Rule in the Rule Set that is **triggered** will trigger the whole Rule Set.
+* **rules** -- The **Rules** for the Rule Set.
+
+Example
+
+YAML
+```yaml
+condition: AND
+# rules are an array
+rules:
+ - aRule
+```
+JSON
+```json5
+{
+  "condition": "AND",
+  "rules": [
+    // all the rules go here
+  ]
+}
+```
+#### Rule Set Examples
+
+* [**Detailed Example**](/docs/examples/advancedConcepts/ruleSets.json5)
 
 ### Action
 
@@ -135,27 +178,208 @@ An **Action** is some action the bot can take against the checked Activity (comm
 
 #### Available Actions
 
-[Available Actions Documentation](/docs/subreddit/components/README.md#list-of-actions)
+* Remove (Comment/Submission)
+* Flair (Submission)
+* User Flair (Submission/Comment)
+* Ban (User)
+* Approve (Comment/Submission)
+* Comment (Reply to Comment/Submission)
+* Lock (Comment/Submission)
+* Report (Comment/Submission)
+* [UserNote](/docs/examples/userNotes) (User, when /r/Toolbox is used)
+
+For detailed explanation and options of what individual Actions can do [see the links in the `actions` property in the schema.](https://json-schema.app/view/%23/%23%2Fdefinitions%2FSubmissionCheckJson?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json)
 
 ### Filters
 
-**Runs, Checks, Rules, and Actions** all have two additional (optional) criteria "pre-tests". These tests are different from rules/checks in these ways:
+**Runs, Checks, Rules, and Actions** all have two additional (optional) criteria "tests". These tests behave differently than rule/check triggers in that:
 
-* Filters test against the **current state** of the Activity, the Author of the Activity, or the Subreddit of the Activity -- rather than looking at history/context/etc...
-* Filter test results only determine if the Run, Check, Rule, or Action **should run** -- rather than triggering it
-  * When the filter test **passes** the thing being tested continues to process as usual
-  * When the filter test **fails** the thing being tested **fails**.
+* When they **pass** the thing being tested continues to process as usual
+* When they **fail** the thing being tested **is skipped, not failed.**
 
-[Full Documentation for Filters](/docs/subreddit/components/README.md#filters)
+For **Runs**, **Checks**, and **Actions** skipping means that the thing is not processed. The Action is not run, the Check is not triggered.
+
+In the context of **Rules** (in a Check) skipping means the Rule does not get run BUT it does not fail. The Check will continue processing as if the Rule did not exist. However, if ALL Rules in a Check are skipped then the Check does "fail" (is not triggered).
+
+#### Available Filters
+
+##### Item Filter (`itemIs`)
+
+This filter will test against the **state of the Activity currently being run.** Some criteria available to test against IE "Is the activity...":
+
+* removed
+* nsfw
+* locked
+* stickied
+* deleted
+* etc...
+
+The `itemIs` filter is made up of an array (list) of `State` criteria objects. **All** criteria in the array must pass for this filter to pass.
+
+There are two different State criteria depending on what type of Activity is being tested:
+
+* Submission -- [SubmissionState](https://json-schema.app/view/%23/%23%2Fdefinitions%2FSubmissionCheckJson/%23%2Fdefinitions%2FSubmissionState?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json)
+* Comment -- [CommentState](https://json-schema.app/view/%23/%23%2Fdefinitions%2FCommentCheckJson/%23%2Fdefinitions%2FCommentState?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json)
+
+##### Author Filter (`authorIs`)
+
+This filter will test against the **Author of the Activity currently being run.** Some criteria available to test against:
+
+* account age
+* comment, link, and total karma
+* subreddit flair text/css
+* name
+* User Notes
+* verified
+* etc...
+
+The `authorIs` filter is made up two (optional) lists of [`AuthorCriteria`](https://json-schema.app/view/%23/%23%2Fdefinitions%2FSubmissionCheckJson/%23%2Fdefinitions%2FAuthorOptions/%23%2Fdefinitions%2FAuthorCriteria?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) criteria objects that define how the test behaves:
+
+* `include` list -- If **any** `AuthorCriteria` from this list passes then the `authorIs` test passes
+* `exclude` list -- If **any** `AuthorCriteria` from this list **does not pass** then the `authorIs` test passes. **Note:** This property is ignored if `include` is also present IE you cannot use both properties at the same time.
+
+Refer to the [app schema for `AuthorCriteria`](https://json-schema.app/view/%23/%23%2Fdefinitions%2FSubmissionCheckJson/%23%2Fdefinitions%2FAuthorOptions/%23%2Fdefinitions%2FAuthorCriteria?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) for all available properties to test against.
+
+Some examples of using `authorIs` can be found in the [Author examples.](/docs/examples/author)
 
 ## Configuration And Usage
 
-* For **Operator/Bot maintainers** see **[Operation Guide](/docs/operator/README.md)**
+* For **Operator/Bot maintainers** see **[Operation Configuration](/docs/operatorConfiguration.md)**
+  * [CLI Usage](docs/operatorConfiguration.md#cli-usage)
 * For **Moderators** 
-  * Refer to the [Subreddit Components Documentation](/docs/subreddit/components) or the [subreddit-ready examples](/docs/subreddit/components/subredditReady)
-  * as well as the [schema](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) which has
+  * Refer to the [examples folder](/docs/examples) or the [subreddit-ready examples](/docs/examples/subredditReady)
+  * as well as the [schema editor](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) which has
     * fully annotated configuration data/structure
     * generated examples in json/yaml
+    * built-in editor that automatically validates your config
+
+## Common Resources
+
+Technical information on recurring, common data/patterns used in CM.
+
+### Activities `window`
+
+Most **Rules** must define the **range of Activities (submissions and/or comments)** that will be used to check the criteria of the Rule. This range is defined wherever you see a `window` property in configuration.
+
+Refer to the [Activities Window](/docs/activitiesWindow.md) documentation for a technical explanation with examples.
+
+### Thresholds and Comparisons
+
+Most rules/filters have criteria that require you to define a specific condition to test against. This can be anything from repeats of activities to account age.
+
+In all of these scenarios the condition is defined using a subset of [comparison operators](https://www.codecademy.com/articles/fwd-js-comparison-logical) (very similar to how automoderator does things).
+
+Available operators:
+
+* `<` -- **less than** => `5 < 6` => 5 is less than 6
+* `>` -- **greater than** => `6 > 5` => 6 is greater than 5
+* `<=` -- **less than or equal to** => `5 <= 5` => 5 is less than **or equal to** 5
+* `>=` -- **greater than or equal to** => `5 >= 5` => 5 is greater than **or equal to** 5
+
+In the context of a rule/filter comparison you provide the comparison **omitting** the value that is being tested. An example...
+
+The RepeatActivity rule has a `threshold` comparison to test against the number of repeat activities it finds
+
+* You want the rule to trigger if it finds **4 or more repeat activities**
+* The rule would be configured like this `"threshold": ">= 4"`
+
+Essentially what this is telling the rule is `threshold: "x >= 4"` where `x` is the largest repeat of activities it finds.
+
+#### Other Comparison Types
+
+Other than comparison numeric values there are two other values that can be compared (depending on the criteria)
+
+##### Percentages
+
+Some criteria accept an optional **percentage** to compare against:
+
+```
+"threshold": "> 20%"
+```
+
+Refer to the individual rule/criteria schema to see what this percentage is comparing against.
+
+##### Durations
+
+Some criteria accept an optional **duration** to compare against:
+
+```
+"threshold": "< 1 month"
+```
+
+The duration value compares a time range from **now** to `duration value` time in the past.
+
+Refer to [duration values in activity window documentation](/docs/activitiesWindow.md#duration-values) as well as the individual rule/criteria schema to see what this duration is comparing against.
+
+### Image Comparisons
+
+ContextMod implements two methods for comparing **image content**, perceptual hashing and pixel-to-pixel comparisons. Comparisons can be used to filter activities in some activities.
+
+See [image comparison documentation](/docs/imageComparison.md) for a full reference. 
+
+## Best Practices
+
+### Named Rules
+
+All **Rules** in a subreddit's configuration can be assigned a **name** that can then be referenced from any other Check. 
+
+Create general-use rules so they can be reused and de-clutter your configuration. Additionally, CM will automatically cache the result of a rule so there is a performance and api usage benefit to re-using Rules.
+
+See [ruleNameReuse.json5](/docs/examples/advancedConcepts/ruleNameReuse.json5) for a detailed configuration with annotations.
+
+### Check Order
+
+Checks are run in the order they appear in your configuration, therefore you should place your highest requirement/severe action checks at the top and lowest requirement/moderate actions at the bottom.
+
+This is so that if an Activity warrants a more serious reaction that Check is triggered first rather than having a lower requirement check with less severe actions triggered and causing all subsequent Checks to be skipped.
+
+* Attribution >50% AND Repeat Activity 8x AND Recent Activity in 2 subs => remove submission + ban
+* Attribution >20% AND Repeat Activity 4x AND Recent Activity in 5 subs => remove submission + flair user restricted
+* Attribution >20% AND Repeat Activity 2x => remove submission
+* Attribution >20% AND History comments <30% => remove submission
+* Attribution >15% => report
+* Repeat Activity 2x => report
+* Recent Activity in 3 subs => report
+* Author not vetted => flair new user submission
+
+### Rule Order
+
+The ordering of your Rules within a Check/RuleSet can have an impact on Check performance (speed) as well as API usage.
+
+Consider these three rules:
+
+* Rule A -- Recent Activity => 3 subreddits => last 15 submissions
+* Rule B -- Repeat Activity => last 3 days
+* Rule C -- Attribution => >10% => last 90 days or 300 submissions
+
+The first two rules are lightweight in their requirements -- Rule A can be completed in 1 API call, Rule B potentially completed in 1 Api call.
+
+However, depending on how active the Author is, Rule C will take *at least* 3 API calls just to get all activities (Reddit limit 100 items per call).
+
+If the Check is using `AND` condition for its rules (default) then if either Rule A or Rule B fail then Rule C will never run. This means 3 API calls never made plus the time waiting for each to return.
+
+**It is therefore advantageous to list your lightweight Rules first in each Check.**
+
+### Caching
+
+ContextMod implements caching functionality for:
+
+* author history (`window` criteria in rules)
+* `authorIs` results
+* `content` that uses wiki pages (on Comment/Report/Ban Actions)
+* and User Notes
+
+All of these use api requests so caching them reduces api usage.
+
+Cached results can be re-used if the criteria in configuration is identical to a previously cached result. So...
+
+* author history cache results are re-used if **`window` criteria on a Rule is identical to the `window` on another Rule** IE always use **7 Days** or always use **50 Items** for absolute counts.
+* `authorIs` criteria is identical to another `authorIs` elsewhere in configuration..
+* etc...
+
+Re-use will result in less API calls and faster Check times.
+
+PROTIP: You can monitor the re-use of cache in the `Cache` section of your subreddit on the web interface. See the tooltips in that section for a better breakdown of cache statistics.
 
 ## FAQ
 

docs/actionTemplating.md

@@ -0,0 +1,72 @@
+Actions that can submit text (Report, Comment) will have their `content` values run through a [Mustache Template](https://mustache.github.io/). This means you can insert data generated by Rules into your text before the Action is performed.
+
+See here for a [cheatsheet](https://gist.github.com/FoxxMD/d365707cf99fdb526a504b8b833a5b78) and [here](https://www.tsmean.com/articles/mustache/the-ultimate-mustache-tutorial/) for a more thorough tutorial.
+
+All Actions with `content` have access to this data:
+
+```json5
+
+{
+    item: {
+        kind: 'string', // the type of item (comment/submission)
+        author: 'string', // name of the item author (reddit user)
+        permalink: 'string', // a url to the item
+        url: 'string', // if the item is a Submission then its URL (external for link type submission, reddit link for self-posts)
+        title: 'string', // if the item is a Submission, then the title of the Submission,
+        botLink: 'string' // a link to the bot's FAQ
+    },
+    rules: {
+        // contains all rules that were run and are accessible using the name, lowercased, with all spaces/dashes/underscores removed
+    }
+}
+
+```
+
+The properties of `rules` are accessible using the name, lower-cased, with all spaces/dashes/underscores. If no name is given `kind` is used as `name` Example:
+
+```
+
+"rules": [
+  {
+    "name": "My Custom-Recent Activity Rule", // mycustomrecentactivityrule
+    "kind": "recentActivity"
+  },
+  {
+    // name = repeatsubmission
+    "kind": "repeatActivity",
+  }
+]
+
+```
+
+**To see what data is available for individual Rules [consult the schema](#configuration) for each Rule.**
+
+#### Quick Templating Tutorial
+
+As a quick example for how you will most likely be using templating -- wrapping a variable in curly brackets, `{{variable}}`, will cause the variable value to be rendered instead of the brackets:
+
+```
+
+myVariable = 50;
+myOtherVariable = "a text fragment"
+template = "This is my template, the variable is {{myVariable}}, my other variable is {{myOtherVariable}}, and that's it!";
+
+console.log(Mustache.render(template, {myVariable});
+// will render...
+"This is my template, the variable is 50, my other variable is a text fragment, and that's it!";
+
+```
+
+**Note: When accessing an object or its properties you must use dot notation**
+
+```
+
+const item = {
+    aProperty: 'something',
+    anotherObject: {
+        bProperty: 'something else'
+    }
+}
+const content = "My content will render the property {{item.aProperty}} like this, and another nested property {{item.anotherObject.bProperty}} like this."
+
+```

docs/activitiesWindow.md

@@ -0,0 +1,304 @@
+# Activity Window
+
+Most **Rules** have a `window` property somewhere within their configuration. This property defines the range of **Activities** (submission and/or comments) that should be retrieved for checking the criteria of the Rule.
+
+As an example if you want to run an **Recent Activity Rule** to check if a user has had activity in /r/mealtimevideos you also need to define what range of activities you want to look at from that user's history.
+
+## `window` property overview (tldr)
+
+The value of `window` can be any of these types:
+
+* `number` count of activities
+* `string` [duration](#duration-string-recommended) or [iso 8601](#an-iso-8601-duration-string)
+* [duration `object`](#duration-object)
+* [ActivityWindowCriteria `object`](#activitywindowcriteria)
+
+Examples of all of the above
+
+<details>
+
+```yaml
+# count, last 100 activities
+window: 100
+
+# duration, last 10 days
+window: 10 days
+
+# duration object, last 2 months and 5 days
+window:
+  months: 2
+  days: 5
+
+# iso 8601 string, last 15 minutes
+window: PT15M
+
+# ActivityWindowCriteria, last 100 activities or 6 weeks of activities (whichever is found first)
+window:
+  count: 100
+  duration: 6 weeks
+```
+
+```json5
+// count, last 100 activities
+{
+  "window": 100
+}
+
+// duration string, last 10 days
+{
+  "window": "10 days"
+}
+
+// duration object, last 2 months and 5 days
+{
+  "window": {
+    "months": 2,
+    "days": 5,
+  }
+}
+
+// iso 8601 string, last 15 minutes
+{
+  "window": "PT15M"
+}
+
+// ActivityWindowCriteria, last 100 activities or 6 weeks of activities (whichever is found first)
+{
+  "window": {
+    "count": 100,
+    "duration": "6 weeks"
+  }
+}
+```
+
+</details>
+
+## Types of Ranges
+
+There are two types of values that can be used when defining a range:
+
+### Count
+
+This is the **number** of activities you want to retrieve. It's straightforward -- if you want to look at the last 100 activities for a user you can use `100` as the value.
+
+### Duration
+
+A **duration of time** between which all activities will be retrieved. This is a **relative value** that calculates the actual range based on **the duration of time subtracted from when the rule is run.**
+
+For example:
+
+* Today is **July 15th**
+* You define a duration of **10 days**
+
+Then the range of activities to be retrieved will be between **July 5th and July 15th** (10 days).
+
+#### Duration Values
+
+The value used to define the duration can be **any of these three types**:
+
+##### Duration String (recommended)
+
+A string consisting of
+
+* A [Dayjs unit of time](https://day.js.org/docs/en/durations/creating#list-of-all-available-units)
+* The value of that unit of time
+
+Examples:
+
+* `9 days`
+* `14 hours`
+* `80 seconds`
+
+You can ensure your string is valid by testing it [here.](https://regexr.com/61em3)
+
+##### Duration Object
+
+If you need to specify multiple units of time for your duration you can instead provide a [Dayjs duration **object**](https://day.js.org/docs/en/durations/creating#list-of-all-available-units) consisting of Dayjs unit-values.
+
+Example
+
+JSON
+```json
+{
+  "days": 4,
+  "hours": 6,
+  "minutes": 20
+}
+```
+YAML
+```yaml
+window:
+  days: 4
+  hours: 6
+  minutes: 20
+```
+
+##### An ISO 8601 duration string
+
+If you're a real nerd you can also use a [standard duration](https://en.wikipedia.org/wiki/ISO_8601#Durations)) string.
+
+Examples
+
+* `PT15M` (15 minutes)
+
+Ensure your string is valid by testing it [here.](https://regexr.com/61em9)
+
+## ActivityWindowCriteria
+
+This is an object that lets you specify more granular conditions for your range.
+
+The full object looks like this:
+
+JSON
+```json
+{
+  "count": 100,
+  "duration": "10 days",
+  "satisfyOn": "any",
+  "subreddits": {
+    "include": ["mealtimevideos","pooptimevideos"],
+    "exclude": ["videos"]
+  }
+}
+```
+YAML
+```yaml
+window:
+  count: 100
+  duration: 10 days
+  satisfyOn: any
+  subreddits:
+    include:
+      - mealtimevideos
+      - pooptimevideos
+    exclude:
+      - videos
+```
+
+### Specifying Range
+
+You may use **one or both range properties.**
+
+If both range properties are specified then the value `satisfyOn` determines how the final range is determined
+
+
+#### Using `"satisfyOn": "any"` (default)
+
+If **any** then Activities will be retrieved until one of the range properties is met, **whichever occurs first.**
+
+Example
+
+JSON
+```json
+{
+  "count": 80,
+  "duration": "90 days",
+  "satisfyOn": "any"
+}
+```
+YAML
+```yaml
+window:
+  count: 80
+  duration: 90 days
+  satisfyOn: any
+```
+Activities are retrieved in chunks of 100 (or `count`, whichever is smaller)
+
+* If 90 days of activities returns only 40 activities => returns 40 activities
+* If 80 activities is only 20 days of range => 80 activities
+
+#### Using `"satisfyOn": "all"`
+
+If **all** then both ranges must be satisfied. Effectively, whichever range produces the most Activities will be the one that is used.
+
+Example
+
+JSON
+```json
+{
+  "count": 100,
+  "duration": "90 days",
+  "satisfyOn": "all"
+}
+```
+YAML
+```yaml
+window:
+  count: 100
+  duration: 90 days
+  satisfyOn: all
+```
+Activities are retrieved in chunks of 100 (or `count`, whichever is smaller)
+
+* If at 90 days of activities => 40 activities retrieved
+  * continue retrieving results until 100 activities
+  * so range is >90 days of activities
+* If at 100 activities => 20 days of activities retrieved
+  * continue retrieving results until 90 days of range
+  * so results in >100 activities
+
+### Filtering Activities
+
+You may filter retrieved Activities using an array of subreddits.
+
+**Note:** Activities are filtered **before** range check is made so you will always end up with specified range (but may require more api calls if many activities are filtered out)
+
+#### Include
+
+Use **include** to specify which subreddits should be included from results
+
+Example where only activities from /r/mealtimevideos and /r/modsupport will be returned
+
+JSON
+```json
+{
+  "count": 100,
+  "duration": "90 days",
+  "satisfyOn": "any",
+  "subreddits": {
+    "include": ["mealtimevideos","modsupport"]
+  }
+}
+```
+YAML
+```yaml
+window:
+  count: 100
+  duruation: 90 days
+  satisfyOn: any
+  subreddits:
+    include:
+      - mealtimevideos
+      - modsupport
+```
+
+#### Exclude
+
+Use **exclude** to specify which subreddits should NOT be in the results
+
+Example where activities from /r/mealtimevideos and /r/modsupport will not be returned in results
+
+JSON
+```json
+{
+  "count": 100,
+  "duration": "90 days",
+  "satisfyOn": "any",
+  "subreddits": {
+    "exclude": ["mealtimevideos","modsupport"]
+  }
+}
+```
+YAML
+```yaml
+window:
+  count: 100
+  duruation: 90 days
+  satisfyOn: any
+  subreddits:
+    exclude:
+      - mealtimevideos
+      - modsupport
+```
+**Note:** `exclude` will be ignored if `include` is also present.

docs/botAuthentication.md

@@ -0,0 +1,109 @@
+**Note:** This is for **bot operators.** If you are a subreddit moderator check out the **[Getting Started Guide](/docs/gettingStartedMod.md)**
+
+Before you can start using your bot on reddit there are a few steps you must take:
+
+* Create your bot account IE the reddit account that will be the "bot"
+* Create a Reddit application
+* Authenticate your bot account with the application
+
+At the end of this process you will have this info:
+
+* clientId
+* clientSecret
+* refreshToken
+* accessToken
+* redirectUri
+
+**Note:** If you already have this information you can skip this guide **but make sure your redirect uri is correct if you plan on using the web interface.**
+
+# Table Of Contents
+
+* [Creating an Application](#create-application)
+* [Authenticate Your Bot](#authenticate-your-bot-account)
+  * [Using CM OAuth Helper](#cm-oauth-helper-recommended)
+  * [Using Aardvark OAuth Helper](#aardvark-oauth-helper)
+* [Provide Credentials to CM](#provide-credentials-to-cm)
+
+# Create Application
+
+Visit [your reddit preferences](https://www.reddit.com/prefs/apps) and at the bottom of the page go through the **create an(other) app** process.
+* Give it a **name**
+* Choose **web app**
+* If you know what you will use for **redirect uri** go ahead and use it, otherwise use **http://localhost:8085/callback**
+
+Click **create app**.
+
+Then write down your **Client ID, Client Secret, and Redirect Uri** somewhere (or keep this webpage open)
+
+# Authenticate Your Bot Account
+
+There are **two ways** you can authenticate your bot account. It is recommended to use the CM oauth helper.
+
+## CM OAuth Helper (Recommended)
+
+This method will use CM's built in oauth flow. It is recommended because it will ensure your bot is authenticated with the correct oauth permissions.
+
+### Start CM with Client ID/Secret and Operator
+
+Start the application and provide these to your configuration:
+
+* **Client ID** 
+* **Client Secret** 
+* **Redirect URI**
+* **Operator** 
+
+It is important you define **Operator** because the auth route is **protected.** You must login to the application in order to access the route.
+
+Refer to the [operator config guide](/docs/operatorConfiguration.md) if you need help with this.
+
+Examples:
+
+* CLI - `node src/index.js --clientId=myId --clientSecret=mySecret --redirectUri="http://localhost:8085/callback" --operator=FoxxMD`
+* Docker - `docker run -e "CLIENT_ID=myId" -e "CLIENT_SECRET=mySecret" -e "OPERATOR=FoxxMD" -e "REDIRECT_URI=http://localhost:8085/callback" foxxmd/context-mod`
+
+### Create An Auth Invite
+
+Then open the CM web interface (default is [http://localhost:8085](http://localhost:8085)) and login.
+
+After logging in you should be automatically redirected the auth page. If you are not then visit [http://localhost:8085/auth/helper](http://localhost:8085/auth/helper))
+
+Follow the directions in the helper to create an **auth invite link.** Open this link and then follow the directions to authenticate your bot. At the end of the process you will receive an **Access Token** and **Refresh Token**
+
+## Aardvark OAuth Helper
+
+This method should only be used if you cannot use the [CM OAuth Helper method](#cm-oauth-helper-recommended) because you cannot access the CM web interface.
+
+* Visit [https://not-an-aardvark.github.io/reddit-oauth-helper/](https://not-an-aardvark.github.io/reddit-oauth-helper/) and follow the instructions given.  
+  * **Note:** You will need to update your **redirect uri.**
+* Input your **Client ID** and **Client Secret** in the text boxes with those names.
+* Choose scopes. **It is very important you check everything on this list or CM may not work correctly**
+    * edit
+    * flair
+    * history
+    * identity
+    * modcontributors
+    * modflair
+    * modposts
+    * modself
+    * mysubreddits
+    * read
+    * report
+    * submit
+    * wikiread
+    * wikiedit (if you are using Toolbox User Notes)
+* Click **Generate tokens**, you will get a popup asking you to approve access (or login) -- **the account you approve access with is the account that Bot will control.**
+* After approving an **Access Token** and **Refresh Token** will be shown at the bottom of the page. Save these to use with CM.
+
+# Provide Credentials to CM
+
+At the end of the last step you chose you should now have this information saved somewhere:
+
+* clientId
+* clientSecret
+* refreshToken
+* accessToken
+* redirectUri
+
+This is all the information you need to run your bot with CM.
+
+Using these credentials follow the [operator config guide](/docs/operatorConfiguration.md) to finish setting up your CM instance.

docs/development.md

@@ -1,380 +0,0 @@
-TODO add more development sections...
-
-# Mocking Reddit API
-
-Using [MockServer](https://www.mock-server.com/)
-
-## Installation
-
-https://www.mock-server.com/mock_server/running_mock_server.html
-
-Easiest way is to install the [docker container](https://www.mock-server.com/mock_server/running_mock_server.html#pull_docker_image) ([from here](https://hub.docker.com/r/mockserver/mockserver))
-
-Map port `1080:1080` -- acts as both the proxy port and the UI endpoint with the below URL:
-
-```
-http(s)://localhost:1080/mockserver/dashboard
-```
-
-In your [operator configuration](/docs/operator/operatorConfiguration.md) define a proxy for snoowrap at the top-level:
-
-```yaml
-snoowrap:
-  proxy: 'http://localhost:8010'
-  #debug: true # optionally set debug to true to make snoowrap requests output to log
-```
-
-## Usage
-
-### Forwarding Requests (Monitoring Behavior)
-
-This is what will make MockServer act as an actual **proxy server**. In this state CM will operate normally. In the MockServer UI you will be able to monitor all requests/responses made.
-
-```HTTP
-PUT /mockserver/expectation HTTP/1.1
-Host: localhost:8010
-Content-Type: application/json
-Content-Length: 155
-
-```
-
-<details>
-<summary>CURL</summary>
-
-```bash
-curl --location --request PUT 'http://localhost:8010/mockserver/expectation' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "httpRequest": {},
-    "priority": 0,
-    "httpForward": {
-        "host": "oauth.reddit.com",
-        "port": 443,
-        "scheme": "HTTPS"
-    }
-}'
-```
-
-</details>
-
-### Mocking Network Issues
-
-MockServer is a bit confusing and regex'ing for specific paths don't work well (for me??)
-
-The lifecycle of a mock call I do:
-
-* Make sure [forwarding](#forwarding-requests-monitoring-behavior) is set, to begin with
-* Breakpoint before the code you want to test with mocking
-* [Mock the network issue](#create-network-issue-behavior)
-* Once the mock behavior should be "done" then
-  * [Clear all exceptions](#clearing-behavior)
-  * Set [forwarding behavior](#forwarding-requests-monitoring-behavior) again
-
-### Create Network Issue Behavior
-
-#### All Responses return 403
-
-<details>
-<summary>HTTP</summary>
-
-```HTTP
-PUT /mockserver/expectation HTTP/1.1
-Host: localhost:8010
-Content-Type: application/json
-Content-Length: 1757
-
-```
-
-</details>
-
-<details>
-<summary>CURL</summary>
-
-```bash
-curl --location --request PUT 'http://localhost:8010/mockserver/expectation' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "id": "error",
-    "httpRequest": {
-        "path": ".*"
-    },
-    "priority": 1,
-    "httpResponse": {
-        "statusCode": 403,
-        "reasonPhrase": "Forbidden",
-        "headers": {
-            "Connection": [
-                "keep-alive"
-            ],
-            "Content-Type": [
-                "application/json; charset=UTF-8"
-            ],
-            "x-ua-compatible": [
-                "IE=edge"
-            ],
-            "x-frame-options": [
-                "SAMEORIGIN"
-            ],
-            "x-content-type-options": [
-                "nosniff"
-            ],
-            "x-xss-protection": [
-                "1; mode=block"
-            ],
-            "expires": [
-                "-1"
-            ],
-            "cache-control": [
-                "private, s-maxage=0, max-age=0, must-revalidate, no-store, max-age=0, must-revalidate"
-            ],
-            "x-ratelimit-remaining": [
-                "575.0"
-            ],
-            "x-ratelimit-used": [
-                "25"
-            ],
-            "x-ratelimit-reset": [
-                "143"
-            ],
-            "X-Moose": [
-                "majestic"
-            ],
-            "Accept-Ranges": [
-                "bytes"
-            ],
-            "Date": [
-                "Wed, 05 Jan 2022 14:37:37 GMT"
-            ],
-            "Via": [
-                "1.1 varnish"
-            ],
-            "Vary": [
-                "accept-encoding"
-            ],
-            "Strict-Transport-Security": [
-                "max-age=15552000; includeSubDomains; preload"
-            ],
-            "Server": [
-                "snooserv"
-            ],
-            "X-Clacks-Overhead": [
-                "GNU Terry Pratchett"
-            ]
-        }
-    }
-}'
-```
-
-</details>
-
-#### All Responses Timeout
-
-<details>
-<summary>HTTP</summary>
-
-```HTTP
-PUT /mockserver/expectation HTTP/1.1
-Host: localhost:8010
-Content-Type: application/json
-Content-Length: 251
-
-```
-
-</details>
-
-<details>
-<summary>CURL</summary>
-
-```bash
-curl --location --request PUT 'http://localhost:8010/mockserver/expectation' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "id": "error",
-    "httpRequest": {
-        "path": ".*"
-    },
-    "priority": 1,
-    "httpResponse": {
-        "body": "should never receive this",
-        "delay": {
-            "timeUnit": "SECONDS",
-            "value": 60
-        }
-    }
-}'
-```
-
-</details>
-
-#### All Responses Drop After Delay (Connection Closed by Server)
-
-<details>
-<summary>HTTP</summary>
-
-```HTTP
-PUT /mockserver/expectation HTTP/1.1
-Host: localhost:8010
-Content-Type: application/json
-Content-Length: 234
-
-```
-
-</details>
-
-<details>
-<summary>CURL</summary>
-
-```bash
-curl --location --request PUT 'http://localhost:8010/mockserver/expectation' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "id": "error",
-    "httpRequest": {
-        "path": ".*"
-    },
-    "priority": 1,
-    "httpError": {
-        "dropConnection": true,
-        "delay": {
-            "timeUnit": "SECONDS",
-            "value": 2
-        }
-    }
-}'
-```
-
-</details>
-
-### Clearing Behavior
-
-
-```HTTP
-PUT /mockserver/clear?type=EXPECTATIONS HTTP/1.1
-Host: localhost:8010
-Content-Type: application/json
-Content-Length: 26
-
-```
-
-<details>
-<summary>CURL</summary>
-
-```bash
-curl --location --request PUT 'http://localhost:8010/mockserver/clear?type=EXPECTATIONS' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "path": "/.*"
-}'
-```
-
-</details>
-        }
-    }
-}
-```
-
-</details>
-
-<details>
-<summary>CURL</summary>
-
-```bash
-curl --location --request PUT 'http://localhost:8010/mockserver/expectation' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "id": "error",
-    "httpRequest": {
-        "path": ".*"
-    },
-    "priority": 1,
-    "httpResponse": {
-        "body": "should never receive this",
-        "delay": {
-            "timeUnit": "SECONDS",
-            "value": 60
-        }
-    }
-}'
-```
-
-</details>
-
-#### All Responses Drop After Delay (Connection Closed by Server)
-
-<details>
-<summary>HTTP</summary>
-
-```HTTP
-PUT /mockserver/expectation HTTP/1.1
-Host: localhost:8010
-Content-Type: application/json
-Content-Length: 234
-
-{
-    "id": "error",
-    "httpRequest": {
-        "path": ".*"
-    },
-    "priority": 1,
-    "httpError": {
-        "dropConnection": true,
-        "delay": {
-            "timeUnit": "SECONDS",
-            "value": 2
-        }
-    }
-}
-```
-
-</details>
-
-<details>
-<summary>CURL</summary>
-
-```bash
-curl --location --request PUT 'http://localhost:8010/mockserver/expectation' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "id": "error",
-    "httpRequest": {
-        "path": ".*"
-    },
-    "priority": 1,
-    "httpError": {
-        "dropConnection": true,
-        "delay": {
-            "timeUnit": "SECONDS",
-            "value": 2
-        }
-    }
-}'
-```
-
-</details>
-
-### Clearing Behavior
-
-
-```HTTP
-PUT /mockserver/clear?type=EXPECTATIONS HTTP/1.1
-Host: localhost:8010
-Content-Type: application/json
-Content-Length: 26
-
-{
-    "path": "/user/.*"
-}
-```
-
-<details>
-<summary>CURL</summary>
-
-```bash
-curl --location --request PUT 'http://localhost:8010/mockserver/clear?type=EXPECTATIONS' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "path": "/.*"
-}'
-```
-
-</details>

docs/examples/README.md

@@ -0,0 +1,30 @@
+# Examples
+
+This directory contains example of valid, ready-to-go configurations for Context Mod for the purpose of:
+
+* showcasing what the bot can do
+* providing best practices for writing your configuration
+* providing generally useful configurations **that can be used immediately** or as a jumping-off point for your configuration
+
+
+    
+### Examples Overview
+
+* Rules
+  * [Attribution](/docs/examples/attribution)
+  * [Recent Activity](/docs/examples/recentActivity)
+  * [Repeat Activity](/docs/examples/repeatActivity)
+  * [History](/docs/examples/history)
+  * [Author](/docs/examples/author)
+  * [Regex](/docs/examples/regex)
+  * [Repost](/docs/examples/repost)
+  * [Author and post flairs](/docs/examples/onlyfansFlair)
+* [Toolbox User Notes](/docs/examples/userNotes)
+* [Advanced Concepts](/docs/examples/advancedConcepts)
+  * [Flow Control](/docs/examples/advancedConcepts/flowControl.md)
+  * [Rule Sets](/docs/examples/advancedConcepts/ruleSets.json5)
+  * [Name Rules](/docs/examples/advancedConcepts/ruleNameReuse.json5)
+  * [Check Ordering](/docs/examples/advancedConcepts)
+* [Subreddit-ready examples](/docs/examples/subredditReady)
+
+PROTIP: You can edit/build on examples by using the [schema editor.](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json)

docs/examples/advancedConcepts/README.md

@@ -0,0 +1,58 @@
+### Named Rules
+
+See **Rule Name Reuse Examples [YAML](/docs/examples/advancedConcepts/ruleNameReuse.yaml) | [JSON](/docs/examples/advancedConcepts/ruleNameReuse.json5)**
+
+### Check Order and Flow Control
+
+Checks are run in the order they appear in your configuration, therefore you should place your highest requirement/severe action checks at the top and lowest requirement/moderate actions at the bottom.
+
+This is so that if an Activity warrants a more serious reaction that Check is triggered first rather than having a lower requirement check with less severe actions triggered and causing all subsequent Checks to be skipped. 
+
+This behavior can also be controlled modified using [Flow Control](/docs/examples/advancedConcepts/flowControl.md)
+
+* Attribution >50% AND Repeat Activity 8x AND Recent Activity in 2 subs => remove submission + ban
+* Attribution >20% AND Repeat Activity 4x AND Recent Activity in 5 subs => remove submission + flair user restricted
+* Attribution >20% AND Repeat Activity 2x => remove submission
+* Attribution >20% AND History comments <30% => remove submission
+* Attribution >15% => report
+* Repeat Activity 2x => report
+* Recent Activity in 3 subs => report
+* Author not vetted => flair new user submission
+
+### Rule Sets
+
+The `rules` array on a `Checks` can contain both `Rule` objects and `RuleSet` objects.
+
+A **Rule Set** is a "nested" set of `Rule` objects with a passing condition specified. These allow you to create more complex trigger behavior by combining multiple rules. 
+
+See **ruleSets [YAML](/docs/examples/advancedConcepts/ruleSets.yaml) | [JSON](/docs/examples/advancedConcepts/ruleSets.json5)** for a complete example as well as consulting the [schema](https://json-schema.app/view/%23%2Fdefinitions%2FRuleSetJson?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json).
+
+### Rule Order
+
+The ordering of your Rules within a Check/RuleSet can have an impact on Check performance (speed) as well as API usage.
+
+Consider these three rules:
+
+* Rule A -- Recent Activity => 3 subreddits => last 15 submissions
+* Rule B -- Repeat Activity => last 3 days
+* Rule C -- Attribution => >10% => last 90 days or 300 submissions
+
+The first two rules are lightweight in their requirements -- Rule A can be completed in 1 API call, Rule B potentially completed in 1 Api call. 
+
+However, depending on how active the Author is, Rule C will take *at least* 3 API calls just to get all activities (Reddit limit 100 items per call).
+
+If the Check is using `AND` condition for its rules (default) then if either Rule A or Rule B fail then Rule C will never run. This means 3 API calls never made plus the time waiting for each to return.
+
+**It is therefore advantageous to list your lightweight Rules first in each Check.**
+
+### API Caching
+
+Context Mod implements some basic caching functionality for **Author Activities** and wiki pages (on Comment/Report Actions).
+
+**Author Activities** are cached for a subreddit-configurable amount of time (10 seconds by default). A cached activities set can be re-used if the **window on a Rule is identical to the window on another Rule**.
+
+This means that when possible you should re-use window values. 
+
+IE If you want to check an Author's Activities for a time range try to always use **7 Days** or always use **50 Items** for absolute counts.
+
+Re-use will result in less API calls and faster Check times.

docs/examples/advancedConcepts/flowControl.md

@@ -21,7 +21,7 @@ Context Mod's behavior after a **Check** has been processed can be configured by
 When a Check is finished processing it can be in one of two states:
 
 * **Triggered** -- The **Rules** defined in the Check were **triggered** which caused the **Actions** for the Check to be run
-* **Failure** -- The **Rules** defined in the check were **not triggered**, based on the conditions that were set (either from the [Check condition](/docs/README.md#Checks) or [Rule Sets](/docs/subreddit/components/advancedConcepts/README.md#Rule-Sets)), and no **Actions** were run
+* **Failure** -- The **Rules** defined in the check were **not triggered**, based on the conditions that were set (either from the [Check condition](/docs/README.md#Checks) or [Rule Sets](/docs/examples/advancedConcepts/README.md#Rule-Sets)), and no **Actions** were run
 
 The behavior CM follows is based on which state it is in. The behavior can be specified **by one or both** of these **state properties** on the Check configuration:
 
@@ -104,7 +104,7 @@ The **Goto** behavior is an **advanced** behavior that allows you to specify tha
 
 **Goto should be use with care.** If you do not fully understand how this mechanism works you should avoid using it as **most** behaviors can be accomplished using the other behaviors. 
 
-As an additional protection **goto depth is limited to 1 by default** which means if a `goto` would be executed more than once during an Activity's lifecycle CM will automatically stop processing that Activity. The `maxGotoDepth` can be raised by the [**Bot Operator**](/docs/operator/gettingStarted.md) per subreddit.
+As an additional protection **goto depth is limited to 1 by default** which means if a `goto` would be executed more than once during an Activity's lifecycle CM will automatically stop processing that Activity. The `maxGotoDepth` can be raised by the [**Bot Operator**](/docs/gettingStartedOperator.md) per subreddit.
 
 #### Goto Syntax
 

docs/examples/attribution/README.md

@@ -10,5 +10,5 @@ Consult the [schema](https://json-schema.app/view/%23/%23%2Fdefinitions%2FCheckJ
 
 ### Examples
 
-* Self Promotion as percentage of all Activities [YAML](/docs/subreddit/componentscomponents/attribution/redditSelfPromoAll.yaml) | [JSON](/docs/subreddit/componentscomponents/attribution/redditSelfPromoAll.json5) - Check if Author is submitting much more than they comment.
-* Self Promotion as percentage of Submissions [YAML](/docs/subreddit/components/attribution/redditSelfPromoSubmissionsOnly.yaml) | [JSON](/docs/examplesm/attribution/redditSelfPromoSubmissionsOnly.json5) - Check if any of Author's aggregated submission origins are >10% of their submissions
+* Self Promotion as percentage of all Activities [YAML](/docs/examples/attribution/redditSelfPromoAll.yaml) | [JSON](/docs/examples/attribution/redditSelfPromoAll.json5) - Check if Author is submitting much more than they comment.
+* Self Promotion as percentage of Submissions [YAML](/docs/examples/attribution/redditSelfPromoSubmissionsOnly.yaml) | [JSON](/docs/examplesm/attribution/redditSelfPromoSubmissionsOnly.json5) - Check if any of Author's aggregated submission origins are >10% of their submissions

docs/examples/author/README.md

@@ -0,0 +1,38 @@
+# Author
+
+## Rule
+
+The **Author** rule triggers if any [AuthorCriteria](https://json-schema.app/view/%23%2Fdefinitions%2FAuthorCriteria?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) from a list are either **included** or **excluded**, depending on which property you put them in.
+
+**AuthorCriteria** that can be checked:
+* name (u/userName)
+* author's subreddit flair text
+* author's subreddit flair css
+* author's subreddit mod status
+* [Toolbox User Notes](/docs/examples/userNotes)
+
+The Author **Rule** is best used in conjunction with other Rules to short-circuit a Check based on who the Author is. It is easier to use a Rule to do this then to write **author filters** for every Rule (and makes Rules more re-useable).
+
+Consult the [schema](https://json-schema.app/view/%23%2Fdefinitions%2FAuthorRuleJSONConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) for a complete reference of the rule's properties.
+
+### Examples
+
+* Basic examples
+    * Flair new user Submission [YAML](/docs/examples/author/flairNewUserSubmission.yaml) | [JSON](/docs/examples/author/flairNewUserSubmission.json5) - If the Author does not have the `vet` flair then flair the Submission with `New User`
+    * Flair vetted user Submission [YAML](/docs/examples/author/flairNewUserSubmission.yaml) | [JSON](/docs/examples/author/flairNewUserSubmission.json5) - If the Author does have the `vet` flair then flair the Submission with `Vetted`
+* Used with other Rules
+    * Ignore vetted user [YAML](/docs/examples/author/flairNewUserSubmission.yaml) | [JSON](/docs/examples/author/flairNewUserSubmission.json5) - Short-circuit the Check if the Author has the `vet` flair
+    
+## Filter
+
+All **Rules** and **Checks** have an optional `authorIs` property that takes an [AuthorOptions](https://json-schema.app/view/%23%2Fdefinitions%2FAuthorOptions?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) object. 
+
+**This property works the same as the Author Rule except that:**
+* On **Rules** if all criteria fail the Rule is **skipped.** 
+  * If a Rule is skipped **it does not fail or pass** and so does not affect the outcome of the Check.
+  * However, if all Rules on a Check are skipped the Check will fail.
+* On **Checks** if all criteria fail the Check **fails**.
+
+### Examples
+
+* Skip recent activity check based on author [YAML](/docs/examples/author/authorFilter.yaml) | [JSON](/docs/examples/author/authorFilter.json5) - Skip a Recent Activity check for a set of subreddits if the Author of the Submission has any set of flairs.

docs/examples/history/README.md

@@ -1,7 +1,6 @@
 # History
 
 The **History** rule can check an Author's submission/comment statistics over a time period:
-
 * Submission total or percentage of All Activity
 * Comment total or percentage of all Activity
 * Comments made as OP (commented in their own Submission) total or percentage of all Comments
@@ -10,5 +9,5 @@ Consult the [schema](https://json-schema.app/view/%23%2Fdefinitions%2FHistoryJSO
 
 ### Examples
 
-* Low Comment Engagement [YAML](/docs/subreddit/componentscomponents/history/lowEngagement.yaml) | [JSON](/docs/subreddit/componentscomponents/history/lowEngagement.json5) - Check if Author is submitting much more than they comment.
-* OP Comment Engagement [YAML](/docs/subreddit/componentscomponents/history/opOnlyEngagement.yaml) | [JSON](/docs/subreddit/componentscomponents/history/opOnlyEngagement.json5) - Check if Author is mostly engaging only in their own content
+* Low Comment Engagement [YAML](/docs/examples/history/lowEngagement.yaml) | [JSON](/docs/examples/history/lowEngagement.json5) - Check if Author is submitting much more than they comment.
+* OP Comment Engagement [YAML](/docs/examples/history/opOnlyEngagement.yaml) | [JSON](/docs/examples/history/opOnlyEngagement.json5) - Check if Author is mostly engaging only in their own content

docs/examples/onlyfansFlair/README.md

@@ -0,0 +1,9 @@
+# Flair users and submissions
+
+Flair users and submissions based on certain keywords from submitter's profile.
+
+Consult [User Flair schema](https://json-schema.app/view/%23%2Fdefinitions%2FUserFlairActionJson?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) and [Submission Flair schema](https://json-schema.app/view/%23%2Fdefinitions%2FFlairActionJson?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) for a complete reference of the rule's properties.
+
+### Examples
+
+* OnlyFans submissions [YAML](/docs/examples/onlyFansFlair/onlyFansFlair.yaml) | [JSON](/docs/examples/onlyfansFlair/onlyfansFlair.json5) - Check whether submitter has typical OF keywords in their profile and flair both author + submission accordingly.

docs/examples/recentActivity/README.md

@@ -0,0 +1,10 @@
+# Recent Activity
+
+The **Recent Activity** rule can check if an Author has made any Submissions/Comments in a list of defined Subreddits.
+
+Consult the [schema](https://json-schema.app/view/%23%2Fdefinitions%2FRecentActivityRuleJSONConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) for a complete reference of the rule's properties.
+
+### Examples
+
+* Free Karma Subreddits [YAML](/docs/examples/recentActivity/freeKarma.yaml) | [JSON](/docs/examples/recentActivity/freeKarma.json5) - Check if the Author has recently posted in any "free karma" subreddits
+* Submission in Free Karma Subreddits [YAML](/docs/examples/recentActivity/freeKarmaOnSubmission.yaml) | [JSON](/docs/examples/recentActivity/freeKarmaOnSubmission.json5) - Check if the Author has posted the Submission this check is running on in any "free karma" subreddits recently

docs/examples/regex/README.md

@@ -11,12 +11,12 @@ Which can then be used in conjunction with a [`window`](https://github.com/FoxxM
 
 ### Examples
 
-* Trigger if regex matches against the current activity - [YAML](/docs/subreddit/componentscomponents/regex/matchAnyCurrentActivity.yaml) | [JSON](/docs/subreddit/componentscomponents/regex/matchAnyCurrentActivity.json5)
-* Trigger if regex matches 5 times against the current activity - [YAML](/docs/subreddit/componentscomponents/regex/matchThresholdCurrentActivity.yaml) | [JSON](/docs/subreddit/componentscomponents/regex/matchThresholdCurrentActivity.json5)
-* Trigger if regex matches against any part of a Submission - [YAML](/docs/subreddit/componentscomponents/regex/matchSubmissionParts.yaml) | [JSON](/docs/subreddit/componentscomponents/regex/matchSubmissionParts.json5)
-* Trigger if regex matches any of Author's last 10 activities - [YAML](/docs/subreddit/componentscomponents/regex/matchHistoryActivity.yaml) | [JSON](/docs/subreddit/componentscomponents/regex/matchHistoryActivity.json5)
-* Trigger if regex matches at least 3 of Author's last 10 activities - [YAML](/docs/subreddit/componentscomponents/regex/matchActivityThresholdHistory.json5) | [JSON](/docs/subreddit/componentscomponents/regex/matchActivityThresholdHistory.json5)
-* Trigger if there are 5 regex matches in the Author's last 10 activities - [YAML](/docs/subreddit/componentscomponents/regex/matchTotalHistoryActivity.yaml) | [JSON](/docs/subreddit/componentscomponents/regex/matchTotalHistoryActivity.json5) 
-* Trigger if there are 5 regex matches in the Author's last 10 comments - [YAML](/docs/subreddit/componentscomponents/regex/matchSubsetHistoryActivity.yaml) | [JSON](/docs/subreddit/componentscomponents/regex/matchSubsetHistoryActivity.json5)
-* Remove comments that are spamming discord links - [YAML](/docs/subreddit/componentscomponents/regex/removeDiscordSpam.yaml) | [JSON](/docs/subreddit/componentscomponents/regex/removeDiscordSpam.json5)
+* Trigger if regex matches against the current activity - [YAML](/docs/examples/regex/matchAnyCurrentActivity.yaml) | [JSON](/docs/examples/regex/matchAnyCurrentActivity.json5)
+* Trigger if regex matches 5 times against the current activity - [YAML](/docs/examples/regex/matchThresholdCurrentActivity.yaml) | [JSON](/docs/examples/regex/matchThresholdCurrentActivity.json5)
+* Trigger if regex matches against any part of a Submission - [YAML](/docs/examples/regex/matchSubmissionParts.yaml) | [JSON](/docs/examples/regex/matchSubmissionParts.json5)
+* Trigger if regex matches any of Author's last 10 activities - [YAML](/docs/examples/regex/matchHistoryActivity.yaml) | [JSON](/docs/examples/regex/matchHistoryActivity.json5)
+* Trigger if regex matches at least 3 of Author's last 10 activities - [YAML](/docs/examples/regex/matchActivityThresholdHistory.json5) | [JSON](/docs/examples/regex/matchActivityThresholdHistory.json5)
+* Trigger if there are 5 regex matches in the Author's last 10 activities - [YAML](/docs/examples/regex/matchTotalHistoryActivity.yaml) | [JSON](/docs/examples/regex/matchTotalHistoryActivity.json5) 
+* Trigger if there are 5 regex matches in the Author's last 10 comments - [YAML](/docs/examples/regex/matchSubsetHistoryActivity.yaml) | [JSON](/docs/examples/regex/matchSubsetHistoryActivity.json5)
+* Remove comments that are spamming discord links - [YAML](/docs/examples/regex/removeDiscordSpam.yaml) | [JSON](/docs/examples/regex/removeDiscordSpam.json5)
   * Differs from just using automod because this config can allow one-off/organic links from users who DO NOT spam discord links but will still remove the comment if the user is spamming them

docs/examples/repeatActivity/README.md

@@ -2,8 +2,6 @@
 
 The **Repeat Activity** rule will check for patterns of repetition in an Author's Submission/Comment history. Consult the [schema](https://json-schema.app/view/%23%2Fdefinitions%2FRepeatActivityJSONConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) for a complete reference of the rule's properties.
 
-To determine sameness it uses an average of [Dice's Coefficient](https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient), [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity), and [Levenshtein Distance](https://en.wikipedia.org/wiki/Levenshtein_distance) weighted by the length of the content being compared (more weight for longer content).
-
 ## Tuning
 
 The most critical properties for this Rule are **gapAllowance** and **lookAt**.
@@ -47,5 +45,5 @@ With only `gapAllowance: 2` this rule **would trigger** because the the 1 and 2
 
 ## Examples
 
-* Crosspost Spamming [JSON](/docs/subreddit/componentscomponents/repeatActivity/crosspostSpamming.json5) | [YAML](/docs/subreddit/componentscomponents/repeatActivity/crosspostSpamming.yaml) - Check if an Author is spamming their Submissions across multiple subreddits
-* Burst-posting [JSON](/docs/subreddit/componentscomponents/repeatActivity/burstPosting.json5) | [YAML](/docs/subreddit/componentscomponents/repeatActivity/burstPosting.yaml) - Check if Author is crossposting their Submissions in short bursts
+* Crosspost Spamming [JSON](/docs/examples/repeatActivity/crosspostSpamming.json5) | [YAML](/docs/examples/repeatActivity/crosspostSpamming.yaml) - Check if an Author is spamming their Submissions across multiple subreddits
+* Burst-posting [JSON](/docs/examples/repeatActivity/burstPosting.json5) | [YAML](/docs/examples/repeatActivity/burstPosting.yaml) - Check if Author is crossposting their Submissions in short bursts

docs/examples/repost/README.md

@@ -1,6 +1,6 @@
 The **Repost** rule is used to find reposts for both **Submissions** and **Comments**, depending on what type of **Check** it is used on.
 
-Note: This rule is for searching **all of Reddit** for reposts, as opposed to just the Author of the Activity being checked. If you only want to check for reposts by the Author of the Activity being checked you should use the [Repeat Activity](/docs/subreddit/componentscomponents/repeatActivity) rule.
+Note: This rule is for searching **all of Reddit** for reposts, as opposed to just the Author of the Activity being checked. If you only want to check for reposts by the Author of the Activity being checked you should use the [Repeat Activity](/docs/examples/repeatActivity) rule.
 
 # TLDR
 
@@ -111,7 +111,7 @@ criteria:
 * **external** -- get items from the Submission's link source that may be reposted (currently implemented for **Comment Checks** only)
   * When the Submission link is for...
     * **Youtube** -- get top comments on video by replies/like count
-      * **NOTE:** An **API Key** for the [Youtube Data API](https://developers.google.com/youtube/v3) must be provided for this facet to work. This can be provided by the operator alongside [bot credentials](/docs/operator/configuration.md) or in the top-level `credentials` property for a [subreddit configuration.](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Freddit-context-bot%2Fmaster%2Fsrc%2FSchema%2FApp.json)
+      * **NOTE:** An **API Key** for the [Youtube Data API](https://developers.google.com/youtube/v3) must be provided for this facet to work. This can be provided by the operator alongside [bot credentials](/docs/operatorConfiguration.md) or in the top-level `credentials` property for a [subreddit configuration.](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Freddit-context-bot%2Fmaster%2Fsrc%2FSchema%2FApp.json)
 
 ### Facet Modifiers
 

docs/examples/subredditReady/README.md

@@ -17,25 +17,25 @@ All actions for these configurations are non-destructive in that:
 
 ### Remove submissions from users who have used 'freekarma' subs to bypass karma checks
 
-[YAML](/docs/subreddit/componentscomponents/subredditReady/freekarma.yaml) | [JSON](/docs/subreddit/componentscomponents/subredditReady/freekarma.json5)
+[YAML](/docs/examples/subredditReady/freekarma.yaml) | [JSON](/docs/examples/subredditReady/freekarma.json5)
 
 If the user has any activity (comment/submission) in known freekarma subreddits in the past (50 activities or 6 months) then remove the submission.
 
 ### Remove submissions from users who have crossposted the same submission 4 or more times
 
-[YAML](/docs/subreddit/componentscomponents/subredditReady/crosspostSpam.yaml) | [JSON](/docs/subreddit/componentscomponents/subredditReady/crosspostSpam.yaml)
+[YAML](/docs/examples/subredditReady/crosspostSpam.yaml) | [JSON](/docs/examples/subredditReady/crosspostSpam.yaml)
 
 If the user has crossposted the same submission in the past (50 activities or 6 months) 4 or more times in a row then remove the submission.
 
 ### Remove submissions from users who have crossposted or used 'freekarma' subs
 
-[YAML](/docs/subreddit/componentscomponents/subredditReady/freeKarmaOrCrosspostSpam.yaml) | [JSON](/docs/subreddit/componentscomponents/subredditReady/freeKarmaOrCrosspostSpam.json5)
+[YAML](/docs/examples/subredditReady/freeKarmaOrCrosspostSpam.yaml) | [JSON](/docs/examples/subredditReady/freeKarmaOrCrosspostSpam.json5)
 
 Will remove submission if either of the above two behaviors is detected
 
 ### Remove link submissions where the user's history is comprised of 10% or more of the same link
 
-[YAML](/docs/subreddit/componentscomponents/subredditReady/selfPromo.yaml) | [JSON](/docs/subreddit/componentscomponents/subredditReady/selfPromo.json5)
+[YAML](/docs/examples/subredditReady/selfPromo.yaml) | [JSON](/docs/examples/subredditReady/selfPromo.json5)
 
 If the link origin (youtube author, twitter author, etc. or regular domain for non-media links)
 
@@ -48,13 +48,13 @@ then remove the submission
 
 ### Remove comment if the user has posted the same comment 4 or more times in a row
 
-[YAML](/docs/subreddit/componentscomponents/subredditReady/commentSpam.yaml) | [JSON](/docs/subreddit/componentscomponents/subredditReady/commentSpam.json5)
+[YAML](/docs/examples/subredditReady/commentSpam.yaml) | [JSON](/docs/examples/subredditReady/commentSpam.json5)
 
 If the user made the same comment (with some fuzzy matching) 4 or more times in a row in the past (50 activities or 6 months) then remove the comment.
 
 ### Remove comment if it is discord invite link spam
 
-[YAML](/docs/subreddit/componentscomponents/subredditReady/discordSpam.yaml) | [JSON](/docs/subreddit/componentscomponents/subredditReady/discordSpam.json5)
+[YAML](/docs/examples/subredditReady/discordSpam.yaml) | [JSON](/docs/examples/subredditReady/discordSpam.json5)
 
 This rule goes a step further than automod can by being more discretionary about how it handles this type of spam. 
 

docs/examples/userNotes/README.md

@@ -6,25 +6,15 @@ Context Mod supports reading and writing [User Notes](https://www.reddit.com/r/t
 
 [Click here for the Toolbox Quickstart Guide](https://www.reddit.com/r/toolbox/wiki/docs/quick_start)
 
-Valid Note Types:
-
-* `gooduser`
-* `spamwatch`
-* `spamwarn`
-* `abusewarn`
-* `ban`
-* `permban`
-* `botban`
-
 ## Filter
 
-User Notes are an additional criteria on [AuthorCriteria](https://json-schema.app/view/%23%2Fdefinitions%2FAuthorCriteria?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) that can be used alongside other Author properties for both [filtering rules and in the AuthorRule.](/docs/subreddit/components/author/)
+User Notes are an additional criteria on [AuthorCriteria](https://json-schema.app/view/%23%2Fdefinitions%2FAuthorCriteria?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) that can be used alongside other Author properties for both [filtering rules and in the AuthorRule.](/docs/examples/author/)
 
 Consult the [schema](https://json-schema.app/view/%23%2Fdefinitions%2FUserNoteCriteria?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) for a complete reference of the **UserNoteCriteria** object that can be used in AuthorCriteria.
 
 ### Examples
 
-* Do not tag user with Good User note [JSON](/docs/subreddit/componentscomponents/userNotes/usernoteFilter.json5) | [YAML](/docs/subreddit/componentscomponents/userNotes/usernoteFilter.yaml)
+* Do not tag user with Good User note [JSON](/docs/examples/userNotes/usernoteFilter.json5) | [YAML](/docs/examples/userNotes/usernoteFilter.yaml)
 
 ## Action
 
@@ -33,4 +23,4 @@ A User Note can also be added to the Author of a Submission or Comment with the
 
 ### Examples
 
-* Add note on user doing self promotion [JSON](/docs/subreddit/componentscomponents/userNotes/usernoteSP.json5) | [YAML](/docs/subreddit/componentscomponents/userNotes/usernoteSP.yaml)
+* Add note on user doing self promotion [JSON](/docs/examples/userNotes/usernoteSP.json5) | [YAML](/docs/examples/userNotes/usernoteSP.yaml)

docs/gettingStartedMod.md

@@ -1,5 +1,5 @@
 This getting started guide is for **reddit moderators** -- that is, someone who wants **an existing ContextMod bot to run on their subreddit.** If you are trying to run a ContextMod
-instance (software) please refer to the [operator getting started](/docs/operator/gettingStarted.md) guide.
+ instance (software) please refer to the [operator getting started](/docs/gettingStartedOperator.md) guide.
 
 # Table of Contents
 
@@ -34,7 +34,7 @@ If the Operator has communicated that **you should add a bot they control as a m
 
 * Shared api quota among other moderated subreddits (not great for high-volume subreddits)
 
----
+___
 
 Ensure that you are in communication with the **operator** of this bot. The bot **will only accept a moderator invitation if your subreddit has been whitelisted by the operator.** This is an intentional barrier to ensure moderators and the operator are familiar with their respective needs and have some form of trust.
 
@@ -55,7 +55,7 @@ If the operator has communicated that **they want to use a bot you control** thi
 
 * **Dedicated API quota**
   * This is basically a requirement if your subreddit has high-volume activity and you plan on running checks on comments
-* More security guarantees since you control the account
+* More security guarantees since you control the account 
   * **Note:** authenticating an account does NOT give the operator access to view or change the email/password for the account
 * Established history in your subreddit
 
@@ -63,7 +63,7 @@ If the operator has communicated that **they want to use a bot you control** thi
 
 * You must have access to the credentials for the reddit account (bot)
 
----
+___
 
 The **operator** will send you an **invite link** that you will use to authenticate your bot with the operator's application. Example link: `https://operatorsUrl.com/auth/invite?invite=4kf9n3o03ncd4nd`
 
@@ -104,7 +104,7 @@ If you already have a configuration you may skip the below step and go directly
 
 ### Using an Example Config
 
-Visit the [Examples](https://github.com/FoxxMD/context-mod/tree/master/docs/examples) folder to find various examples of individual rules or see the [subreddit-ready examples.](/docs/subreddit/components/subredditReady)
+Visit the [Examples](https://github.com/FoxxMD/context-mod/tree/master/docs/examples) folder to find various examples of individual rules or see the [subreddit-ready examples.](/docs/examples/subredditReady)
 
 After you have found a configuration to use as a starting point:
 
@@ -117,13 +117,11 @@ After you have found a configuration to use as a starting point:
 CM comes equipped with a [configuration explorer](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FApp.json) to help you see all available options, with descriptions and examples, that can be used in your configuration.
 
 To create or edit a configuration you should use **CM's buit-in editor** which features:
-
 * syntax validation and formatting
 * full configuration validation with error highlighting, hints, and fixes
 * hover over properties to see documentation and examples
 
 To use the editor either:
-
 * [use your subreddit's built-in editor](#using-the-built-in-editor)
 * or use the public editor at https://cm.foxxmd.dev/config
 
@@ -150,7 +148,7 @@ In the web interface each subreddit's tab has access to the built-in editor. Use
 
 </details>
 
----
+___
 
 The bot automatically checks for new configurations on your wiki page every 5 minutes. If your operator has the web interface accessible you may login there and force the config to update on your subreddit.
 

docs/gettingStartedOperator.md

@@ -0,0 +1,90 @@
+This getting started guide is for **Operators** -- that is, someone who wants to run the actual software for a ContentMod bot. If you are a **Moderator** check out the [moderator getting started](/docs/gettingStartedMod.md) guide instead.
+
+# Table of Contents
+
+* [Installation](#installation)
+  * [Docker](#docker-recommended)
+  * [Locally](#locally)
+  * [Heroku](#heroku-quick-deployhttpsherokucomabout)
+* [Bot Authentication](#bot-authentication)
+* [Instance Configuration](#instance-configuration)
+* [Run Your Bot and Start Moderating](#run-your-bot-and-start-moderating)
+
+# Installation
+
+In order to run a ContextMod instance you must first you must install it somewhere.
+
+ContextMod can be run on almost any operating system but it is recommended to use Docker due to ease of deployment.
+
+## Docker (Recommended)
+
+PROTIP: Using a container management tool like [Portainer.io CE](https://www.portainer.io/products/community-edition) will help with setup/configuration tremendously.
+
+### [Dockerhub](https://hub.docker.com/r/foxxmd/context-mod)
+
+An example of starting the container using the [minimum configuration](/docs/operatorConfiguration.md#minimum-config) with a [configuration file](/docs/operatorConfiguration.md#defining-configuration-via-file):
+
+* Bind the folder where the config is located on your host machine into the container `-v /host/path/folder:/config`
+* Tell CM where to find the config using an env `-e "OPERATOR_CONFIG=/config/myConfig.yaml"`
+* Expose the web interface using the container port `8085`
+
+```
+docker run -d -e "OPERATOR_CONFIG=/config/myConfig.yaml" -v /host/path/folder:/config -p 8085:8085 foxxmd/context-mod
+```
+
+### Locally
+
+Requirements:
+
+* Typescript >=4.3.5
+* Node >=15
+
+Clone this repository somewhere and then install from the working directory
+
+```bash
+git clone https://github.com/FoxxMD/context-mod.git .
+cd context-mod
+npm install
+tsc -p .
+```
+
+An example of running CM using the [minimum configuration](/docs/operatorConfiguration.md#minimum-config) with a [configuration file](/docs/operatorConfiguration.md#defining-configuration-via-file):
+
+```bash
+node src/index.js run
+```
+
+### [Heroku Quick Deploy](https://heroku.com/about)
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://dashboard.heroku.com/new?template=https://github.com/FoxxMD/context-mod)
+
+This template provides a **web** and **worker** dyno for heroku.
+
+* **Web** -- Will run the bot **and** the web interface for ContextMod.
+* **Worker** -- Will run **just** the bot.
+
+Be aware that Heroku's [free dyno plan](https://devcenter.heroku.com/articles/free-dyno-hours#dyno-sleeping) enacts some limits:
+
+* A **Web** dyno will go to sleep (pause) after 30 minutes without web activity -- so your bot will ALSO go to sleep at this time
+* The **Worker** dyno **will not** go to sleep but you will NOT be able to access the web interface. You can, however, still see how Cm is running by reading the logs for the dyno.
+
+If you want to use a free dyno it is recommended you perform first-time setup (bot authentication and configuration, testing, etc...) with the **Web** dyno, then SWITCH to a **Worker** dyno so it can run 24/7.
+
+# Bot Authentication
+
+Next you need to create a bot and authenticate it with Reddit. Follow the [bot authentication guide](/docs/botAuthentication.md) to complete this step.
+
+# Instance Configuration
+
+Finally, you must provide the credentials you received from the **Bot Authentication** step to the ContextMod instance you installed earlier. Refer to the [Operator Configuration](/docs/operatorConfiguration.md) guide to learn how this can be done as there are multiple approaches depending on how you installed the software.
+
+Additionally, at this step you can also tweak many more settings and behavior concerning how your CM bot will operate.
+
+# Run Your Bot and Start Moderating
+
+Congratulations! You should now have a fully authenticated bot running on ContextMod software.
+
+In order for your Bot to operate on reddit though it **must be a moderator in the subreddit you want it to run in.** This may be your own subreddit or someone else's.
+
+**Note: ContextMod does not currently handle moderation invites automatically** and may never have this functionality. Due to the fact that many of its behaviors are api-heavy and that subreddits can control their own configuration the api and resource (cpu/memory) usage of a ContextMod instance can be highly variable. It therefore does not make sense to allow any/all subreddits to automatically have access to an instance through automatically accepting moderator invites. So...if you are planning to run a ContextMod instance for subreddits other than those you moderate you should establish solid trust with moderators of that subreddit as well as a solid line of communication in order to ensure their configurations can be tailored to best fit their needs and your resources.
+
+Once you have logged in as your bot and manually accepted the moderator invite you will need to restart your ContextMod instance in order for these changes to take effect.

docs/imageComparison.md

@@ -2,7 +2,7 @@
 
 ContextMod supports comparing image content, for the purpose of detecting duplicates, with two different but complimentary systems. Image comparison behavior is available for the following rules:
 
-* [Recent Activity](/docs/subreddit/components/recentActivity)
+* [Recent Activity](/docs/examples/recentActivity)
 * Repeat Activity (In-progress)
 
 To enable comparisons reference the example below (at the top-level of your rule) and configure as needed:

docs/operator/README.md

@@ -1,78 +0,0 @@
-# Operator Guide
-
-An **Operator** is the user **running the ContextMod software.**
-
-They are responsible for configuring the software at a high-level and managing associated infrastructure such as:
-
-* Creating cache/database servers and configuring their connections in CM
-* Provisioning the [Reddit Clients](#provisioning-a-reddit-client) needed to run bots and the CM UI
-* Providing [global-level configuration](/docs/operator/configuration.md) that affects general bot/subreddit behavior
-* Onboarding new bots/subreddits
-
-# Table of Contents
-
-* [Overview](#overview)
-  * [Client-Server Architecture](/docs/serverClientArchitecture.md)
-* [Getting Started](/docs/operator/gettingStarted.md)
-* [Installation](/docs/operator/installation.md)
-* [Provisioning a Reddit Client](#provisioning-a-reddit-client)
-* [Configuration](/docs/operator/configuration.md)
-* [Adding A Bot](/docs/operator/addingBot.md)
-
-# Overview
-
-CM is composed of two applications that operate indepedently but are packaged together such that they act as one piece of software:
-
-* **Server** -- Responsible for **running the bot(s)** and providing an API to retrieve information on and interact with them EX start/stop bot, reload config, retrieve operational status, etc.
-* **Client** -- Responsible for serving the **web interface** and handling the bot oauth authentication flow between operators and subreddits/bots.
-
-Both applications authenticate, and are primarily operated, by using [Reddit's API through OAuth.](https://github.com/reddit-archive/reddit/wiki/OAuth2) The **Client** uses OAuth to verify the identity of moderators logging into the web interface. The **Server** uses oauth tokens to interact with Reddit's API and operate all the configured bots.
-
-In its default mode of operation CM takes care of all the interaction between **Server** and **Client** for you so that you can effectively treat it as a monolithic application. Learn more about CM's architecture and other operation modes in the [Server-Client Architecture documentation.](/docs/serverClientArchitecture.md)
-
-# [Getting Started](/docs/operator/gettingStarted.md)
-
-The [Getting Started](/docs/operator/gettingStarted.md) guide serves as a straight-forward "how-to" for standing up a CM server from scratch with minimal explanation.
-
-# [Installation](/docs/operator/installation.md)
-
-CM has many installation options:
-
-* Locally, from source, as a typescript project
-* Built/pulled from a Docker image hosted on Dockerhub
-* Deployed to Heroku with a Quick Deploy template (experimental)
-
-Refer to the [Installation](/docs/operator/installation.md) docs for more information.
-
-# Provisioning A Reddit Client
-
-As mentioning in the [Overview](#overview), CM operates primarily using Reddit's API through OAuth. You must create a [Reddit Client](https://github.com/reddit-archive/reddit/wiki/OAuth2#getting-started) in order to interact with the API.
-
-## Create Application
-
-Visit [your reddit preferences](https://www.reddit.com/prefs/apps) and at the bottom of the page go through the **create an(other) app** process.
-
-* Give it a **name**
-* Choose **web app**
-* If you know what you will use for **redirect uri** go ahead and use it, otherwise use `http://localhost:8085/callback`
-
-Click **create app**.
-
-Then write down your **Client ID, Client Secret, and Redirect Uri** somewhere
-
-# [Configuration](/docs/operator/configuration.md)
-
-The [Configuration](/docs/operator/configuration.md) documentation covers:
-
-* How CM's configuration can be defined
-* How to create and define location for a config file
-* Running CM from the command line
-* Documentation for configuration on Bots, the web client, API, and more...
-
-# [Adding A Bot](/docs/operator/addingBot.md)
-
-The [Adding A Bot](/docs/operator/addingBot.md) documentation covers:
-
-* What is a Bot?
-* What is needed to add a Bot to CM?
-* Different approaches to authenticating and adding a Bot to CM

docs/operator/addingBot.md

@@ -1,86 +0,0 @@
-# Table of Contents
-
-* [What is a Bot?](#what-is-a-bot)
-* [Prerequisites](#Prerequisites)
-* [Adding a Bot to CM](#adding-a-bot-to-cm)
-  * [Using CM OAuth Helper (Recommended)](#cm-oauth-helper-recommended)
-  * [Using Aardvark OAuth Helper](#aardvark-oauth-helper)
-
-# What is a Bot?
-
-A **reddit bot** is composed of two components:
-
-* A normal **reddit account** like `u/MyRedditAccount`
-* Software that performs actions **on behalf of that reddit account** using Reddit's API
-
-There is nothing special about the account! What's special is how its used -- through the API *with bot software* like ContextMod.
-
-# Prerequisites
-
-These things need to be done before a Bot can be added to CM:
-
-* [Provisioned a Reddit Client](/docs/operator/README.md#provisioning-a-reddit-client)
-* You or the person who controls the Bot account must have account credentials (username/password). Logging in to reddit is part of the setup process.
-  * If the bot does not exist **create a reddit account for it.**
-  * If the bot does exist make sure you are in communication with the owner of the account.
-
-# Adding A Bot to CM
-
-## CM OAuth Helper (Recommended)
-
-This method will use CM's built in oauth flow. It is recommended because:
-
-* It's easy!
-* Will ensure your bot is authenticated with the correct oauth permissions
-
-### Start CM with the Minimum Configuration (Initial Setup)
-
-If this is your **first time adding a bot** you must make sure you have
-
-* done the [prerequisites](#prerequisites)
-* created a [minimum operator configuration](/docs/operator/configuration.md#minimum-config)
-  * that specifies the client id/secret from provisioning your reddit client
-  * specified **Operator Name** in the configuration
-
-It is important you define **Operator Name** because the auth route is **protected.** You must login to CM's web interface in order to access the route.
-
-### Create A Bot Invite
-
-Open the CM web interface (default is [http://localhost:8085](http://localhost:8085)) and login with the reddit account specified in **Operator Name.**
-
-If this is your first time setting up a bot you should be automatically redirected to the auth page. Otherwise, visit [http://localhost:8085/auth/helper](http://localhost:8085/auth/helper)
-
-Follow the directions in the helper to create a **Bot Invite Link.**
-
-### Onboard the Bot
-
-Visit the **Bot Invite Link** while **logged in to reddit as the bot account** to begin the onboarding process. Refer to the [Onboarding Your Bot]() subreddit documentation for more information on this process.
-
-At the end of the onboarding process the bot should be automatically added to your operator configuration. If there is an issue with automatically adding it then the oauth credentials will be displayed at the end of onboarding and can be [manually added to the configuration.](/docs/operator/configuration.md#manually-adding-a-bot)
-
-## Aardvark OAuth Helper
-
-This method should only be used if you cannot use the [CM OAuth Helper method.](#cm-oauth-helper-recommended)
-
-* Visit [https://not-an-aardvark.github.io/reddit-oauth-helper/](https://not-an-aardvark.github.io/reddit-oauth-helper/) and follow the instructions given.
-  * **Note:** You will need to update the **redirect uri** you set when [provisioning your reddit client.](/docs/operator/README.md#provisioning-a-reddit-client)
-* Input your **Client ID** and **Client Secret** in the text boxes with those names.
-* Choose scopes. **It is very important you check everything on this list or CM may not work correctly**
-  * edit
-  * flair
-  * history
-  * identity
-  * modcontributors
-  * modflair
-  * modposts
-  * modself
-  * modnote
-  * mysubreddits
-  * read
-  * report
-  * submit
-  * wikiread
-  * wikiedit (if you are using Toolbox User Notes)
-* Click **Generate tokens**, you will get a popup asking you to approve access (or login) -- **the account you approve access with is the account that Bot will control.**
-* After approving an **Access Token** and **Refresh Token** will be shown at the bottom of the page. Use these to [manually add a bot to your operator configuration.](/docs/operator/configuration.md#manually-adding-a-bot)
-  * After adding the bot you will need to restart CM.

docs/operator/caching.md

@@ -1,161 +0,0 @@
-# Table of Contents
-
-* [Overview](#overview)
-  * [What Is Cache?](#what-is-cache)
-  * [How CM Uses Caching](#how-cm-uses-caching)
-    * [Reddit API Calls](#reddit-api-calls)
-    * [Rules and Filters](#rules-and-filters)
-* [Configuration](#configuration)
-  * [Cache Provider](#cache-provider)
-
-# Overview
-
-**Caching** is a major factor in CM's performance and optimization of Reddit API usage. Leveraging caching effectively in your operator configuration and in individual subreddit configurations can make or break your CM instance.
-
-### What Is Cache?
-
-A **Cache** is a storage medium with high **write** and **read** speed that is generally used to store **temporary, but frequently accessed data.**
-
-## How CM Uses Caching
-
-CM primarily **caches** two types of data:
-
-### Reddit API Calls
-
-#### How Reddit's API Works
-
-In order to communicate with Reddit to retrieve posts, comments, user information, etc... CM uses API calls. Each API call is composed of a
-
-* **request** -- CM asks Reddit for certain information
-* **response** -- Reddit responds with the request information
-
-[Reddit imposes an **api quota**](https://github.com/reddit-archive/reddit/wiki/API#rules) on every **individual account** using the API through an application. This quota is **600 requests per 10 minutes.** At the end of the 10 minutes period the quota is reset.
-
-Additionally, some API calls have limits on how much data they can return. The most relevant of these is **user history can only be returned 100 activities (submission/comments) per API call**. EX if you want to get **500** activities from a user's history you will need to make **5** api calls.
-
-#### Caching API Responses
-
-In order to most effectively use the limited quota of API calls CM will **automatically cache API responses based on the "fingerprint" of the request sent.**
-
-On an individual "item" basis that means these resources are always cached:
-
-* General user information (name, karma, age, profile description, etc..)
-* General subreddit information (name, nsfw, quarantined, etc...)
-* Individually processed activities (comment body, is comment author op, submission title, reports, link, etc...)
-
-Additionally (and most importantly), responses for **user history** are cached **based on what was requested**. Example "fingerprint":
-
-* username
-* type of activities to retrieve (overview, only submissions, only comments)
-* range of activities to retrieve (last 100, last 6 months, etc...)
-
-If the above "fingerprint" is used in three different Rules then
-
-* First fingerprint appearance -> CM make API call and caches response
-* Second fingerprint appearance -> CM uses cached response
-* Third fingerprint appearance -> CM uses cached response
-
-So only **one** API call is made even though the history is used three times.
-
-It is therefore **important to re-use window criteria** wherever possible to take advantage of this caching.
-
-### Rules and Filters
-
-Once CM has processed a Rule or Filter (`itemIs` or `authorIs`) the results of that component is stored in cache. For Rules the result is stored for the lifecycle of the Activity being processed and then discarded. For Filters the result is stored for a short time in cache and can be re-used by other Activities.
-
-Re-using Rules and Filters by either using the exact same configuration or by using **names** provides:
-
-* A major performance benefit since these do not need to be re-calculated
-* A low-to-medium optimization on API caching, depending on what criteria are being tested.
-
-In general re-use should always be a goal.
-
-# Configuration
-
-## Cache Provider
-
-CM supports two cache **providers**. By default all providers use `memory`:
-
-* `memory` -- in-memory (non-persistent) backend
-  * Cache will be lost when CM is restarted/exits
-* `redis` -- [Redis](https://redis.io/) backend
-
-Each `provider` object in configuration can be specified as:
-
-* one of the above **strings** to use the **defaults settings** or
-* an **object** with keys to override default settings
-
-[Refer to full documentation on cache providers in the schema](https://json-schema.app/view/%23/%23%2Fdefinitions%2FOperatorCacheConfig/%23%2Fdefinitions%2FCacheOptions?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FOperatorConfig.json)
-
-Some examples:
-
-```json5
-{
- "provider": {
-   "store": "memory", // one of "memory" or "redis"
-   "ttl": 60, // the default max age of a key in seconds
-   "max": 500, // the maximum number of keys in the cache (for "memory" only)
-   
-   // the below properties only apply to 'redis' provider
-   "host": 'localhost',
-   "port": 6379,
-   "auth_pass": null,
-   "db": 0,
- }
-}
-```
-
-YAML
-
-```yaml
-provider:
-  store: redis
-  ttl: 60
-  max: 500
-  host: localhost
-  port: 6379
-  auth_pass: null
-  db: 0
-```
-
-Providers can be specified in multiple locations, with each more specific location overriding the parent-level config:
-
-* top-level config
-* in individual bot configurations
-* in the web config
-
-```yaml
-operator:
- name: example
-# top level
-caching:
- provider:
-  ...
-bots:
-  - name: u/MyBot
-    # overrides top level
-    caching:
-     provider:
-      ...
-web:
-  # overrides top level
-  caching:
-    provider:
-     ...
-```
-
-## Cache TTL
-
-The **Time To Live (TTL)** -- how long data may live in the cache before "expiring" -- can be controlled indepedently for different data types. Sane defaults are provided for all types but tweaking these can improve API caching optimization depending on the subreddit's configuration (use case).
-
-Each of these can be specified in the `caching` property. TTL is measured in seconds.
-
-* `authorTTL` (default 60) -- user activity (overview, submissions, comments)
-* `commentTTL` (default 60) -- individually fetched comments
-* `submissionTTL` (default 60) -- individually fetched submissions
-* `filterCriteriaTTL` (default 60) -- filter results (`itemIs` and `authorIs`)
-* `selfTTL` (default 60) -- actions performed by the bot (creating comment reply, report). If action is in cache the bot ignores it if found during polling.
-  * This helps prevent bot from reacting to things it did itself IE you don't want it to remove a comment because it reported the comment itself
-* `subredditTTL` (default 60) -- general information on fetched subreddit
-* `userNotesTTL` (default 300) -- Amount of time [Toolbox User Notes](https://www.reddit.com/r/toolbox/wiki/docs/usernotes) are cached
-* `wikiTTL` (default 300) -- Wiki pages used for content (in messages, reports, bans, etc...) are cached for this amount of time

docs/operator/database.md

@@ -1,188 +0,0 @@
-# Overview
-
-CM uses a database to store three types of data:
-
-* **Recorded Events** -- an "audit" of how CM processed an Activity (Comment/Submission) and what actions it took based on the result of processing it (comment, report, remove, etc.)
-* Persistent Settings/Data
-  * Settings like the last known state of a Subreddit's bot before the application exited
-  * Web Client sessions and invites -- stuff that should survive a restart
-* Statistics
-  * All-time and time-series high-level statistics like # of events, # of checks run, etc...
-
-CM does NOT store subreddit configurations or any runtime alterations of these configurations. This is to keep configurations **portable** -- on principle, if you (a moderator) choose to use a different CM instance to run your subreddit's bot then it should not function differently.
-
-# Providers
-
-CM uses [TypeORM](https://typeorm.io/) as the database access layer and specifically supports three database types:
-
-* SQLite -- using either [SQL.js](https://sql.js.org) or native SQLite through [better-sqlite3](https://github.com/JoshuaWise/better-sqlite3)
-* MySQL/MariaDB
-* Postgres
-
-The database configuration is specified in the top-level `databaseConfig.connection` property in the operator configuration. EX:
-
-```yaml
-operator:
-  name: u/MyRedditAccount
-databaseConfig:
-  connection:
-   ...
-```
-
-## SQLite
-
-When using a [local installation](/docs/installation.md#locally) the default database is `sqljs`, which requires no binary dependencies. When using [docker](/docs/operator/installation.md#docker-recommended) the default is `better-sqlite3`.
-
-**NOTE:** It is **NOT RECOMMENDED** to use `sqljs` in a production environment for performance reasons. You should at least switch to `better-sqlite3` or preferably MySql/Postgres.
-
-* [`sqljs` connection options](https://typeorm.io/data-source-options#sqljs-data-source-options)
-* [`better-sqlite3` connection options](https://typeorm.io/data-source-options#better-sqlite3-data-source-options)
-
-For both sqlite types, if no database/location is specified, it will be created in the [`DATA_DIR` directory.](/docs/operator/configuration.md#specify-file-location)
-
-If CM detects it cannot **read and write** to the database files, or directory if no files exist, it will fallback to using an in-memory database that will be lost when CM restarts. If you have trouble with r/w permissions and are using docker make sure [file permissions are correct for your mounted volume.](/docs/operator/installation.md#linux-host)
-
-## MySQL/MariaDB
-
-[MySQL/MariaDB connection options](https://typeorm.io/data-source-options#mysql--mariadb-data-source-options)
-
-The `database` you specify should exist before using CM.
-
-## Postgres
-
-[Postgres connection options](https://typeorm.io/data-source-options#postgres--cockroachdb-data-source-options)
-
-The `database` and `schema` you specify should exist before using CM.
-
-# Migrations
-
-CM implements database migrations. On startup it will check for any pending migrations. If the database doesn't exist (sqlite) or is empty or no tables conflict it will automatically execute migrations.
-
-If there is any kind of conflict it will **pause startup** and display a prompt in the user interface to confirm migration execution. **You should always backup your database before running migrations.**
-
-To force CM to always run migrations without confirmation set `force` to `true` in the `migrations` property within `databaseConfig`:
-
-```yaml
-databaseConfig:
-  migrations:
-    force: true # always run migrations
-```
-
-### SQLite
-
-When using a SQLite driver CM can create automatic backups for you. Another prompt will be displayed on the migrations page in the web interface to make a copy of your database. You can make CM automatically backup and continue with migrations like so:
-
-```yaml
-databaseConfig:
-  migrations:
-    continueOnAutomatedBackup: true # try to backup sqlite files automatically and continue with migrations if successful
-```
-
-# Recorded Event Retention
-
-The **Recorded Events** CM stores in the database can be controlled per subreddit. By default events will be stored indefinitely.
-
-A **Retention Policy** is a metric to determine what "range" of Recorded Events CM should keep in the database. It can be either:
-
-* A **number** -- The last X number of Recorded Events will be kept
-  * EX `1000` -> Keep the last 1000 events and discard any others.
-* A **duration** -- A time period, starting from now until X `duration` in the past, for which events will be kept
-  * EX `3 months` -> Keep all events created between now and 3 months ago. Anything older than 3 months ago will be discarded.
-
-The Retention Policy can be specified at operator level, bot, subreddit *override*, and subreddit configuration level:
-
-```yaml
-operator:  
-  name: u/MyRedditAccount
-databaseConfig:
-  retention: '3 months' # each subreddit will retain 3 more of recorded events
-bots:
-    # all subreddits this bot moderates will have 3 month retention
-  - name: u/OneBotAccount
-    credentials:
-      ...
-    subreddits:
-      overrides:
-        - name: aSpecialSubredit
-          databaseConfig:
-            # overrides retention for THIS SUBBREDIT ONLY, will retain last 1000 events
-            # -- also overrides any retention set in the subreddit's actual configuration
-            retention: 1000 
-  
-  - name: u/TwoBotAccount
-    credentials:
-      ...
-    databaseConfig:
-      retention: '1 month' # overrides top-level rentention for all subeddits this bot moderates
-```
-
-In a subreddit's config:
-
-```yaml
-polling:
-  - unmoderated
-
-# will retain last 2000 events
-# -- will override top-level operator retention or bot-specific retention
-# -- will NOT override a subreddit override specified in bot coniguration
-retention: 2000 
-
-runs:
-  ...
-```
-
-# Influx
-
-ContextMod supports writing detailed time-series data to [InfluxDB](https://www.influxdata.com/). 
-
-This data can be used to monitor the overall health, performance, and metrics for a ContextMod server. Currently, this data can **only be used by an Operator** as it requires access to the operator configuration and CM instance.
-
-CM supports InfluxDB OSS > 2.3 or InfluxDB Cloud.
-
-**Note:** This is an **advanced feature** and assumes you have enough technical knowledge to follow the documentation provided by each application to deploy and configure them. No support is guaranteed for installation, configuration, or use of Influx and Grafana.
-
-## Supported Metrics
-
-TBA
-
-## Setup
-
-### InfluxDB OSS
-
-* Install [InfluxDB](https://docs.influxdata.com/influxdb/v2.3/install/)
-* [Configure InfluxDB using the UI](https://docs.influxdata.com/influxdb/v2.3/install/#set-up-influxdb-through-the-ui)
-  * You will need **Username**, **Password**, **Organization Name**, and **Bucket Name** later for Grafana setup so make sure to record them somewhere
-* [Create a Token](https://docs.influxdata.com/influxdb/v2.3/security/tokens/create-token/) with enough permissions to write/read to the bucket you configured
-  * After the token is created **view/copy the token** to clipboard by clicking the token name. You will need this for Grafana setup.
-
-### ContextMod
-
-Add the following block to the top-level of your operator configuration:
-
-```yaml
-influxConfig:
-  credentials:
-    url: 'http://localhost:8086' # URL to your influx DB instance
-    token: '9RtZ5YZ6bfEXAMPLENJsTSKg==' # token created in the previous step
-    org: MyOrg # organization created in the previous step
-    bucket: contextmod # name of the bucket created in the previous step
-```
-
-## Grafana
-
-A pre-built dashboard for [Grafana](https://grafana.com) can be imported to display overall metrics/stats using InfluxDB data.
-
-![Grafana Dashboard](/docs/images/grafana.jpg)
-
-* Create a new Data Source using **InfluxDB** type
-  * Choose **Flux** for the **Query Language**
-  * Fill in the details for **URL**, **Basic Auth Details** and **InfluxDB Details** using the data you created in the [Influx Setup step](#influxdb-oss)
-  * Set **Min time interval** to `60s`
-  * Click **Save and test**
-* Import Dashboard
-  * **Browse** the Dashboard pane
-  * Click **Import** and **upload** the [grafana dashboard json file](/docs/operator/grafana.json)
-    * Chose the data source you created from the **InfluxDB CM** dropdown
-    * Click **Import**
-
-The dashboard can be filtered by **Bots** and **Subreddits** dropdowns at the top of the page to get more specific details.

docs/operator/gettingStarted.md

@@ -1,60 +0,0 @@
-This getting started guide is for **Operators** -- that is, someone who wants to run the actual software for a ContentMod bot. If you are a **Moderator** check out the [moderator getting started](/docs/subreddit/gettingStarted.md) guide instead.
-
-# Table of Contents
-
-* [Installation](#installation)
-* [Create a Reddit Client](#create-a-reddit-client)
-* [Create a Minimum Configuration](#create-a-minimum-configuration)
-  * [Local Installation](#local-installation)
-  * [Docker Installation](#docker-installation)
-* [Add a Bot to CM](#add-a-bot-to-cm)
-* [Access The Dashboard](#access-the-dashboard)
-* [What's Next?](#whats-next)
-
-# Installation
-
-Follow the [installation](/docs/operator/installation.md) documentation. It is recommended to use **Docker** since it is self-contained.
-
-# Create a Reddit Client
-
-[Create a reddit client](/docs/operator/README.md#provisioning-a-reddit-client)
-
-# Create a Minimum Configuration
-
-Using the information you received in the previous step [create a minimum file configuration](/docs/operator/configuration.md#minimum-configuration) save it as `config.yaml` somewhere.
-
-# Start ContextMod With Configuration
-
-## Local Installation
-
-If you [installed CM locally](/docs/installation.md#locally) move your configuration file `config.yaml` to the root of the project directory (where `package.json`) is located.
-
-From the root directory run this command to start CM
-
-```
-node src/index.js run
-```
-
-## Docker Installation
-
-If you [installed CM using Docker](/docs/installation.md#docker-recommended) make note of the directory you saved your minimum configuration to and substitute its full path for `host/path/folder` in the docker command show in the [docker install directions](/docs/operator/installation.md#docker-recommended)
-
-# Add A Bot to CM
-
-Once CM is up and running use the [CM OAuth Helper](/docs/operator/addingBot.md#cm-oauth-helper-recommended) to add authorize and add a Bot to your CM instance.
-
-# Access The Dashboard
-
-Congratulations! You should now have a fully authenticated bot running on a ContextMod instance.
-
-In order for your Bot to operate in a subreddit it **must be a moderator in that subreddit.** This may be your own subreddit or someone else's.
-
-To monitor the behavior of bots running on your instance visit http://localhost:8085.
-
-# What's Next?
-
-As an operator you should familiarize yourself with how the [operator configuration](/docs/operator/configuration.md) you made works. This will help you understand how to get the most of your CM instance by leveraging the [Cache](/docs/oeprator/caching.md) and [Database](/docs/operator/database.md) effectively as well as provide you will all possible options for configuring CM using the [schema.](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fcontext-mod%2Fmaster%2Fsrc%2FSchema%2FOperatorConfig.json)
-
-If you are also the moderator of the subreddit the bot will be running you should check out the [moderator getting started guide.](/docs/subreddit/gettingStarted.md#setup-wiki-page)
-
-You might also be interested in these [quick tips for using the web interface](/docs/webInterface.md)