SmosYou can set up your own Smos Web Server to host your own web interface for smos.
A comprehensive self-management system
A comprehensive self-management system
Documentation for the Smos Web Server, for hosting your own Smos in the browser
You can set up your own Smos Web Server to host your own web interface for smos.
--config-file Path to the configuration file --log-level Minimal severity of log messages default: Info examples: "Debug", "Info", "Warn", "Error" --port The port to serve web requests on default: 8080 --docs-url The url to the docs site to refer to --api-url The url for the api to use --web-url The url that this web server is served from --data-dir The directory to store workflows during editing default: "." --necrork-switch Name of the necrork switch --necrork-url Base url of the necrork server default: https://necrork.cs-syd.eu --necrork-(enable|disable)-notifier enable the notifier looper --necrork-notifier-phase phase of the notifier looper in seconds default: 0s --necrork-notifier-period period of the notifier looper in seconds default: 300s --necrork-timeout How long after last hearing from this switch, nodes should consider it dead --necrork-intray-username Username --necrork-intray-key Access key --necrork-intray-key-file Access key --google-analytics-tracking The Google analytics tracking code --google-search-console-verification The Google search console verification code
SMOS_WEB_SERVER_CONFIG_FILE FILE_PATH Path to the configuration file SMOS_WEB_SERVER_LOG_LEVEL LOG_LEVEL Minimal severity of log messages default: Info examples: "Debug", "Info", "Warn", "Error" SMOS_WEB_SERVER_PORT PORT The port to serve web requests on default: 8080 SMOS_WEB_SERVER_DOCS_URL URL The url to the docs site to refer to SMOS_WEB_SERVER_API_URL URL The url for the api to use SMOS_WEB_SERVER_WEB_URL URL The url that this web server is served from SMOS_WEB_SERVER_DATA_DIR DIRECTORY_PATH The directory to store workflows during editing default: "." SMOS_WEB_SERVER_NECRORK_SWITCH SWITCH_NAME Name of the necrork switch SMOS_WEB_SERVER_NECRORK_URL URL Base url of the necrork server default: https://necrork.cs-syd.eu SMOS_WEB_SERVER_NECRORK_NOTIFIER_ENABLE BOOL enable the notifier looper SMOS_WEB_SERVER_NECRORK_NOTIFIER_PHASE SECONDS phase of the notifier looper in seconds default: 0s SMOS_WEB_SERVER_NECRORK_NOTIFIER_PERIOD SECONDS period of the notifier looper in seconds default: 300s SMOS_WEB_SERVER_NECRORK_TIMEOUT SECONDS How long after last hearing from this switch, nodes should consider it dead SMOS_WEB_SERVER_NECRORK_INTRAY_USERNAME USERNAME Username SMOS_WEB_SERVER_NECRORK_INTRAY_KEY KEY Access key SMOS_WEB_SERVER_NECRORK_INTRAY_KEY_FILE KEY Access key SMOS_WEB_SERVER_GOOGLE_ANALYTICS_TRACKING CODE The Google analytics tracking code SMOS_WEB_SERVER_GOOGLE_SEARCH_CONSOLE_VERIFICATION CODE The Google search console verification code
Minimal severity of log messages
default: Info
examples: "Debug", "Info", "Warn", "Error"
log-level:
# or null
def: LogLevel
# The log level to use, options:
# ["Debug","Info","Warn","Error"]
<string>
The port to serve web requests on
default: 8080
port:
# or null
<integer> # 64 bit signed integer
The url to the docs site to refer to
docs-url:
# or null
<string>
The url for the api to use
api-url:
# or null
<string>
The url that this web server is served from
web-url:
# or null
<string>
The directory to store workflows during editing
default: "."
data-dir:
# or null
<string>
Name of the necrork switch
necrork.switch:
# or null
<string>
Base url of the necrork server
default: https://necrork.cs-syd.eu
necrork.url:
# or null
<string>
enable the notifier looper
necrork.notifier.enable:
# or null
<boolean>
phase of the notifier looper in seconds
default: 0s
necrork.notifier.phase:
# or null
<number>
period of the notifier looper in seconds
default: 300s
necrork.notifier.period:
# or null
<number>
How long after last hearing from this switch, nodes should consider it dead
necrork.timeout:
# or null
<integer> # 32 bit unsigned integer
Username
necrork.intray.username:
# or null
<string>
Access key
necrork.intray.key:
# or null
<string>
Access key
necrork.intray.key-file:
# or null
<string>
The Google analytics tracking code
google-analytics-tracking:
# or null
<string>
The Google search console verification code
google-search-console-verification:
# or null
<string>
Usage: smos-web-server [--config-file FILE_PATH] [--log-level LOG_LEVEL] [--port PORT] [--docs-url URL] --api-url URL --web-url URL [--data-dir DIRECTORY_PATH] [--necrork-switch SWITCH_NAME [--necrork-url URL] [--necrork-(enable|disable)-notifier] [--necrork-notifier-phase SECONDS] [--necrork-notifier-period SECONDS] [--necrork-timeout SECONDS] --necrork-intray-username USERNAME [--necrork-intray-key KEY | --necrork-intray-key-file KEY]] [--google-analytics-tracking CODE] [--google-search-console-verification CODE]
All settings:
Show this help text
switch: -h|--help
Output version information
switch: --version
Path to the configuration file
option: --config-file FILE_PATH
env: SMOS_WEB_SERVER_CONFIG_FILE FILE_PATH
Minimal severity of log messages
option: --log-level LOG_LEVEL
env: SMOS_WEB_SERVER_LOG_LEVEL LOG_LEVEL
config:
log-level: # or null
def: LogLevel
# The log level to use, options:
# ["Debug","Info","Warn","Error"]
<string>
default: Info
examples: "Debug", "Info", "Warn", "Error"
The port to serve web requests on
option: --port PORT
env: SMOS_WEB_SERVER_PORT PORT
config:
port: # or null
<integer> # 64 bit signed integer
default: 8080
The url to the docs site to refer to
option: --docs-url URL
env: SMOS_WEB_SERVER_DOCS_URL URL
config:
docs-url: # or null
<string>
The url for the api to use
option: --api-url URL
env: SMOS_WEB_SERVER_API_URL URL
config:
api-url: # or null
<string>
The url that this web server is served from
option: --web-url URL
env: SMOS_WEB_SERVER_WEB_URL URL
config:
web-url: # or null
<string>
The directory to store workflows during editing
option: --data-dir DIRECTORY_PATH
env: SMOS_WEB_SERVER_DATA_DIR DIRECTORY_PATH
config:
data-dir: # or null
<string>
default: "."
Name of the necrork switch
option: --necrork-switch SWITCH_NAME
env: SMOS_WEB_SERVER_NECRORK_SWITCH SWITCH_NAME
config:
necrork.switch: # or null
<string>
Base url of the necrork server
option: --necrork-url URL
env: SMOS_WEB_SERVER_NECRORK_URL URL
config:
necrork.url: # or null
<string>
default: https://necrork.cs-syd.eu
enable the notifier looper
switch: --necrork-(enable|disable)-notifier
env: SMOS_WEB_SERVER_NECRORK_NOTIFIER_ENABLE BOOL
config:
necrork.notifier.enable: # or null
<boolean>
phase of the notifier looper in seconds
option: --necrork-notifier-phase SECONDS
env: SMOS_WEB_SERVER_NECRORK_NOTIFIER_PHASE SECONDS
config:
necrork.notifier.phase: # or null
<number>
default: 0s
period of the notifier looper in seconds
option: --necrork-notifier-period SECONDS
env: SMOS_WEB_SERVER_NECRORK_NOTIFIER_PERIOD SECONDS
config:
necrork.notifier.period: # or null
<number>
default: 300s
How long after last hearing from this switch, nodes should consider it dead
option: --necrork-timeout SECONDS
env: SMOS_WEB_SERVER_NECRORK_TIMEOUT SECONDS
config:
necrork.timeout: # or null
<integer> # 32 bit unsigned integer
Username
option: --necrork-intray-username USERNAME
env: SMOS_WEB_SERVER_NECRORK_INTRAY_USERNAME USERNAME
config:
necrork.intray.username: # or null
<string>
Access key
option: --necrork-intray-key KEY
option: --necrork-intray-key-file KEY
env: SMOS_WEB_SERVER_NECRORK_INTRAY_KEY KEY
env: SMOS_WEB_SERVER_NECRORK_INTRAY_KEY_FILE KEY
config:
necrork.intray.key: # or null
<string>
config:
necrork.intray.key-file: # or null
<string>
The Google analytics tracking code
option: --google-analytics-tracking CODE
env: SMOS_WEB_SERVER_GOOGLE_ANALYTICS_TRACKING CODE
config:
google-analytics-tracking: # or null
<string>
The Google search console verification code
option: --google-search-console-verification CODE
env: SMOS_WEB_SERVER_GOOGLE_SEARCH_CONSOLE_VERIFICATION CODE
config:
google-search-console-verification: # or null
<string>
Options:
-h|--help Show this help text
--version Output version information
--config-file Path to the configuration file
--log-level Minimal severity of log messages default: Info examples: "Debug", "Info", "Warn", "Error"
--port The port to serve web requests on default: 8080
--docs-url The url to the docs site to refer to
--api-url The url for the api to use
--web-url The url that this web server is served from
--data-dir The directory to store workflows during editing default: "."
--necrork-switch Name of the necrork switch
--necrork-url Base url of the necrork server default: https://necrork.cs-syd.eu
--necrork-(enable|disable)-notifier enable the notifier looper
--necrork-notifier-phase phase of the notifier looper in seconds default: 0s
--necrork-notifier-period period of the notifier looper in seconds default: 300s
--necrork-timeout How long after last hearing from this switch, nodes should consider it dead
--necrork-intray-username Username
--necrork-intray-key Access key
--necrork-intray-key-file Access key
--google-analytics-tracking The Google analytics tracking code
--google-search-console-verification The Google search console verification code
Environment Variables:
SMOS_WEB_SERVER_CONFIG_FILE FILE_PATH Path to the configuration file
SMOS_WEB_SERVER_LOG_LEVEL LOG_LEVEL Minimal severity of log messages default: Info examples: "Debug", "Info", "Warn", "Error"
SMOS_WEB_SERVER_PORT PORT The port to serve web requests on default: 8080
SMOS_WEB_SERVER_DOCS_URL URL The url to the docs site to refer to
SMOS_WEB_SERVER_API_URL URL The url for the api to use
SMOS_WEB_SERVER_WEB_URL URL The url that this web server is served from
SMOS_WEB_SERVER_DATA_DIR DIRECTORY_PATH The directory to store workflows during editing default: "."
SMOS_WEB_SERVER_NECRORK_SWITCH SWITCH_NAME Name of the necrork switch
SMOS_WEB_SERVER_NECRORK_URL URL Base url of the necrork server default: https://necrork.cs-syd.eu
SMOS_WEB_SERVER_NECRORK_NOTIFIER_ENABLE BOOL enable the notifier looper
SMOS_WEB_SERVER_NECRORK_NOTIFIER_PHASE SECONDS phase of the notifier looper in seconds default: 0s
SMOS_WEB_SERVER_NECRORK_NOTIFIER_PERIOD SECONDS period of the notifier looper in seconds default: 300s
SMOS_WEB_SERVER_NECRORK_TIMEOUT SECONDS How long after last hearing from this switch, nodes should consider it dead
SMOS_WEB_SERVER_NECRORK_INTRAY_USERNAME USERNAME Username
SMOS_WEB_SERVER_NECRORK_INTRAY_KEY KEY Access key
SMOS_WEB_SERVER_NECRORK_INTRAY_KEY_FILE KEY Access key
SMOS_WEB_SERVER_GOOGLE_ANALYTICS_TRACKING CODE The Google analytics tracking code
SMOS_WEB_SERVER_GOOGLE_SEARCH_CONSOLE_VERIFICATION CODE The Google search console verification code
Configuration Values:
Minimal severity of log messages
default: Info
examples: "Debug", "Info", "Warn", "Error"
log-level:
# or null
def: LogLevel
# The log level to use, options:
# ["Debug","Info","Warn","Error"]
<string>
The port to serve web requests on
default: 8080
port:
# or null
<integer> # 64 bit signed integer
The url to the docs site to refer to
docs-url:
# or null
<string>
The url for the api to use
api-url:
# or null
<string>
The url that this web server is served from
web-url:
# or null
<string>
The directory to store workflows during editing
default: "."
data-dir:
# or null
<string>
Name of the necrork switch
necrork.switch:
# or null
<string>
Base url of the necrork server
default: https://necrork.cs-syd.eu
necrork.url:
# or null
<string>
enable the notifier looper
necrork.notifier.enable:
# or null
<boolean>
phase of the notifier looper in seconds
default: 0s
necrork.notifier.phase:
# or null
<number>
period of the notifier looper in seconds
default: 300s
necrork.notifier.period:
# or null
<number>
How long after last hearing from this switch, nodes should consider it dead
necrork.timeout:
# or null
<integer> # 32 bit unsigned integer
Username
necrork.intray.username:
# or null
<string>
Access key
necrork.intray.key:
# or null
<string>
Access key
necrork.intray.key-file:
# or null
<string>
The Google analytics tracking code
google-analytics-tracking:
# or null
<string>
The Google search console verification code
google-search-console-verification:
# or null
<string>