Options

services.smos.production.api-server

Smos' API server service

Type: null or (submodule)

Default: null

services.smos.production.api-server.config

Typed contents of the config file

Type: submodule

Default: { }

services.smos.production.api-server.config.admin

The user that will have admin rights

Type: null or string

Default: null

services.smos.production.api-server.config.auto-backup

This option has no description.

Type: submodule

Default: { }

services.smos.production.api-server.config.auto-backup.enable

enable the auto-backup looper

Type: null or boolean

Default: null

services.smos.production.api-server.config.auto-backup.period

period of the auto-backup looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.api-server.config.auto-backup.phase

phase of the auto-backup looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.api-server.config.backup-garbage-collector

This option has no description.

Type: submodule

Default: { }

services.smos.production.api-server.config.backup-garbage-collector.enable

enable the backup-garbage-collector looper

Type: null or boolean

Default: null

services.smos.production.api-server.config.backup-garbage-collector.period

period of the backup-garbage-collector looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.api-server.config.backup-garbage-collector.phase

phase of the backup-garbage-collector looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.api-server.config.booking-email-address

Email address to send booking emails from

Type: null or string

Default: null

services.smos.production.api-server.config.database-file

The file to store the server database in

Type: null or string

Default: null

services.smos.production.api-server.config.file-migrator

This option has no description.

Type: submodule

Default: { }

services.smos.production.api-server.config.file-migrator.enable

enable the file-migrator looper

Type: null or boolean

Default: null

services.smos.production.api-server.config.file-migrator.period

period of the file-migrator looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.api-server.config.file-migrator.phase

phase of the file-migrator looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.api-server.config.log-level

Minimal severity of log messages

Type: null or anything

Default: null

services.smos.production.api-server.config.max-backup-size-per-user

The maximum number of bytes that backups can take up per user

Type: null or (unsigned integer, meaning >=0)

Default: null

services.smos.production.api-server.config.max-backups-per-user-per-period

The maximum number of bytes that backups can take up per user

Type: null or (submodule) or list of (submodule)

Default: null

services.smos.production.api-server.config.monetisation

This option has no description.

Type: submodule

Default: { }

services.smos.production.api-server.config.monetisation.freeloaders

The usernames of users that will not have to pay, comma separated

Type: null or (list of string)

Default: null

services.smos.production.api-server.config.monetisation.stripe-price

The stripe price id

Type: null or string

Default: null

services.smos.production.api-server.config.monetisation.stripe-publishable-key

The stripe api publishable key

Type: null or string

Default: null

services.smos.production.api-server.config.monetisation.stripe-secret-key

The stripe api secret key

Type: null or string

Default: null

services.smos.production.api-server.config.necrork

This option has no description.

Type: submodule

Default: { }

services.smos.production.api-server.config.necrork.intray

This option has no description.

Type: submodule

Default: { }

services.smos.production.api-server.config.necrork.intray.key

Access key

Type: null or string

Default: null

services.smos.production.api-server.config.necrork.intray.username

Username

Type: null or string

Default: null

services.smos.production.api-server.config.necrork.notifier

This option has no description.

Type: submodule

Default: { }

services.smos.production.api-server.config.necrork.notifier.enable

enable the notifier looper

Type: null or boolean

Default: null

services.smos.production.api-server.config.necrork.notifier.period

period of the notifier looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.api-server.config.necrork.notifier.phase

phase of the notifier looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.api-server.config.necrork.switch

Name of the necrork switch

Type: null or string

Default: null

services.smos.production.api-server.config.necrork.timeout

How long after last hearing from this switch, nodes should consider it dead

Type: null or 32 bit unsigned integer; between 0 and 4294967295 (both inclusive)

Default: null

services.smos.production.api-server.config.necrork.url

Base url of the necrork server

Type: null or string

Default: null

services.smos.production.api-server.config.port

The port to serve web requests on

Type: null or signed integer

Default: null

services.smos.production.api-server.config.signing-key-file

The file to store the JWT signing key in

Type: null or string

Default: null

services.smos.production.api-server.config.uuid-file

The file to store the server uuid in

Type: null or string

Default: null

services.smos.production.api-server.enable

Whether to enable Smos API Server.

Type: boolean

Default: false

Example: true

services.smos.production.api-server.extraConfig

Extra contents of the config file

Type: unspecified value

Default: { }

services.smos.production.api-server.hosts

The host to serve api requests on

Type: list of string

Default: [ ]

Example: [ "api.smos.online" ]

services.smos.production.api-server.openFirewall

Whether to open the specified port in the firewall

Type: boolean

Default: false

services.smos.production.api-server.pkg

The docs server package

Type: package

Default: <derivation smos-server-0.14.0>

services.smos.production.docs-site

Smos' documentation site service

Type: null or (submodule)

Default: null

services.smos.production.docs-site.config

Typed contents of the config file

Type: submodule

Default: { }

services.smos.production.docs-site.config.api-url

The url for the api to use

Type: null or string

Default: null

services.smos.production.docs-site.config.google-analytics-tracking

The Google analytics tracking code

Type: null or string

Default: null

