Telecominfraproject/wlan-cloud-ucentralfms
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-cloud-ucentralfms.git synced 2026-01-27 02:23:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

[WIFI-11729] Add: README info

Browse Source 
Signed-off-by: Dmitry Dunaev <dmitry@opsfleet.com>
This commit is contained in:
Dmitry Dunaev
2022-11-29 15:02:31 +03:00
parent 93a8624645
commit acff9afff2
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -5,6 +5,11 @@ The uCentralFMS is a micro-service part of the OpenWiFi ecosystem. uCentralFMS i
to facilitate the task of upgrade and maintaining the proper firmware for all the devices
used in your OpenWiFi solution. You may either [build it](#building) or use the [Docker version](#docker).
## OpenAPI
You may get static page with OpenAPI docs generated from the definition on [GitHub Page](https://telecominfraproject.github.io/wlan-cloud-ucentralfms/).
Also you may use [Swagger UI](https://petstore.swagger.io/#/) with OpenAPI definition file raw link (i.e. [latest version file](https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-ucentralfms/main/openapi/owfms.yaml)) to get interactive docs page.
## Building
In order to build the uCentralFMS, you will need to install its dependencies, which includes the following:
- cmake
@@ -216,4 +221,4 @@ s3.key = *******************************************
s3.retry = 60
s3.bucket.uri = ucentral-ap-firmware.s3.amazonaws.com
```
```