Server Configuration

From Bondix Wiki
Revision as of 16:14, 14 October 2022 by Red (talk | contribs) (Created page with " == Server Commands == ==System Commands== {| class="wikitable" |- | ===shutdown=== Shuts down the client and terminates. | style="width: 40%" | <nowiki>{ "target": "system", "action": "shutdown" }</nowiki> |- | ===set-log=== Enables logging to file or changes output file. {| class="wikitable" |+Parameters |- |file||The filename that the log should be written to. Required. |- |fileMode||can be <code>append</code> or <code>overwrite</code>. Required. |} || <no...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Server Commands

System Commands

shutdown

Shuts down the client and terminates.

{
   "target": "system", 
   "action": "shutdown"
 }

set-log

Enables logging to file or changes output file.

Parameters
file The filename that the log should be written to. Required.
fileMode can be append or overwrite. Required.
{
   "target": "system", 
   "action": "set-log", 
   "file": "/var/log/saneclient.log", 
   "fileMode": "append"
 }

set-script-path

Changes the directory that points towards the client scripts. (/opt/bondix/client/scripts by default)

Parameters
path Path to the new bondix script directory.
{
   "target": "system", 
   "action": "set-script-path", 
   "path": "/etc/bondix/scripts"
 }

set-webinterface

Enables the integrated webserver & debug webinterface.

Parameters
host IP that the service should listen on. Required.
port TCP Port that the service should listen on. Required.
allowConfig En- or disables web configuration. Not required, enabled by default.
allowMonitor En- or disables web monitor. Not required, enabled by default.
configApiKey The password required to access configuration & monitor. Not required, "123456" by default.
webroot Web root directory. Points to the "www" subdirectory in installation directory. Not required, changing not advised.
{
   "target": "system", 
   "action": "set-webinterface", 
   "host": "0.0.0.0", 
   "port": "80",
   "allowConfig": false, 
   "allowMonitor": true, 
   "configApiKey": "123456", 
   "webroot": "/tmp/"
 }