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

Options

  --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                                                         
  --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_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 Google analytics tracking code
  google-analytics-tracking:
    # or null
    <string>
  The Google search console verification code
  google-search-console-verification:
    # or null
    <string>

Combined settings

Usage: smos-web-server [--config-file FILE_PATH] [--log-level LOG_LEVEL] [--port PORT] [--docs-url URL] --api-url URL --web-url URL [--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 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                                                         
  --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_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 Google analytics tracking code
  google-analytics-tracking:
    # or null
    <string>
  The Google search console verification code
  google-search-console-verification:
    # or null
    <string>