From b60fcd09188aed47981acf4e10345c0fe3651a50 Mon Sep 17 00:00:00 2001
From: Viktor Lofgren <vlofgren@marginalia.nu>
Date: Mon, 27 Mar 2023 17:25:27 +0200
Subject: [PATCH] Documentation improvements

---
 README.md                |  2 +-
 doc/readme.md            |  4 ++++
 doc/system-properties.md | 31 +++++++++++++++++++++++++++++++
 3 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 doc/system-properties.md

diff --git a/README.md b/README.md
index bd99eed6..0b8b1e0d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# marginalia.nu
+# Marginalia Search
 
 This is the source code for [Marginalia Search](https://search.marginalia.nu). 
 
diff --git a/doc/readme.md b/doc/readme.md
index 9f288959..9a591213 100644
--- a/doc/readme.md
+++ b/doc/readme.md
@@ -3,6 +3,10 @@
 A lot of the architectural description is sprinkled into the code repository closer to the code. 
 Start in [📁 ../code/](../code/) and poke around.
 
+## Operations
+
+* [System Properties](system-properties.md) - JVM property flags
+
 ## Set-up
 
 * [📁 ../run/](../run/) - Set-up instructions
diff --git a/doc/system-properties.md b/doc/system-properties.md
new file mode 100644
index 00000000..f28eaca3
--- /dev/null
+++ b/doc/system-properties.md
@@ -0,0 +1,31 @@
+# System Properties
+
+These are JVM system properties used by each service
+
+## Search Service
+| flag        | values     | description                                           |
+|-------------|------------|-------------------------------------------------------|
+| website-url |https://search.marginalia.nu/|Overrides the website URL used in rendering|
+
+## Index Service
+
+|flag| values     | description                                                   |
+|---|------------|---------------------------------------------------------------|
+|lexiconSizeHint| 1000000000 | The default size of the lexicon, speeds up start time in prod |
+
+## Crawler Process
+|flag| values     | description                                           |
+|---|------------|-------------------------------------------------------|
+|crawl.rootDirRewrite|/some/path|Sets the base directory of a crawl plan |
+
+## Converter Process
+|flag| values     | description                                           |
+|---|------------|-------------------------------------------------------|
+|crawl.rootDirRewrite|/some/path|Sets the base directory of a crawl plan |
+
+## Loader Process
+|flag| values     | description                                           |
+|---|------------|-------------------------------------------------------|
+|lexiconSizeHint| 800000000  | The default size of the lexicon                       |
+|local-index-path| /some/path | Selects the location the loader will write index data |
+|crawl.rootDirRewrite|/some/path|Sets the base directory of a crawl plan |