List of Configuration Options
The following is a list of configuration options that you can set in your Opt-server's
config.json file.
Command Property
Description
"server-name"REQUIRED STRING
The name of your Opt-server, e.g. "my-server".
Must be unique across all your Opt-servers. See also "server-alias".
"server-alias"STRING
The name of the server that will be displayed to the users of the Opt-server when using the PIFOP IDE,
e.g. "My server".
If not set, "server-name" will be used.
"queue-memory-threshold"NUMBER
Memory (in GB) threshold after which new job submissions start to be queued, e.g. 2.5.
If not set, no threshold is set. If set, whenever an user submits a job to the Opt-server, the Opt-server will check if the currently
running proccesses are collectively consuming the given amount of memory. If so, the job submission is queued.
Every few seconds the Opt-server will check if the memory consumption went below the threshold and, if so,
it will start the next job in the queue.
"queue-job-count-threshold"NUMBER
Number of jobs threshold after which new job submissions start to be queued. If not set, no
threshold is set. If set, new job submissions will be queued if the number if jobs currently running in
Opt-server is equal to the given threshold. The queue moves as the jobs running in the Opt-server are finished (or killed).
"user-groups"OBJECT
Use the Opt-server management page to manage users and user groups.
Learn more here.
"users"OBJECT
Use the Opt-server management page to manage users and user groups.
Learn more here.
"commands"ARRAY OF OBJECTS
List of supported commands and their configurations. Learn how to configure commands
here.
"sandboxes"ARRAY OF OBJECTS
List of named sandboxes configurations. Learn how to configure named sandboxes
here.
"credentials-file"BOOLEAN
If true, the Opt-server will automatically login using the
.credentials file located in the Opt-server's directory. This
credentials file is automatically generated when you choose to be remembered at the moment of
login.
"connection-tries"NUMBER
Maximum number of reconnection attempts.
When the connection with PIFOP is lost, the Opt-server will keep trying to reconnect until
it succeds or the given limit is reached.