cgm-remote-monitor

Nightscout Web Monitor (a.k.a. cgm-remote-monitor)

This acts as a web-based CGM (Continuous Glucose Monitor) to allow multiple caregivers to remotely view a patient's glucose data in real time. The server reads a MongoDB which is intended to be data from a physical CGM, where it sends new SGV (sensor glucose values) as the data becomes available. The data is then displayed graphically and blood glucose values are predicted 0.5 hours ahead using an autoregressive second order model. Alarms are generated for high and low values, which can be cleared by any watcher of the data.

Looking for documentation?

End user?

Nightscout documentation is currently split to two locations. This page lists all the configuration options in Nightscout and is useful for users who've already gone through the installation process. IF you're looking for the documentation that looks like it's written for non-programmers, that's located at nightscout.github.io.

Older documentation is available at nightscout.info.

Developer?

See CONTRIBUTING.md

#WeAreNotWaiting and this is why.

Table of Contents

• Install
  • Supported configurations:
  • Recommended minimum browser versions for using Nightscout:
  • Windows installation software requirements:
  • Installation notes for users with nginx or Apache reverse proxy for SSL/TLS offloading:
  • Installation notes for Microsoft Azure, Windows:
• Development
• Usage
  • Updating my version?
  • Configure my uploader to match
  • Nightscout API
    • Example Queries
  • Environment
    • Required
    • Features
    • Alarms
    • Core
    • Predefined values for your browser settings (optional)
    • Predefined values for your server settings (optional)
    • Views
    • Plugins
      • Default Plugins
        • delta (BG Delta)
        • direction (BG Direction)
        • upbat (Uploader Battery)
        • timeago (Time Ago)
        • devicestatus (Device Status)
        • errorcodes (CGM Error Codes)
        • ar2 (AR2 Forecasting)
        • simplealarms (Simple BG Alarms)
        • profile (Treatment Profile)
      • Advanced Plugins:
        • careportal (Careportal)
        • boluscalc (Bolus Wizard)
        • food (Custom Foods)
        • rawbg (Raw BG)
        • iob (Insulin-on-Board)
        • cob (Carbs-on-Board)
        • bwp (Bolus Wizard Preview)
        • cage (Cannula Age)
        • sage (Sensor Age)
        • iage (Insulin Age)
        • bage (Battery Age)
        • treatmentnotify (Treatment Notifications)
        • basal (Basal Profile)
        • bolus (Bolus Rendering)
        • connect (Nightscout Connect)
        • bridge (Share2Nightscout bridge), deprecated
        • mmconnect (MiniMed Connect bridge), deprecated
        • pump (Pump Monitoring)
        • openaps (OpenAPS)
        • loop (Loop)
        • override (Override Mode)
        • xdripjs (xDrip-js)
        • alexa (Amazon Alexa)
        • googlehome (Google Home/DialogFLow) [broken]
        • speech (Speech)
        • cors (CORS)
      • Extended Settings
      • Pushover
      • IFTTT Maker
    • Treatment Profile
  • Setting environment variables
    • Vagrant install
  • More questions?
    • Browser testing suite provided by
  • License

Install

Supported configurations:

• Nightscout Setup (recommended)

While you can install Nightscout on a virtual server or a Raspberry Pi, we do not recommend this unless you have at least some experience hosting Node applications and development using the toolchain in use with Nightscout.

If you're a hosting provider and want to provide our users additional hosting options, you're welcome to issue a documentation pull request with instructions on how to setup Nightscout on your system.

Recommended minimum browser versions for using Nightscout:

Our browserslist policy is documented in .browserlistrc.
We currently support approximately 91% of all browsers globally used. These include:

• Android Chrome: 104 or later (and_chr)
• Google Chrome: 101 or later (chrome)
• Microsoft Edge: 103 or later (edge)
• Mozilla Firefox: 102 or later (firefox)
• Apple Safari on iOS: 15.5 or later (ios_saf)
• Opera Mini on Android: 63 or later (op_mini)
• Opera: 88 or later (opera)
• Apple Safari for macOS 10.15 Catalina or later: : 15.5 or later (safari)
• Samsung Internet on Android: 17.0 or later (samsung)
• Internet Explorer 11 : not supported

Older versions or other browsers might work, but are untested and unsupported. We'll try to to keep Nightscout compatible with older iPads (e.g. Safari on iOS 10.3.4), but note that those devices are not supported by Apple anymore and have known security issues. Debugging these old devices gets harder due to Apple not supporting debugging the old devices on Macs that have been updated. Some features may not work with devices/browsers on the older end of these requirements.

Installation software requirements:

• Node.js Node v20 LTS or later (v22, v24 also supported). Node versions that do not have the latest security patches will not be supported. Use Install instructions for Node or use bin/setup.sh)
• MongoDB 4.4 or later (5.0, 6.0 also supported).

As a non-root user clone this repo then install dependencies into the root of the project:

$ npm install

Installation notes for users with nginx or Apache reverse proxy for SSL/TLS offloading:

• Your site redirects insecure connections to https by default. If you use a reverse proxy like nginx or Apache to handle the connection security for you, make sure it sets the X-Forwarded-Proto header. Otherwise nightscout will be unable to know if it was called through a secure connection and will try to redirect you to the https version. If you're unable to set this Header, you can change the INSECURE_USE_HTTP setting in nightscout to true in order to allow insecure connections without being redirected.
• In case you use a proxy. Do not use an external network interfaces for hosting Nightscout. Make sure the unsecure port is not available from a remote network connection
• HTTP Strict Transport Security (HSTS) headers are enabled by default, use settings SECURE_HSTS_HEADER and SECURE_HSTS_HEADER_*
• See Predefined values for your server settings for more details

Installation notes for Microsoft Azure, Windows:

• If deploying the software to Microsoft Azure, you must set ** in the app settings for WEBSITE_NODE_DEFAULT_VERSION and SCM_COMMAND_IDLE_TIMEOUT before you deploy the latest Nightscout or the site deployment will likely fail. Other hosting environments do not require this setting. Additionally, if using the Azure free hosting tier, the installation might fail due to resource constraints imposed by Azure on the free hosting. Please set the following settings to the environment in Azure:

WEBSITE_NODE_DEFAULT_VERSION=16.16.0
SCM_COMMAND_IDLE_TIMEOUT=300

• See install MongoDB, Node.js, and Nightscouton a single Windows system. if you want to host your Nightscout outside of the cloud. Although the instructions are intended for Windows Server the procedure is compatible with client versions of Windows such as Windows 7 and Windows 10.
• If you deploy to Windows and want to develop or test you need to install Cygwin (use setup-x86_64.exe and make sure to install build-essential package. Test your configuration by executing make and check if all tests are ok.

Development

Want to help with development, or just see how Nightscout works? Great! See CONTRIBUTING.md for development-related documentation.

Usage

The data being uploaded from the server to the client is from a MongoDB server such as MongoDB Atlas.

Updating my version

The easiest way to update your version of cgm-remote-monitor to the latest version is to use the update tool. A step-by-step update guide is available here. To downgrade to an older version, follow this guide.

Configure my uploader to match

Use the autoconfigure tool to sync an uploader to your config.

Nightscout API

The Nightscout API enables direct access to your data without the need for Mongo access. You can fi