Skip to content

Commit 59a8d21

Browse files
committed
doc: Data protection
Password protection, new configuration settings
1 parent 20650b9 commit 59a8d21

File tree

2 files changed

+23
-8
lines changed

2 files changed

+23
-8
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,21 +199,28 @@ data:
199199
- key: # Key in POST request
200200
```
201201

202-
To store data collection timestamps, create a `configuration.yml` file in the root directory and define the following:
202+
To store data collection timestamps, define the following setting in the `configuration.yml` file in the root directory:
203203
```yml
204204
timestamp: true # false by default
205205
```
206206

207207
To access the URL for data collection, send a GET request (or navigate) to [http://localhost:8080/measure](http://localhost:8080/measure).
208208

209+
To restrict access to the collected data, define the following setting in the `configuration.yml` file in the root directory:
210+
```yml
211+
password: 'password' # Password for data access
212+
```
213+
214+
To store data using a password, append the password parameter to the request URL: `?password=password`.
215+
209216
### Data access
210-
To access data via the Succulent API, enable the results option in the configuration file:
217+
To access data via the Succulent API, define the following setting in the `configuration.yml` file in the root directory:
211218
```yml
212219
results:
213220
- enable: true # false by default
214221
```
215222

216-
To access the collected data, send a GET request (or navigate) to [http://localhost:8080/data](http://localhost:8080/data).
223+
To access the collected data, send a GET request (or navigate) to [http://localhost:8080/data](http://localhost:8080/data). To access password-protected data, append the password parameter to the request URL: `?password=password`.
217224

218225
### Data export
219226
To export the data, enable the export option in the configuration file:
@@ -222,7 +229,7 @@ results:
222229
- export: true # false by default
223230
```
224231

225-
To export the data, send a GET request (or navigate) to [http://localhost:8080/export](http://localhost:8080/export). The data will be downloaded in the format specified in the configuration file.
232+
To export the data, send a GET request (or navigate) to [http://localhost:8080/export](http://localhost:8080/export). To export password-protected data, append the password parameter to the request URL: `?password=password`. The data will be downloaded in the format specified in the configuration file.
226233

227234
## 🔑 License
228235

docs/getting_started.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,25 +75,33 @@ To collect images, create a ``configuration.yml`` file in the root directory and
7575
data:
7676
- key: # Key in POST request
7777
78-
To store data collection timestamps, create a `configuration.yml` file in the root directory and define the following:
78+
To store data collection timestamps, define the following setting in the ``configuration.yml`` file in the root directory:
7979

8080
.. code:: yaml
8181
8282
timestamp: true # false by default
8383
8484
To access the URL for data collection, send a GET request (or navigate) to `http://localhost:8080/measure <http://localhost:8080/measure>`_.
8585

86+
To restrict access to the collected data, define the following setting in the ``configuration.yml`` file in the root directory:
87+
88+
.. code:: yaml
89+
90+
password: 'password' # Password for data access
91+
92+
To store data using a password, append the password parameter to the request URL: ``?password=password``.
93+
8694
Data access
8795
~~~~~~~~~~~
8896

89-
To access data via the Succulent API, enable the results option in the configuration file:
97+
To access data via the Succulent API, define the following setting in the ``configuration.yml`` file in the root directory:
9098

9199
.. code:: yaml
92100
93101
results:
94102
- enable: true # false by default
95103
96-
To access the collected data, send a GET request (or navigate) to `http://localhost:8080/data <http://localhost:8080/data>`_.
104+
To access the collected data, send a GET request (or navigate) to `http://localhost:8080/data <http://localhost:8080/data>`_. To access password-protected data, append the password parameter to the request URL: ``?password=password``.
97105

98106
Data export
99107
~~~~~~~~~~~
@@ -105,4 +113,4 @@ To export the data, enable the export option in the configuration file:
105113
export:
106114
- enable: true # false by default
107115
108-
To export the data, send a GET request (or navigate) to `http://localhost:8080/export <http://localhost:8080/export>`_. The data will be downloaded in the format specified in the configuration file.
116+
To export the data, send a GET request (or navigate) to `http://localhost:8080/export <http://localhost:8080/export>`_. To export password-protected data, append the password parameter to the request URL: ``?password=password``. The data will be downloaded in the format specified in the configuration file.

0 commit comments

Comments
 (0)