Admin Tools


Subjects and Roles

Note: authentication tokens are also called access tokens

Changing API_SECRET

If you change your API_SECRET all your tokens will change. Make sure you update your devices and send the new token link to those you allowed to access your Nightscout

To access the Authentication options, click the settings panel (three horizontal bars in the top right) in your website and select Admin Tools. The Authentication options are at the top of the Admin page. (Note: you must be logged in with your API SECRET to access these tools.)

../../_images/Admin04.png

You will see several predefined roles:

../../_images/Admin01.png

Roles

  • admin: full access

  • careportal: can view the site and make CarePortal/treatment entries

  • readable: read-only access; no ability to make CarePortal/treatment entries. This user CAN see reports and profile information.

  • denied: no access (this role only works if the AUTH_DEFAULT_ROLES setting is also denied. You can’t have a site that is readable to everyone and create a “denied” token for a specific user.)

  • devicestatus-upload: used by devices

Hint

There is currently no way to limit a user so that he cannot view the Reports section if he has access to the site. Time/date-based roles are not currently possible.


Create a Token

  • Click the “Add New Subject” button.

../../_images/Admin00.png

  • Fill in the name of the subject and the “role” you are giving this subject (from the list of roles shown above). Note you should only grant the readable role for users who do not need to save or edit data in Nightscout. For example, you might want to share the site to a school nurse, but not have him able edit the data.

../../_images/Admin05.png

  • An admin token is necessary for AAPS to upload using the API V3.

../../_images/Admin05b.png

  • Click save.

  • The token will be shown. You can use it in two different ways:

    • Copy the token URL (right-click on it in the browser and select the option to copy the link address) and provide it to the user (e.g., paste it into an email). If the user enters the entire URL (with token), the token will be in effect.

    • Copy the token string (in the example below school-a595d5f0aeff64c0) and use it for authentication at site opening, instead of the API secret (Nightscout minimum version 14.1.0 required).

../../_images/Admin06.png

You can also add the token to the site URL to authenticate using a token. Your site link with token will look like this:

https://yoursitename.yourplatform.com/?token=school-a595d5f0aeff64c0

Anybody with this link can use your Nightscout with the role defined for this token.

Hint

If the user copies only your core URL into a browser, and your site is readable by default, the token will be bypassed. (Possible strategies to ensure the user puts the role-based URL into a browser include using a tinyurl or bit.ly.)

  • You can edit a subject by clicking the edit icon, making changes, and saving.

  • You can delete a subject by clicking the red X icon to remove the subject from the list.

See how to setup your downloaders (followers) with a secured site.



Database Maintenance

If you use a small or a free database (like MongoDB Atlas), it will require maintenance as nothing in Nightscout is setup to perform cleanup and unless you planned for a larger size database, it will eventually fill-up.

Warning

Make sure you leave dbsize visible on your page to keep it under control.


This panel will give access to basic maintenance actions on various database collections.

Back up before deleting

Database-maintenance actions permanently remove records. Export or back up data you may need before using them, verify the preview or retention value carefully, and keep the confirmation dialog visible until you have checked the selection.


Mongo status Database


Your status database contains battery, pump, … extra information as those defined in devicestatus that you can safely delete when necessary.

../../_images/Admin07.png

When it comes to treatments and entries, deleting data is something you need to carefully evaluate if you like Nightscout to be the main repository for your history.

Mongo treatments Database


../../_images/Admin08.png

Mongo entries Database


../../_images/Admin09.png

Delete records by date range

Nightscout 15.0.8 adds a date-range deletion tool for correcting imports or sync jobs that wrote unwanted data during a known period.

  1. Authenticate the browser with an administrator-capable token or the API secret.

  2. Select entries, treatments, devicestatus, or all three collections.

  3. Select inclusive start and end dates. Day boundaries use the active Nightscout profile timezone.

  4. Select Preview and review the number of matching records. Preview counts are capped at 10,000 per collection, so a displayed count can be an underestimate when the limit is reached.

  5. Start the deletion only after checking the collection and dates, then confirm the warning.

Deletion cannot be undone. When all is selected, Nightscout processes each collection separately and reports the total removed.


Remove old profile records

The profile cleanup tool removes older profile documents while retaining the newest records. Enter how many profile records to keep, from 10 to 10,000; the default is 100. Authentication and confirmation are required.

This tool is useful when repeated profile uploads have created excessive history. It does not edit the retained profile documents.


Remove future items from Database


Future treatments and entries generated by an incorrect time zone, daylight saving time change, or any other mistake can completely block your site. Using this feature will purge the database of these unwanted values automatically. Detected issues will appear in Database contains x future records and should be fixed.


../../_images/Admin10.png