scottk/wlan-cloud-ucentralgw
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-cloud-ucentralgw.git synced 2025-10-28 17:32:26 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

https://telecominfraproject.atlassian.net/browse/WIFI-11388

Browse Source 
Signed-off-by: stephb9959 <stephane.bourque@gmail.com>
This commit is contained in:
stephb9959
2023-02-26 22:42:56 -08:00
parent 6739b42162
commit 699b28b9af
1 changed files with 27 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@@ -16,9 +16,6 @@ To build the microservice from source, please follow the instructions in [here](
## Docker
To use the CLoudSDK deployment please follow [here](https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy)
### After completing the build
After completing the build, you can remove the Poco source as it is no longer needed.
#### Expected directory layout
From the directory where your cloned source is, you will need to create the `certs`, `logs`, and `uploads` directories.
```bash
@@ -27,17 +24,13 @@ mkdir certs/cas
mkdir logs
mkdir uploads
```
You should now have the following:
```
-- cert_scripts
|
+-- certs
```text
--+-- certs
| +--- cas
+-- cmake
+-- cmake-build
+-- logs (dir)
+-- logs
+-- src
+-- test_scripts
+-- openapi
@@ -46,12 +39,16 @@ You should now have the following:
```
### Certificates
Love'em or hate'em, we need to use'em. So we tried to make this as easy as possible for you.
The OWGW uses a number of certificates to provide security. There are 2 types of certificates required for
a normal deployment:
- A Server Certificate to secure the OWGW<->AP channel
- A REST API Certificate to secure the Northbound API
- Device Certificates
#### The `certs` directory
For all deployments, you will need the following certs directory, populated with the proper files.
```asm
```text
certs ---+--- root.pem
+--- issuer.pem
+--- websocket-cert.pem
@@ -80,6 +77,19 @@ The gateway requires a key/certificate/ca for the REST interface. These files yo
document. You, may choose to select LestEncrypt or any other Certificate Authority. Once you have these files, you need to renamed them `restapi-key.pem`, `restapi-cert.pem`, and `restapi-ca.pem`.
This will guarantee proper HTTPS in your browser and RESTAPI.
### OpenWiFi Device certificates
This may have already done at the factory. If not, you will need to get the following in order to point your devices to use the OWGW:
- A DigiCert certificate that you will call `cert.pem`
- A DigiCert key that goes with that certificate. Please call this `key.pem`
- The Digicert root certificate that you will find [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/certificates/root.pem). You must copy `root.pem`
and rename it `cas.pem` on the device.
- A Device ID file called `dev-id` or something similar
- Copy all the 4 files to the `/certificates` directory of the AP (you must have firmware created Jun 15th or later).
You will need to upgrade your device to the latest firmware. Once updated, you will need to copy the 4 files mentioned above in
the `/certificates` directory. Please remove all old keys or certificates from the `/etc/ucentral` directory
(anything ending in `.pem`).
### Environment variables
The following environment variables should be set from the root directory of the service. They tell the OWGW process where to find
the configuration and the root directory.
@@ -95,23 +105,14 @@ please look [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/
### Running the OWGW
Tu run the OWGW, you must run the executable `owgw`. You can use several command line options to run as a daemon or
specify the configuration file location.
specify the configuration file location.
### OpenWiFi Device certificates
This may have already done at the factory. If not, you will need to get the following in order to point your devices to use the OWGW:
- A DigiCert certificate that you will call `cert.pem`
- A DigiCert key that goes with that certificate. Please call this `key.pem`
- The Digicert root certificate that you will find [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/certificates/root.pem). You must copy `root.pem`
and rename it `cas.pem` on the device.
- A Device ID file called `dev-id` or something similar
- Copy all the 4 files to the `/certificates` directory of the AP (you must have firmware created Jun 15th or later).
You will need to upgrade your device to the latest firmware. Once updated, you will need to copy the 4 files mentioned above in
the `/certificates` directory. Please remove all old keys or certificates from the `/etc/ucentral` directory
(anything ending in `.pem`).
### systemd: owgw.service
`owgw.service` is a skeleton to allow to run the OWGW in a systemd based operating system (i.e. Debian). You will need
to modify slightly to reflect your environment.
### Default device configuration
By default, the devices will receive a built-in default configuration. This built-in default configuration is probably no what you need.
By default, the devices will receive a built-in default configuration. This built-in default configuration is probably not what you need.
So there are 2 options in order to specify your own default configuration:
- In the OWGW data directory, you can create a `default_config.json` file that contains your own personal configuration
- Using the OWGW UI, on the left hand pane, there is a `configurations` choice. There you can do the same but apply it with more granularity ot each device type