Skip to content

Commit 2d08086

Browse files
Updated frontend configuration documentation (#14)
* Updated frontend configuration documentation * Minor update to frontend configuration description
1 parent 6b17eb2 commit 2d08086

File tree

1 file changed

+6
-13
lines changed

1 file changed

+6
-13
lines changed

source/installation-guide/installation-guide.rst

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -231,22 +231,15 @@ OS2IoT-backend takes several environment variables as configuration, if these ar
231231
OS2IoT-frontend
232232
^^^^^^^^^^^^^^^
233233
234-
The frontend can be configured by modifying :code:`environment.prod.ts` file in :code:`OS2IoT-frontend/src/environments` folder.
235-
236-
.. code-block:: javascript
237-
238-
export const environment = {
239-
production: true,
240-
baseUrl: 'http://localhost:3000/api/v1/',
241-
tablePageSize: 20,
242-
};
234+
The frontend can also be configured using environment variables. If these are not set a default will be used.
235+
Defaults are set in :code:`OS2IoT-frontend/src/environments/environment.ts`
243236
244237
+-------------------------------+--------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
245-
| Configuration variable | Purpose | Default value |
238+
| Environment variable | Purpose | Default value |
246239
+===============================+==============================================================================================================+=========================================================================================+
247-
| production | If true, then Angular is set in production mode, disabling debugging features | :code:`true` |
240+
| PRODUCTION | If true, then Angular is set in production mode, disabling debugging features | :code:`false` |
248241
+-------------------------------+--------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
249-
| baseUrl | The Url which users will connect to the backend from. This must be changed for the system to work externally | :code:`http://localhost:3000/api/v1/` |
242+
| BASE_URL | The Url which users will connect to the backend from. This must be changed for the system to work externally | :code:`http://localhost:3000/api/v1/` |
250243
+-------------------------------+--------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
251-
| tablePageSize | Default page size of tables | :code:`20` |
244+
| TABLE_PAGE_SIZE | Default page size of tables | :code:`20` |
252245
+-------------------------------+--------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+

0 commit comments

Comments
 (0)