Smos Logo Smos

A comprehensive self-management system

The Smos Web Server

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.

Reference

Arguments

Usage: smos-web-server [--config-file FILE_PATH] [--log-level ARG] [--port PORT]
                       [--docs-url URL] [--api-url URL] [--web-url URL] 
                       [--data-dir FILEPATH] [--google-analytics-tracking CODE] 
                       [--google-search-console-verification CODE]

  
  Smos Web Server version: 0.12.0
  
  Oldest supported Smos server API version: 0.0.0
  Newest supported Smos server API version: 0.4.0

Available options:
  -h,--help                Show this help text
  --config-file FILE_PATH  The config file to use
  --log-level ARG          The log level to use, options:
                           ["Debug","Info","Warn","Error"]
  --port PORT              The port to serve web requests on
  --docs-url URL           The url to the docs site to refer to
  --api-url URL            The url for the api to use
  --web-url URL            The url that this web server is served from
  --data-dir FILEPATH      The directory to store workflows during editing
  --google-analytics-tracking CODE
                           The Google analytics tracking code
  --google-search-console-verification CODE
                           The Google search console verification code

Environment

Available environment variables:

  SMOS_WEB_SERVER_API_URL
                         The url for the api to use
  SMOS_WEB_SERVER_CONFIG_FILE
                         Workflow directory
  SMOS_WEB_SERVER_DATA_DIR
                         The directory to store workflows
                         during editing
  SMOS_WEB_SERVER_DOCS_URL
                         The url to the docs site to refer to
  SMOS_WEB_SERVER_GOOGLE_ANALYTICS_TRACKING
                         The Google analytics tracking
                         code
  SMOS_WEB_SERVER_GOOGLE_SEARCH_CONSOLE_VERIFICATION
                         The Google search console
                         verification code
  SMOS_WEB_SERVER_LOG_LEVEL
                         The minimal severity of log
                         messages
  SMOS_WEB_SERVER_PORT
                         The port to serve web requests on
  SMOS_WEB_SERVER_WEB_URL
                         The url that this web server is
                         served from

Configuration

# Configuration
log-level: # optional
  # The minimal severity for log messages
  # or null
  def: LogLevel
  # The log level to use, options:
  # ["Debug","Info","Warn","Error"]
  <string>
port: # optional
  # The port on which to serve web requests
  # or null
  <number> # between -9223372036854775808 and 9223372036854775807
docs-url: # optional
  # The url for the documentation site to refer to
  # or null
  <string>
api-url: # optional
  # The url for the api to use
  # or null
  <string>
web-url: # optional
  # The url that this web server is served from
  # or null
  <string>
data-dir: # optional
  # The directory to store workflows during editing
  # or null
  <string>
google-analytics-tracking: # optional
  # The google analytics tracking code
  # or null
  <string>
google-search-console-verification: # optional
  # The google search console verification code
  # or null
  <string>