scottk/wlan-cloud-ucentralgw-ui
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-cloud-ucentralgw-ui.git synced 2025-10-29 18:02:31 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

README update

Browse Source 
Signed-off-by: Charles <charles.bourque96@gmail.com>
This commit is contained in:
Charles
2022-10-19 14:38:43 +01:00
parent 835ee2a046
commit 72c520cca7
1 changed files with 11 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -1,6 +1,7 @@
# uCentralGW UI # uCentralGW UI
## What is this? ## What is this?
The uCentralGW Client is a user interface that lets you monitor and manage devices connected to the [uCentral gateway](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw). To use the interface, The uCentralGW Client is a user interface that lets you monitor and manage devices connected to the [uCentral gateway](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw). To use the interface,
you either need to run it on your machine for [development](#development) or build it for [production](#production). you either need to run it on your machine for [development](#development) or build it for [production](#production).
@@ -9,40 +10,34 @@ NOTE: This UI will be evolving as micro services are added to the uCentral progr
## Running the solution ## Running the solution
### Development ### Development
You need to run these commands in the root folder of the project and also have npm installed on your machine. You need to run these commands in the root folder of the project and also have npm installed on your machine.
``` ```
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw-ui git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw-ui
cd wlan-cloud-ucentralgw-ui cd wlan-cloud-ucentralgw-ui
npm install npm install
npm start npm run dev
```
Run these commands if you want to run the solution on your machine while also doing development on the [uCentral UI Library](https://github.com/Telecominfraproject/wlan-cloud-ucentral-ui-libs).
```
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw-ui
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentral-ui-libs
cd wlan-cloud-ucentralgw-ui
npm link ../wlan-cloud-ucentral-ui-libs // Add sudo at the start of this command if it fails because of permissions
npm start
``` ```
### Production ### Production
You need to run this in the root folder of the project and also have npm installed on your machine. You need to run this in the root folder of the project and also have npm installed on your machine.
``` ```
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw-ui git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw-ui
cd wlan-cloud-ucentralgw-ui cd wlan-cloud-ucentralgw-ui
npm install npm install
npm run build npm run build
``` ```
Once the build is done, you can move the `build` folder on your server. Once the build is done, you can move the `build` folder on your server.
### Configuration ### Configuration
You must change the `config.json` file in `public` directory to point to your uCentral Security Service URL (uCentralSec). You may also limit the ability for users to change the default uCentralSec. If you do not allow a uCentralSec change, the uCentralSec URL will not appear on the login screen.
You can control the uCentral Security Service URL (uCentralSec) by modifying the ENV variable "VITE_UCENTRALSEC_URL". There is an example .env file located at the root of this repository.
Here are the current default values: Here are the current default values:
``` ```
{ VITE_UCENTRALSEC_URL="https://ucentral.dpaas.arilia.com:16001"
"DEFAULT_UCENTRALSEC_URL": "https://ucentral.dpaas.arilia.com:16001",
"ALLOW_UCENTRALSEC_CHANGE": false
}
``` ```