Summary

The gargantext-settings.toml must be edited for things to function properly, since some fields (typically, microservice URLs) can't be the same for all instances.

Right now, it is not obvious for new instance administrators to figure out how to go about editing the gargantext-settings.toml file to fit their situation. In particular, it is easy to accidentally leave some fields empty and get runtime errors without it being obvious what the cause is.

Help should be provided for administrators to get a correct gargantext-settings.toml file.

Steps to reproduce

0. Be a new administrator
1. Follow the instructions in the README: Download Gargantext, compile it, etc.
2. Try to fill in the missing fields in gargantext-settings.toml

What is the current bug behavior?

It is not clear what the fields are for, which ones are essential and which ones can be left empty at first.

What is the expected correct behavior?

Administrators can figure out easily what data to put in front of each field, if any.

Possible fixes

I see two possible courses of action:

• Clearly document each field in the gargantext-settings.toml file, making it clear what the administrator should put in. Fields without which the server cannot function properly are marked using a convention such as prepending the comment with REQUIRED, so that the would-be administrator can easily see if they left out something critical.
• Or make a tool (possibly integrated with the init command) which detects if the gargantext-settings.toml file is incomplete, and if so, interactively prompts the user to enter the required fields (cabal init-style)