mirror of
https://github.com/Telecominfraproject/wlan-cloud-ucentralsec.git
synced 2025-10-28 17:32:29 +00:00
Signed-off-by: stephb9959 <stephane.bourque@gmail.com>
This commit is contained in:
39
README.md
39
README.md
@@ -40,6 +40,40 @@ You may get static page with OpenAPI docs generated from the definition on [GitH
|
||||
|
||||
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.
|
||||
|
||||
#### Expected directory layout
|
||||
From the directory where your cloned source is, you will need to create the `certs`, `logs`, and `uploads` directories.
|
||||
```bash
|
||||
mkdir certs
|
||||
mkdir certs/cas
|
||||
mkdir logs
|
||||
mkdir uploads
|
||||
```
|
||||
You should now have the following:
|
||||
```text
|
||||
--+-- certs
|
||||
| +--- cas
|
||||
+-- cmake
|
||||
+-- cmake-build
|
||||
+-- logs
|
||||
+-- src
|
||||
+-- test_scripts
|
||||
+-- openapi
|
||||
+-- uploads
|
||||
+-- owsec.properties
|
||||
```
|
||||
|
||||
### Certificate
|
||||
The OWSEC uses a certificate to provide security for the REST API Certificate to secure the Northbound API.
|
||||
|
||||
#### The `certs` directory
|
||||
For all deployments, you will need the following `certs` directory, populated with the proper files.
|
||||
|
||||
```text
|
||||
certs ---+--- restapi-ca.pem
|
||||
+--- restapi-cert.pem
|
||||
+--- restapi-key.pem
|
||||
```
|
||||
|
||||
## Firewall Considerations
|
||||
| Port | Description | Configurable |
|
||||
|:------|:-------------------------------------------|:------------:|
|
||||
@@ -113,11 +147,6 @@ docker run --rm -ti \
|
||||
/cli testlogin $OWSEC_DEFAULT_USERNAME $OWSEC_DEFAULT_PASSWORD $OWSEC_NEW_PASSWORD
|
||||
```
|
||||
|
||||
## Firewall Considerations
|
||||
| Port | Description | Configurable |
|
||||
|:------|:----------------------------------------------|:------------:|
|
||||
| 16001 | Default port for REST API Access to the OWSEC | yes |
|
||||
|
||||
It is very important that you not use spaces in your OrgName.
|
||||
## Kafka topics
|
||||
Toe read more about Kafka, follow the [document](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/KAFKA.md)
|
||||
|
||||
Reference in New Issue
Block a user