Server Configuration: Difference between revisions
From Bondix Wiki
(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...") |
No edit summary |
||
| Line 1: | Line 1: | ||
== Server Commands == | == Server Commands == | ||
{| class="wikitable" | |||
|- | |||
| | |||
=== add-apikey === | |||
Adds an authentication key to use with the [[Server HTTP Api | HTTP API]]. | |||
{| class="wikitable" | |||
|+Parameters | |||
|- | |||
|key||A secret string used to authenticate an API request. | |||
|} | |||
| style="width: 40%" | | |||
<nowiki>{ | |||
"target": "server", | |||
"action": "add-apikey", | |||
"key": "a-secret-key" | |||
}</nowiki> | |||
|- | |||
| | |||
=== add-environment=== | |||
Adds an environment. Deprecated, you can directly create environments in the web interface instead. | |||
{| class="wikitable" | |||
|+Parameters | |||
|- | |||
|key||A secret string used to authenticate an API request. | |||
|} | |||
| style="width: 40%" | | |||
<nowiki>{ | |||
"target": "server", | |||
"action": "add-apikey", | |||
"key": "a-secret-key" | |||
}</nowiki> | |||
|- | |||
| | |||
=== add-http === | |||
Adds an unencrypted http listener for web interface access. | |||
{| class="wikitable" | |||
|+Parameters | |||
|- | |||
|key||A secret string used to authenticate an API request. | |||
|} | |||
| style="width: 40%" | | |||
<nowiki>{ | |||
"target": "server", | |||
"action": "add-apikey", | |||
"key": "a-secret-key" | |||
}</nowiki> | |||
|- | |||
| | |||
=== add-https === | |||
Adds an authentication key to use with the [[Server HTTP Api | HTTP API]]. | |||
{| class="wikitable" | |||
|+Parameters | |||
|- | |||
|key||A secret string used to authenticate an API request. | |||
|} | |||
| style="width: 40%" | | |||
<nowiki>{ | |||
"target": "server", | |||
"action": "add-apikey", | |||
"key": "a-secret-key" | |||
}</nowiki> | |||
|- | |||
| | |||
=== add-user === | |||
Adds an user/password pair that can be used to log into the server's web interface. | |||
{| class="wikitable" | |||
|+Parameters | |||
|- | |||
|user||The username | |||
|password||and password | |||
|} | |||
| style="width: 40%" | | |||
<nowiki>{ | |||
"target": "server", | |||
"action": "add-user", | |||
"user": "admin", | |||
"password": "bad password" | |||
}</nowiki> | |||
|- | |||
| | |||
=== set-fallback-watchdog === | |||
{| class="wikitable" | |||
|+Parameters | |||
|- | |||
|user||The username | |||
|} | |||
| style="width: 40%" | | |||
<nowiki>{ | |||
"target": "server", | |||
"action": "" | |||
}</nowiki> | |||
|- | |||
| | |||
=== slow-shutdown === | |||
{| class="wikitable" | |||
|+Parameters | |||
|- | |||
|user||The username | |||
|} | |||
| style="width: 40%" | | |||
<nowiki>{ | |||
"target": "server", | |||
"action": "" | |||
}</nowiki> | |||
|- | |||
| | |||
=== set-password-authentication === | |||
{| class="wikitable" | |||
|+Parameters | |||
|- | |||
|user||The username | |||
|} | |||
| style="width: 40%" | | |||
<nowiki>{ | |||
"target": "server", | |||
"action": "" | |||
}</nowiki> | |||
|- | |||
| | |||
=== set-web-login === | |||
{| class="wikitable" | |||
|+Parameters | |||
|- | |||
|user||The username | |||
|} | |||
| style="width: 40%" | | |||
<nowiki>{ | |||
"target": "server", | |||
"action": "" | |||
}</nowiki> | |||
|- | |||
| | |||
=== enable-demo === | |||
{| class="wikitable" | |||
|+Parameters | |||
|- | |||
|user||The username | |||
|} | |||
| style="width: 40%" | | |||
<nowiki>{ | |||
"target": "server", | |||
"action": "" | |||
}</nowiki> | |||
|} | |||
==System Commands== | ==System Commands== | ||
| Line 14: | Line 165: | ||
}</nowiki> | }</nowiki> | ||
|- | |- | ||
| | | | ||
===set-log=== | ===set-log=== | ||
Revision as of 15:25, 14 October 2022
Server Commands
add-apikeyAdds an authentication key to use with the HTTP API.
|
{
"target": "server",
"action": "add-apikey",
"key": "a-secret-key"
}
| ||||
add-environmentAdds an environment. Deprecated, you can directly create environments in the web interface instead.
|
{
"target": "server",
"action": "add-apikey",
"key": "a-secret-key"
}
| ||||
add-httpAdds an unencrypted http listener for web interface access.
|
{
"target": "server",
"action": "add-apikey",
"key": "a-secret-key"
}
| ||||
add-httpsAdds an authentication key to use with the HTTP API.
|
{
"target": "server",
"action": "add-apikey",
"key": "a-secret-key"
}
| ||||
add-userAdds an user/password pair that can be used to log into the server's web interface.
|
{
"target": "server",
"action": "add-user",
"user": "admin",
"password": "bad password"
}
| ||||
set-fallback-watchdog
|
{
"target": "server",
"action": ""
}
| ||||
slow-shutdown
|
{
"target": "server",
"action": ""
}
| ||||
set-password-authentication
|
{
"target": "server",
"action": ""
}
| ||||
set-web-login
|
{
"target": "server",
"action": ""
}
| ||||
enable-demo
|
{
"target": "server",
"action": ""
}
|
System Commands
shutdownShuts down the client and terminates. |
{
"target": "system",
"action": "shutdown"
}
| ||||||||||||
set-logEnables logging to file or changes output file.
|
{
"target": "system",
"action": "set-log",
"file": "/var/log/saneclient.log",
"fileMode": "append"
}
| ||||||||||||
set-script-pathChanges the directory that points towards the client scripts. (/opt/bondix/client/scripts by default)
|
{
"target": "system",
"action": "set-script-path",
"path": "/etc/bondix/scripts"
}
| ||||||||||||
set-webinterfaceEnables the integrated webserver & debug webinterface.
|
{
"target": "system",
"action": "set-webinterface",
"host": "0.0.0.0",
"port": "80",
"allowConfig": false,
"allowMonitor": true,
"configApiKey": "123456",
"webroot": "/tmp/"
}
|