Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/kaladoodotlua/LRhub/llms.txt

Use this file to discover all available pages before exploring further.

LRhub requires no central configuration file — most settings are entered interactively at runtime. However, two config files influence the Testing Tool behavior. Both live inside the tools/testingtool/input/ directory and are read each time the Testing Tool is launched.

​
File: tools/testingtool/input/config.json

Absolute path after install: /usr/local/LRhub/tools/testingtool/input/config.json This JSON file controls fallback behaviour when the MAP API returns incomplete student data. The schema contains a single field: 
{
  "manual_test_name": ""
}
​
manual_test_name
string
Fallback test name used when a student’s assigned test has a null testName in the MAP API response. Leave empty to skip students without an assigned test name.
Example with a value filled in: 
{
  "manual_test_name": "MAP Growth Reading 6+"
}
When manual_test_name is set to a non-empty string, the Testing Tool will assign that test name to any student whose MAP record returns a null testName, allowing the scrape to continue rather than skipping those students.

​
File: tools/testingtool/input/proxies.txt

Absolute path after install: /usr/local/LRhub/tools/testingtool/input/proxies.txt A plain-text file containing one proxy address per line in host:port format. A random proxy is chosen for each new MAP session request.
  • The file must exist — if it is missing, the Testing Tool will crash with a FileNotFoundError.
  • Leave the file empty to connect directly without a proxy.
  • Lines are read top-to-bottom; selection is random each session.
Example: 
192.168.1.100:8080
proxy.example.com:3128
The file must be present on disk. An empty file is valid and causes the Testing Tool to fall back to a direct connection with no proxy applied. Deleting the file entirely will cause the tool to crash on startup.

​
Output: tools/testingtool/output/students.txt

Absolute path after install: /usr/local/LRhub/tools/testingtool/output/students.txt This file is appended (never overwritten) each time the scrape option runs. Each line represents one student record in a colon-separated format. Format per line: studentNumber:firstName:lastName Example: 
12345:Jane:Doe
67890:John:Smith
Because the file is always appended to, duplicate entries may accumulate across multiple scrape runs. Periodically review and clean the file to avoid duplicates.

​
Install paths

The install.sh script places LRhub into the following locations on your system:
PathDescription
/usr/local/LRhub/Root install directory
/usr/local/LRhub/hub.luaMain Lua entry point
/usr/local/LRhub/tools/All bundled tools
/usr/bin/lrhubWrapper shell script (calls lua hub.lua)
The installer creates the /usr/bin/lrhub wrapper so you can invoke LRhub from any directory without specifying the full path. The wrapper script reads as follows: 
#!/bin/bash
cd "/usr/local/LRhub" || exit 1
lua hub.lua "$@"
The installer runs sudo chmod +x /usr/bin/lrhub automatically. As long as /usr/bin is in your PATH, the lrhub command will be available immediately after installation.

Build docs developers (and LLMs) love

Get started for freeTalk to us