161sh/CatgirlIntelligenceAgency
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation improvements

Browse Source
This commit is contained in:
Viktor Lofgren 2023-03-27 17:25:27 +02:00
parent 862e925d7c
commit b60fcd0918
3 changed files with 36 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -1,4 +1,4 @@
# marginalia.nu
# Marginalia Search
This is the source code for [Marginalia Search](https://search.marginalia.nu).

4
doc/readme.md
View File

@ -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

31
doc/system-properties.md Normal file
View File

@ -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 |