Skip to content

Commit 33fa1ab

Browse files
authored
Update README.md
1 parent bab3ef2 commit 33fa1ab

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ This program is free software: you can redistribute it and/or modify it under th
1414
- update switch settings
1515

1616

17+
## How it's working
18+
* This application requires Mist accounts or API token to be used.
19+
* This application is automatically retrieving the account information and access rights from the Mist Cloud.
20+
* When an operator selects a site, the application is retrieving the list of switches and VCs.
21+
* When an operator selects a switch, the application is retrieving the configured networks/vlans from the Mist Cloud.
22+
* When an operator changes a switch port configuration, the application is creating (or updating) a new "Port Profile" at the switch level with the required configuration, and apply to the switch port. All the port profiles managed by the application are name `autogenerated_<port_id>`.
23+
* There is no information stored on the server side, and all the required information are cached on the web browser side (this means everything will be lost if the page is manually refreshed, or when using the web browser "back" button).
24+
25+
1726
## Installation
1827

1928
This is a demo application using the Mist APIs.
@@ -45,3 +54,4 @@ A configuration example with explanation is avaiable in the `django/backend/conf
4554
DJANGO_DEBUG | Number | 0 | Whether or not Django starts in Debug Mode (0=Production, 1=Debug) |
4655
DJANGO_ALLOWED_HOSTS | String | | FQDN on which Django is listening. Only used in Production Mode |
4756
GOOGLE_API_KEY | String | | Google API Key to use [Google Map Javascript API](https://developers.google.com/maps/gmp-get-started) |
57+

0 commit comments

Comments
 (0)