Server settings¶
The MGA Compass server (app/backend) is configured through environment variables.
Variable |
Default |
Meaning |
|---|---|---|
|
none |
URL of a near-optimal set archive, e.g. |
|
|
Directory holding the set, relative to the working directory. Without |
|
|
Origins allowed to call the API, as a JSON list. |
|
|
LP solver for navigation and interpolation. |
|
|
Primal feasibility tolerance passed to the solver. |
|
|
Where solver logs are written. |
|
|
Debug mode. |
The server refuses to start if a file of the set is missing or fails its checksum, or if the set breaks a rule of the format. It navigates over all points of the set, so over its largest slack level.
The server keeps the points in memory and reads the outputs from DATA_DIR when a plot needs
them, only for the points the plot mixes.
API¶
All endpoints are rate-limited per client address. Quantities are exchanged in the set’s
display units (its manifest’s display): /init reports them, the frontend sends values back
in them, and /plot_data returns them.
Endpoint |
Method |
Limit |
Does |
|---|---|---|---|
|
GET |
60/minute |
Each dimension’s range, description and unit, and the starting point (the cheapest one). |
|
GET |
60/minute |
The available plots and the category labels and colours. |
|
POST |
20/minute and 60/5 minutes |
Run navigation and interpolation. |
|
POST |
30/minute |
Plot data along a traverse. |
|
POST |
60/minute |
Cost lower bound along a traverse. |