# html - HTML status page

Warning

Do not commit your credentials to a public repo!

Writes an HTML status page. Can optionally display a map.

The supplied template includes JavaScript to notify you if the page either doesn’t auto-refresh, or if SimpleMonitor has stopped updating it. This requires your machine running SimpleMonitor and the machine you are browsing from to agree on what the time is (timezone doesn’t matter)! The template is written using Jinja2.

You can use the `upload_command` setting to specify a command to push the generated files to another location (e.g. a web server, an S3 bucket etc). I’d suggest putting the commands in a script and just specifying that script as the value for this setting.

filename
  Type:

    string

  Required:

    true

  the html file to output. Will be stored in the `folder`

folder
  Type:

    string

  Required:

    false

  Default:

    `html`

  the folder to write the output file(s) to. Must exist.

copy_resources
  Type:

    boolean

  Required:

    false

  Default:

    true

  if true, copy supporting files (CSS, images, etc) to the `folder`

source_folder
  Type:

    string

  Required:

    false

  the path to find the template and supporting files in. Defaults to those contained in the package. (In the package source, they are in `simplemonitor/html/`.)

upload_command
  Type:

    string

  Required:

    false

  if set, a command to execute each time the output is updated to e.g. upload the files to an external webserver

navbar_title
  Type:

    string

  Required:

    false

  if set, the title to show at the top of the page. The default is “SimpleMonitor”

visual_theme
  Type:

    string

  Required:

    false

  the visual theme for the HTML page. Set to “dark” for dark mode. The default is “light”

map
  Type:

    boolean

  Required:

    false

  set to true to enable the map display instead of the table. You must set the gps value on your Monitors for them to show up!

map_start
  Type:

    comma-separated list of float

  Required:

    if `map` is enabled

  three comma-separated values: the latitude the map display should start at, the longitude, and the zoom level. A good starting value for the zoom is probably between 10 and 15.