You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -132,40 +131,38 @@ See [CONTRIBUTING.md](CONTRIBUTING.md)
132
131
133
132
## Supported configurations:
134
133
135
-
If you plan to use Nightscout, we recommend using [Heroku](https://nightscout.github.io/nightscout/new_user/) as this is free and easy to use.
136
-
We used to recommend hostig at Azure, but the resource needs of Nightscout have grown over the years and Azure won't comfortably run Nightscout
137
-
anymore in the free tier. If you're hosting in Azure and looking to update your site, we recommend you
138
-
[switch from Azure to Heroku](http://openaps.readthedocs.io/en/latest/docs/While%20You%20Wait%20For%20Gear/nightscout-setup.html#switching-from-azure-to-heroku)
139
-
as you're likely to hit issues in the process of updating the site.
140
-
141
-
-[Nightscout Setup with Heroku](https://nightscout.github.io/nightscout/new_user/) (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
144
-
experience hosting Node applications and development using the toolchain in use with Nightscout. Heroku automates all of the
145
-
hosting for you and even many of the dvelopers run their production sites in Heroku due to convenience.
137
+
experience hosting Node applications and development using the toolchain in use with Nightscout.
146
138
147
-
If you're a hosting provider and want to provide our users additional free hosting options,
139
+
If you're a hosting provider and want to provide our users additional hosting options,
148
140
you're welcome to issue a documentation pull request with instructions on how to setup Nightscout on your system.
149
141
150
142
## Recommended minimum browser versions for using Nightscout:
151
143
152
-
Older versions of the browsers might work, but are untested.
144
+
Our [browserslist](https://github.com/browserslist/browserslist) policy is documented in `.browserlistrc`.
145
+
We currently support approximately [91%](https://browsersl.ist/?q=%3E+0.25%25%2C+ios_saf+9.3%2C+ios_saf+10.3%2C+ios_saf+13.7%2C+ios_saf+14.8%2C+not+dead%2C+not+and_uc+12.12%2C+not+ie+11%0A) of all browsers globally used. These include:
146
+
147
+
- Android Chrome: 104 or later (`and_chr`)
148
+
- Google Chrome: 101 or later (`chrome`)
149
+
- Microsoft Edge: 103 or later (`edge`)
150
+
- Mozilla Firefox: 102 or later (`firefox`)
151
+
- Apple Safari on iOS: 15.5 or later (`ios_saf`)
152
+
- Opera Mini on Android: 63 or later (`op_mini`)
153
+
- Opera: 88 or later (`opera`)
154
+
- Apple Safari for macOS 10.15 Catalina or later: : 15.5 or later (`safari`)
155
+
- Samsung Internet on Android: 17.0 or later (`samsung`)
156
+
- Internet Explorer 11 : not supported
153
157
154
-
- Android 4
155
-
- iOS 6
156
-
- Chrome 35
157
-
- Edge 17
158
-
- Firefox 61
159
-
- Opera 12.1
160
-
- Safari 6 (macOS 10.7)
161
-
- Internet Explorer: not supported
158
+
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.
162
159
163
-
Some features may not work with devices/browsers on the older end of these requirements.
164
160
165
-
## Windows installation software requirements:
166
161
167
-
-[Node.js](http://nodejs.org/) Latest Node 12 LTS. Node versions that do not have the latest security patches will not work. Use [Install instructions for Node](https://nodejs.org/en/download/package-manager/) or use `bin/setup.sh`)
168
-
-[MongoDB](https://www.mongodb.com/download-center?jmp=nav#community) 3.x or later. MongoDB 2.4 is only supported for Raspberry Pi.
162
+
## Installation software requirements:
163
+
164
+
-[Node.js](http://nodejs.org/) Latest Node v14 or v16 LTS. Node versions that do not have the latest security patches will not be supported. Use [Install instructions for Node](https://nodejs.org/en/download/package-manager/) or use `bin/setup.sh`)
165
+
-[MongoDB](https://www.mongodb.com/download-center?jmp=nav#community) 4.2 or 4.4.
169
166
170
167
As a non-root user clone this repo then install dependencies into the root of the project:
171
168
@@ -184,7 +181,7 @@ $ npm install
184
181
185
182
- 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:
186
183
```
187
-
WEBSITE_NODE_DEFAULT_VERSION=10.15.2
184
+
WEBSITE_NODE_DEFAULT_VERSION=16.16.0
188
185
SCM_COMMAND_IDLE_TIMEOUT=300
189
186
```
190
187
- See [install MongoDB, Node.js, and Nightscouton a single Windows system](https://github.com/jaylagorio/Nightscout-on-Windows-Server). 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.
@@ -232,7 +229,7 @@ Once you've installed Nightscout, you can access API documentation by loading `/
232
229
* Boluses over 2U: `http://localhost:1337/api/v1/treatments.json?find[insulin][$gte]=2`
233
230
234
231
The API is Swagger enabled, so you can generate client code to make working with the API easy.
235
-
To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs/ or review [swagger.yaml](swagger.yaml).
232
+
To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs/ or review [swagger.yaml](lib/server/swagger.yaml).
236
233
237
234
## Environment
238
235
@@ -256,6 +253,14 @@ To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs/ or
256
253
*`IMPORT_CONFIG` - Used to import settings and extended settings from a url such as a gist. Structure of file should be something like: `{"settings": {"theme": "colors"}, "extendedSettings": {"upbat": {"enableAlerts": true}}}`
257
254
*`TREATMENTS_AUTH` (`on`) - possible values `on` or `off`. Deprecated, if set to `off` the `careportal` role will be added to `AUTH_DEFAULT_ROLES`
258
255
256
+
#### Data Rights
257
+
258
+
These are useful to help protect your rights to portability and
259
+
autonomy for your data:
260
+
*`OBSCURED` - list, identical to `ENABLE`, a list of plugins to
261
+
obscure.
262
+
*`OBSCURE_DEVICE_PROVENANCE` - Required, a string visible to the [companies deciding to filter based on your data](https://help.sugarmate.io/en/articles/4673402-adding-a-nightscout-data-source). For example, `my-data-rights`.
263
+
259
264
### Alarms
260
265
261
266
These alarm setting affect all delivery methods (browser, Pushover, IFTTT, etc.). Values and settings entered here will be the defaults for new browser views, but will be overridden if different choices are made in the settings UI.
@@ -484,8 +489,98 @@ To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs/ or
484
489
*`BOLUS_RENDER_FORMAT` (`default`) - Possible values are `hidden`, `default` (with leading zero and U), `concise` (with U, without leading zero), and `minimal` (without leading zero and U).
485
490
*`BOLUS_RENDER_FORMAT_SMALL` (`default`) - Possible values are `hidden`, `default` (with leading zero and U), `concise` (with U, without leading zero), and `minimal` (without leading zero and U).
486
491
492
+
##### `connect` (Nightscout Connect)
493
+
494
+
Connect common diabetes cloud resources to Nightscout.
495
+
Include the keyword `connect` in the `ENABLE` list.
496
+
Nightscout connection uses extended settings using the environment variable prefix `CONNECT_`.
497
+
*`CONNECT_SOURCE` - The name for the source of one of the supported inputs. one of `nightscout`, `dexcomshare`, etc...
498
+
###### Nightscout
499
+
500
+
> Work in progress
501
+
502
+
To sync from another Nightscout site, include `CONNECT_SOURCE_ENDPOINT` and
The `CONNECT_SOURCE_ENDPOINT` must be a fully qualified URL and may contain a
509
+
`?token=<subject>` query string to specify an accessToken.
510
+
The `CONNECT_SOURCE_API_SECRET`, if provided, will be used to create a token
511
+
called `nightscout-connect-reader`. This information or the token provided in
512
+
the query will be used to read information from Nightscout and is optional if
513
+
the site is readable by default.
514
+
515
+
Select this driver by setting `CONNECT_SOURCE` equal to `nightscout`.
516
+
517
+
518
+
519
+
###### Dexcom Share
520
+
To synchronize from Dexcom Share use the following variables.
521
+
*`CONNECT_SOURCE=dexcomshare`
522
+
*`CONNECT_SHARE_ACCOUNT_NAME=`
523
+
*`CONNECT_SHARE_PASSWORD=`
524
+
525
+
Optional, `CONNECT_SHARE_REGION` and `CONNECT_SHARE_SERVER` do the same thing, only specify one.
526
+
*`CONNECT_SHARE_REGION=``ous` or `us`. `us` is the default if nothing is
527
+
provided. Selecting `us` sets `CONNECT_SHARE_SERVER` to `share2.dexcom.com`.
528
+
Selecting `ous` here sets `CONNECT_SHARE_SERVER` to `shareous1.dexcom.com`.
529
+
*`CONNECT_SHARE_SERVER=` set the server domain to use.
530
+
531
+
532
+
###### Glooko
533
+
534
+
> Note: Experimental.
535
+
536
+
To synchronize from Glooko use the following variables.
537
+
*`CONNECT_SOURCE=glooko`
538
+
*`CONNECT_GLOOKO_EMAIL=`
539
+
*`CONNECT_GLOOKO_PASSWORD=`
540
+
541
+
By default, `CONNECT_GLOOKO_SERVER` is set to `api.glooko.com` because the
542
+
default value for `CONNECT_GLOOKO_ENV` is `default`.
543
+
*`CONNECT_GLOOKO_ENV` is the word `default` by defalt. Other values are
544
+
`development`, `production`, for `api.glooko.work`, and
545
+
`externalapi.glooko.com`, respectively.
546
+
*`CONNECT_GLOOKO_SERVER` the hostname server to use - `api.glooko.com` by `default`.
547
+
548
+
If both, `CONNECT_GLOOKO_SERVER` and `CONNECT_GLOOKO_ENV` are set, only
549
+
`CONNECT_GLOOKO_SERVER` will be used.
550
+
551
+
###### Libre Link Up
552
+
To synchronize from Libre Link Up use the following variables.
553
+
*`CONNECT_SOURCE=linkup`
554
+
*`CONNECT_LINK_UP_USERNAME=`
555
+
*`CONNECT_LINK_UP_PASSWORD=`
556
+
557
+
By default, `CONNECT_LINK_UP_SERVER` is set to `api-eu.libreview.io` because the
558
+
default value for `CONNECT_LINK_UP_REGION` is `EU`.
559
+
Other available values for `CONNECT_LINK_UP_REGION`:
560
+
*`US`, `EU`, `DE`, `FR`, `JP`, `AP`, `AU`, `AE`
561
+
562
+
For folks connected to many patients, you can provide the patient ID by setting
563
+
the `CONNECT_LINK_UP_PATIENT_ID` variable.
564
+
565
+
###### Minimed Carelink
566
+
567
+
To synchronize from Medtronic Minimed Carelink, set the following
568
+
environment variables.
569
+
*`CONNECT_SOURCE=minimedcarelink`
570
+
*`CONNECT_CARELINK_USERNAME`
571
+
*`CONNECT_CARELINK_PASSWORD`
572
+
*`CONNECT_CARELINK_REGION` Either `eu` to set `CONNECT_CARELINK_SERVER` to
573
+
`carelink.minimed.eu` or `us` to use `carelink.minimed.com`.
574
+
575
+
For folks using the new Many to Many feature, please provide the username of the
576
+
patient to follow using `CONNECT_CARELINK_PATIENT_USERNAME` variable.
577
+
578
+
487
579
##### `bridge` (Share2Nightscout bridge)
488
-
Glucose reading directly from the Dexcom Share service, uses these extended settings:
580
+
581
+
> **Deprecated** Please consider using the `connect` plugin instead.
582
+
583
+
Fetch glucose reading directly from the Dexcom Share service, uses these extended settings:
489
584
*`BRIDGE_USER_NAME` - Your username for the Share service.
490
585
*`BRIDGE_PASSWORD` - Your password for the Share service.
491
586
*`BRIDGE_INTERVAL` (`150000`*2.5 minutes*) - The time (in milliseconds) to wait between each update.
@@ -496,6 +591,9 @@ To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs/ or
496
591
*`BRIDGE_SERVER` (``) - The default blank value is used to fetch data from Dexcom servers in the US. Set to (`EU`) to fetch from European servers instead.
497
592
498
593
##### `mmconnect` (MiniMed Connect bridge)
594
+
595
+
> **Deprecated** Please consider using the `connect` plugin instead.
596
+
499
597
Transfer real-time MiniMed Connect data from the Medtronic CareLink server into Nightscout ([read more](https://github.com/mddub/minimed-connect-to-nightscout))
500
598
*`MMCONNECT_USER_NAME` - Your user name for CareLink Connect.
501
599
*`MMCONNECT_PASSWORD` - Your password for CareLink Connect.
0 commit comments