{"id":27940741,"url":"https://github.com/telecominfraproject/wlan-cloud-ucentralfms","last_synced_at":"2025-10-09T20:36:18.521Z","repository":{"id":38444584,"uuid":"376146162","full_name":"Telecominfraproject/wlan-cloud-ucentralfms","owner":"Telecominfraproject","description":"uCentral Firmware Service","archived":false,"fork":false,"pushed_at":"2024-10-04T15:54:32.000Z","size":4198,"stargazers_count":2,"open_issues_count":0,"forks_count":4,"subscribers_count":52,"default_branch":"main","last_synced_at":"2025-05-07T10:28:15.988Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Telecominfraproject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-06-11T21:29:51.000Z","updated_at":"2024-12-23T02:42:31.000Z","dependencies_parsed_at":"2023-09-26T18:35:47.919Z","dependency_job_id":"5a0cf89c-2f96-460d-9d4f-d467e9c21569","html_url":"https://github.com/Telecominfraproject/wlan-cloud-ucentralfms","commit_stats":null,"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"purl":"pkg:github/Telecominfraproject/wlan-cloud-ucentralfms","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Telecominfraproject%2Fwlan-cloud-ucentralfms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Telecominfraproject%2Fwlan-cloud-ucentralfms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Telecominfraproject%2Fwlan-cloud-ucentralfms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Telecominfraproject%2Fwlan-cloud-ucentralfms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Telecominfraproject","download_url":"https://codeload.github.com/Telecominfraproject/wlan-cloud-ucentralfms/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Telecominfraproject%2Fwlan-cloud-ucentralfms/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001978,"owners_count":26083259,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-07T10:20:19.867Z","updated_at":"2025-10-09T20:36:18.492Z","avatar_url":"https://github.com/Telecominfraproject.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"images/project/logo.svg\" width=\"200\"/\u003e\n\u003c/p\u003e\n\n# uCentralFMS\n\n## What is this?\nThe uCentralFMS is a micro-service part of the OpenWiFi ecosystem. uCentralFMS is a Firmware Management Service\nto facilitate the task of upgrade and maintaining the proper firmware for all the devices \nused in your OpenWiFi solution. You may either [build it](#building) or use the [Docker version](#docker).\n\n## OpenAPI\nYou may get static page with OpenAPI docs generated from the definition on [GitHub Page](https://telecominfraproject.github.io/wlan-cloud-ucentralfms/).\nAlso, 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.\n\n## Building\nTo build the microservice from source, please follow the instructions in [here](./BUILDING.md)\n\n## Docker\nTo use the CLoudSDK deployment please follow [here](https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy)\n\n#### Expected directory layout\nFrom the directory where your cloned source is, you will need to create the `certs`, `logs`, and `uploads` directories.\n```bash\nmkdir certs\nmkdir certs/cas\nmkdir logs\nmkdir uploads\n```\nYou should now have the following:\n```text\n--+-- certs\n  |   +--- cas\n  +-- cmake\n  +-- cmake-build\n  +-- logs\n  +-- src\n  +-- test_scripts\n  +-- openapi\n  +-- uploads\n  +-- owsec.properties\n```\n\n### Certificate\nThe OWFMS uses a certificate to provide security for the REST API Certificate to secure the Northbound API.\n\n#### The `certs` directory\nFor all deployments, you will need the following `certs` directory, populated with the proper files.\n\n```text\ncerts ---+--- restapi-ca.pem\n         +--- restapi-cert.pem\n         +--- restapi-key.pem\n```\n\n## Firewall Considerations\n| Port  | Description                                   | Configurable |\n|:------|:----------------------------------------------|:------------:|\n| 16003 | Default port for REST API Access to the OWFMS |     yes      |\n\n### Environment variables\nThe following environment variables should be set from the root directory of the service. They tell the OWGW process where to find\nthe configuration and the root directory.\n```bash\nexport OWGW_ROOT=`pwd`\nexport OWGW_CONFIG=`pwd`\n```\nYou can run the shell script `set_env.sh` from the microservice root.\n\n### OWFMS Service Configuration\nThe configuration is kept in a file called `owfms.properties`. To understand the content of this file,\nplease look [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralfms/blob/main/CONFIGURATION.md)\n\n## Kafka topics\nToe read more about Kafka, follow the [document](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/KAFKA.md)\n\n## Contributions\nWe need more contributors. Should you wish to contribute,\nplease follow the [contributions](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/CONTRIBUTING.md) document.\n\n## Pull Requests\nPlease create a branch with the Jira addressing the issue you are fixing or the feature you are implementing.\nCreate a pull-request from the branch into master.\n\n## Additional OWSDK Microservices\nHere is a list of additional OWSDK microservices\n| Name | Description | Link | OpenAPI |\n| :--- | :--- | :---: | :---: |\n| OWSEC | Security Service | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralsec) | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml) |\n| OWGW | Controller Service | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw) | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/openapi/owgw.yaml) |\n| OWFMS | Firmware Management Service | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralfms) | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralfms/blob/main/openapi/owfms.yaml) |\n| OWPROV | Provisioning Service | [here](https://github.com/Telecominfraproject/wlan-cloud-owprov) | [here](https://github.com/Telecominfraproject/wlan-cloud-owprov/blob/main/openapi/owprov.yaml) |\n| OWANALYTICS | Analytics Service | [here](https://github.com/Telecominfraproject/wlan-cloud-analytics) | [here](https://github.com/Telecominfraproject/wlan-cloud-analytics/blob/main/openapi/owanalytics.yaml) |\n| OWSUB | Subscriber Service | [here](https://github.com/Telecominfraproject/wlan-cloud-userportal) | [here](https://github.com/Telecominfraproject/wlan-cloud-userportal/blob/main/openapi/userportal.yaml) |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelecominfraproject%2Fwlan-cloud-ucentralfms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftelecominfraproject%2Fwlan-cloud-ucentralfms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelecominfraproject%2Fwlan-cloud-ucentralfms/lists"}