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
Copy file name to clipboardExpand all lines: README.md
+11-4Lines changed: 11 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -199,21 +199,28 @@ data:
199
199
- key: # Key in POST request
200
200
```
201
201
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:
203
203
```yml
204
204
timestamp: true # false by default
205
205
```
206
206
207
207
To access the URL for data collection, send a GET request (or navigate) to [http://localhost:8080/measure](http://localhost:8080/measure).
208
208
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
+
209
216
### 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:
211
218
```yml
212
219
results:
213
220
- enable: true # false by default
214
221
```
215
222
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`.
217
224
218
225
### Data export
219
226
To export the data, enable the export option in the configuration file:
@@ -222,7 +229,7 @@ results:
222
229
- export: true # false by default
223
230
```
224
231
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.
Copy file name to clipboardExpand all lines: docs/getting_started.rst
+12-4Lines changed: 12 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -75,25 +75,33 @@ To collect images, create a ``configuration.yml`` file in the root directory and
75
75
data:
76
76
- key: # Key in POST request
77
77
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:
79
79
80
80
.. code:: yaml
81
81
82
82
timestamp: true # false by default
83
83
84
84
To access the URL for data collection, send a GET request (or navigate) to `http://localhost:8080/measure <http://localhost:8080/measure>`_.
85
85
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
+
86
94
Data access
87
95
~~~~~~~~~~~
88
96
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:
90
98
91
99
.. code:: yaml
92
100
93
101
results:
94
102
- enable: true # false by default
95
103
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``.
97
105
98
106
Data export
99
107
~~~~~~~~~~~
@@ -105,4 +113,4 @@ To export the data, enable the export option in the configuration file:
105
113
export:
106
114
- enable: true # false by default
107
115
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