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.

Installation

Front-end

The web server front-end is written in Purescript, so you will need to have a few tools set up. The easiest way to get set up is using nix-shell to get yarn, nodejs, purs and spago:

$ nix-shell
nix-shell $ yarn bundle

Back-end

stack install autoexporter
stack install smos-server

Running

To run the server, run the following command:

$ smos-web-server serve

Reference

Arguments

Usage: smos-web-server COMMAND [--config-file FILEPATH]
  
  Smos Web Server version: 0.5.0
  
  Oldest supported Smos server API version: 0.0.0
  Newest supported Smos server API version: 0.2.0

Available options:
  -h,--help                Show this help text
  --config-file FILEPATH   The config file

Available commands:
  serve                    Serve as the web server

Environment

Available environment variables:

  API_URL                The url for the api to use
  CONFIG_FILE            The config file
  DATA_DIR               The directory to store workflows
                         during editing
  DOCS_URL               The url to the docs site to refer to
  GOOGLE_ANALYTICS_TRACKING
                         The Google analytics tracking
                         code
  GOOGLE_SEARCH_CONSOLE_VERIFICATION
                         The Google search console
                         verification code
  LOG_LEVEL              The minimal severity of log
                         messages
  PORT                   The port to serve web requests on
  WEB_URL                The url that this web server is
                         served from

Configuration

# Configuration
log-level: # optional
  # The minimal severity for log messages
  <string>
port: # optional
  # The port on which to serve web requests
  <number>
docs-url: # optional
  # The url for the documentation site to refer to
  <string>
api-url: # optional
  # The url for the api to use
  <string>
web-url: # optional
  # The url that this web server is served from
  <string>
data-dir: # optional
  # The directory to store workflows during editing
  <string>
google-analytics-tracking: # optional
  # The google analytics tracking code
  <string>
google-search-console-verification: # optional
  # The google search console verification code
  <string>