services.smos.production.docs-site.config.google-search-console-verification

The Google search console verification code

Type: null or string

Default: null

services.smos.production.docs-site.config.log-level

Minimal severity of log messages

Type: null or anything

Default: null

services.smos.production.docs-site.config.necrork

This option has no description.

Type: submodule

Default: { }

services.smos.production.docs-site.config.necrork.intray

This option has no description.

Type: submodule

Default: { }

services.smos.production.docs-site.config.necrork.intray.key

Access key

Type: null or string

Default: null

services.smos.production.docs-site.config.necrork.intray.username

Username

Type: null or string

Default: null

services.smos.production.docs-site.config.necrork.notifier

This option has no description.

Type: submodule

Default: { }

services.smos.production.docs-site.config.necrork.notifier.enable

enable the notifier looper

Type: null or boolean

Default: null

services.smos.production.docs-site.config.necrork.notifier.period

period of the notifier looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.docs-site.config.necrork.notifier.phase

phase of the notifier looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.docs-site.config.necrork.switch

Name of the necrork switch

Type: null or string

Default: null

services.smos.production.docs-site.config.necrork.timeout

How long after last hearing from this switch, nodes should consider it dead

Type: null or 32 bit unsigned integer; between 0 and 4294967295 (both inclusive)

Default: null

services.smos.production.docs-site.config.necrork.url

Base url of the necrork server

Type: null or string

Default: null

services.smos.production.docs-site.config.port

The port to serve web requests on

Type: null or signed integer

Default: null

services.smos.production.docs-site.config.web-url

The url for the web server to refer to

Type: null or string

Default: null

services.smos.production.docs-site.enable

Whether to enable Smos Docs Site.

Type: boolean

Default: false

Example: true

services.smos.production.docs-site.extraConfig

Extra contents of the config file

Type: unspecified value

Default: { }

services.smos.production.docs-site.hosts

The host to serve the docs site on

Type: list of string

Default: [ ]

Example: [ "docs.smos.online" ]

services.smos.production.docs-site.openFirewall

Whether to open the specified port in the firewall

Type: boolean

Default: false

services.smos.production.docs-site.pkg

The docs site package

Type: package

Default: <derivation smos-docs-site-0.0.0>

services.smos.production.enable

Whether to enable Smos.

Type: boolean

Default: false

Example: true

services.smos.production.web-server

Smos' web server service

Type: null or (submodule)

Default: null

services.smos.production.web-server.config

Typed contents of the config file

Type: submodule

Default: { }

services.smos.production.web-server.config.api-url

The url for the api to use

Type: null or string

Default: null

services.smos.production.web-server.config.data-dir

The directory to store workflows during editing

Type: null or string

Default: null

services.smos.production.web-server.config.docs-url

The url to the docs site to refer to

Type: null or string

Default: null

services.smos.production.web-server.config.google-analytics-tracking

The Google analytics tracking code

Type: null or string

Default: null

services.smos.production.web-server.config.google-search-console-verification

The Google search console verification code

Type: null or string

Default: null

services.smos.production.web-server.config.log-level

Minimal severity of log messages

Type: null or anything

Default: null

services.smos.production.web-server.config.necrork

This option has no description.

Type: submodule

Default: { }

services.smos.production.web-server.config.necrork.intray

This option has no description.

Type: submodule

Default: { }

services.smos.production.web-server.config.necrork.intray.key

Access key

Type: null or string

Default: null

services.smos.production.web-server.config.necrork.intray.username

Username

Type: null or string

Default: null

services.smos.production.web-server.config.necrork.notifier

This option has no description.

Type: submodule

Default: { }

services.smos.production.web-server.config.necrork.notifier.enable

enable the notifier looper

Type: null or boolean

Default: null

services.smos.production.web-server.config.necrork.notifier.period

period of the notifier looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.web-server.config.necrork.notifier.phase

phase of the notifier looper in seconds

Type: null or signed integer or floating point number

Default: null

services.smos.production.web-server.config.necrork.switch

Name of the necrork switch

Type: null or string

Default: null

services.smos.production.web-server.config.necrork.timeout

How long after last hearing from this switch, nodes should consider it dead

Type: null or 32 bit unsigned integer; between 0 and 4294967295 (both inclusive)

Default: null

services.smos.production.web-server.config.necrork.url

Base url of the necrork server

Type: null or string

Default: null

services.smos.production.web-server.config.port

The port to serve web requests on

Type: null or signed integer

Default: null

services.smos.production.web-server.config.web-url

The url that this web server is served from

Type: null or string

Default: null

services.smos.production.web-server.enable

Whether to enable Smos Web Server.

Type: boolean

Default: false

Example: true

services.smos.production.web-server.extraConfig

Extra contents of the config file

Type: unspecified value

Default: { }

services.smos.production.web-server.hosts

The host to serve web requests on

Type: list of string

Default: [ ]

Example: [ "smos.online" ]

services.smos.production.web-server.openFirewall

Whether to open the specified port in the firewall

Type: boolean

Default: false

services.smos.production.web-server.pkg

The web server package

Type: package

Default: <derivation smos-web-server-0.14.1>