Skip to content

Commit

Permalink
Refresh Setup variables
Browse files Browse the repository at this point in the history
Checked links and fixed some Sphinx warnings.
  • Loading branch information
psonnera committed Jan 28, 2024
1 parent 2136ab6 commit 03fd654
Show file tree
Hide file tree
Showing 23 changed files with 163 additions and 237 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'Nightscout Documentation'
copyright = '2023, #WeAreNotWaiting'
copyright = '2024, #WeAreNotWaiting'
author = 'Patrick Sonnerat'

# -- General configuration ---------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/nightscout/admin_tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Make sure you leave [`dbsize`](/nightscout/setup_variables.md#dbsize-database-si

</br>

This panel will give access to basic maintenance actions on various database collections as defined in your site [core](/nightscout/setup_variables.md#core) variables.
This panel will give access to basic maintenance actions on various database collections.

</br>

Expand Down
2 changes: 2 additions & 0 deletions docs/nightscout/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ Some common deployment methods:

</br>

(nas)=

## Building Nightscout inside your NAS

Don't buy a NAS device just for this, but if you already have one that's worth a try!
Expand Down
8 changes: 4 additions & 4 deletions docs/nightscout/discover.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Optionally you will see other indications (pills) that can be personalized in yo

## Authenticate yourself

By default you site opens read only, you need to authenticate using your [API secret](/nightscout/setup_variables.md#api_secret) in order to modify settings and add treatments. Click on the lock icon, enter your API secret and click `Update`.
By default you site opens read only, you need to authenticate using your [API secret](api-secret) in order to modify settings and add treatments. Click on the lock icon, enter your API secret and click `Update`.

<img src="/nightscout/img/UseNS04.png" width="400px" />

Expand Down Expand Up @@ -139,7 +139,7 @@ You can log physical activities and specify the duration.

### Insulin Cartridge Change `iage`

Logging these events will help you remember various expirations dates and will update the [corresponding pills](/nightscout/setup_variables.md#age-age-pills) if enabled.
Logging these events will help you remember various expirations dates and will update the [corresponding pills](/nightscout/setup_variables.md#age-pills) if enabled.

<img src="/nightscout/img/UseNS14.png" width="500px" />

Expand Down Expand Up @@ -255,7 +255,7 @@ You can customize your view using Settings. Changes will only be applied to your

You need to [authenticate](#authenticate-yourself) to save your settings.

#### [**Units `DISPLAY_UNITS`**](/nightscout/setup_variables.md#display_units)
#### [**Units `DISPLAY_UNITS`**](display-units)

#### [**Date Format `TIME_FORMAT`**](/nightscout/setup_variables.md#time_format-12)

Expand Down Expand Up @@ -291,7 +291,7 @@ You need to [authenticate](#authenticate-yourself) to save your settings.

</br>

In order to `Save` your changes you need to Authenticate, click `Authenticate` and enter your [API Secret](/nightscout/setup_variables.md#api_secret).
In order to `Save` your changes you need to Authenticate, click `Authenticate` and enter your [API Secret](api-secret).

`Reset, and use defaults` will reverse your changes to defaults from your [config variables](/nightscout/setup_variables.md#nightscout-config-vars).

Expand Down
Binary file removed docs/nightscout/img/SetupNS37.png
Binary file not shown.
Binary file removed docs/nightscout/img/SetupNS38.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/nightscout/new_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ These solutions require a monthly fee.
Paying for a platform doesn't imply your database is included and covered by the plan.
```

[Heroku](/vendors/heroku/new_user), [Railway](/vendors/railway/new_user) with [database](/vendors/railway/database), [Northflank database](/vendors/northflank/database) or [NAS](/advanced.md#building-nightscout-inside-your-nas)
[Heroku](/vendors/heroku/new_user), [Railway](/vendors/railway/new_user) with [database](/vendors/railway/database), [Northflank database](/vendors/northflank/database) or [NAS](nas)

<img src="./img/Comparison3.png" width="700px" />

Expand Down
2 changes: 1 addition & 1 deletion docs/nightscout/profile_editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<img src="/nightscout/img/SetupNS13a.png" width="300px"/>

The top part will show your site settings: [`Title`](/nightscout/setup_variables.md#custom_title-nightscout), [`Units`](/nightscout/setup_variables.md#display_units) and [`Date Format`](/nightscout/setup_variables.md#time_format-12).
The top part will show your site settings: [`Title`](/nightscout/setup_variables.md#custom_title-nightscout), [`Units`](display-units) and [`Date Format`](/nightscout/setup_variables.md#time_format-12).

<img src="/nightscout/img/Profile00.png" width="600px" />

Expand Down
4 changes: 2 additions & 2 deletions docs/nightscout/reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ This will give you a table of your treatments, day by day.

## Profiles

This report will display [profiles](../nightscout/profile_editor.md) used in the time range.
This report will display [profiles](/nightscout/profile_editor.md) used in the time range.

<img src="/nightscout/img/Reports17.png" width="800px" />

Expand Down Expand Up @@ -206,7 +206,7 @@ Make sure to temporarily [disable authentication](/nightscout/security.md#how-to

[https://nightrep.zreptil.de/](https://nightrep.zreptil.de/) can be used to generate PDF documents with the data stored at Nightscout.

You need to add [`cors`](/nightscout/setup_variables.md#cors-cors) to your [`ENABLE`](/nightscout/setup_variables.md#enable) variables
You need to add [`cors`](/nightscout/setup_variables.md#cors-cors) to your [`ENABLE`](enable) variables

Facebook group [Nightscout Reporter](https://www.facebook.com/nightrep)

Expand Down
6 changes: 3 additions & 3 deletions docs/nightscout/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,17 +104,17 @@ Make sure [the app you use to see your data](/nightscout/downloaders) can handle

To Take Advantage of Roles, Turn Off Unauthorized Access to Your Site:

If you want to ensure that ONLY someone with permission to view your site (e.g., a token) is able to view the data, you should configure the [`AUTH_DEFAULT_ROLES`](/nightscout/setup_variables.md#auth_default_roles) variable. Set the value as: `denied`.
If you want to ensure that ONLY someone with permission to view your site (e.g., a token) is able to view the data, you should configure the [`AUTH_DEFAULT_ROLES`](auth_default_roles) variable. Set the value as: `denied`.

Edit (or add) this variable and set it to `denied` (see [here](../setup_variables.md#nightscout-configuration) how to edit variables).
Edit (or add) this variable and set it to `denied` (see [here](/nightscout/setup_variables.md#nightscout-configuration) how to edit variables).

<img src="/nightscout/img/Admin03.png" width="600px" />

This creates a scenario in which a token will be required for all access (even only view).

<img src="/nightscout/img/Admin02.png" width="600px" />

In order to make your site visible to anybody, set [`AUTH_DEFAULT_ROLES`](/nightscout/setup_variables.md#auth_default_roles) variable to `readable`.
In order to make your site visible to anybody, set [`AUTH_DEFAULT_ROLES`](auth_default_roles) variable to `readable`.

</br>

Expand Down
Loading

0 comments on commit 03fd654

Please sign in to comment.