Merge pull request #96 from Telecominfraproject/feature/wifi-11729--pages-docs

[WIFI-11729] Add: README info
This commit is contained in:
Dmitry Dunaev
2022-11-29 15:00:38 +03:00
committed by GitHub

View File

@@ -16,6 +16,10 @@ into your own systems. If all you need it to access the uCentralGW for example (
The CLI for the [uCentralGW](https://github.com/telecominfraproject/wlan-cloud-ucentralgw/blob/main/test_scripts/curl/cli) has a very good example of this.
Look for the `setgateway` function.
You may get static page with OpenAPI docs generated from the definition on [GitHub Page](https://telecominfraproject.github.io/wlan-cloud-ucentralsec/).
Also you may use [Swagger UI](https://petstore.swagger.io/#/) with OpenAPI definition file raw link (i.e. [latest version file](https://validator.swagger.io/validator?url=https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-ucentralsec/main/openpapi/owsec.yaml)) to get interactive docs page.
## Firewall Considerations
The entire uCentral systems uses several MicroServices. In order for the whole system to work, you should provide the following port
access:
@@ -264,4 +268,4 @@ on any other app that support the TOTP protocol. You should include the followin
totp.issuer = OrgName
```
It is very important that you not use spaces in your OrgName.
It is very important that you not use spaces in your OrgName.