Skip to content

Commit

Permalink
add swagger env variable
Browse files Browse the repository at this point in the history
  • Loading branch information
patriciareinoso committed Jul 16, 2024
1 parent 5dd01d6 commit f6b954b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ A Network Management System for managing the Aether SD-Core 5G core network.
## Usage

NMS needs to be configured with the following environment variables:
- `SWAGGER_HOST`: The host of the webui. This is used to redirect the swagger operations to the webui.
- `UPF_CONFIG_PATH`: The path to the UPF configuration file. An example of this file can be seen in the `examples/` directory.
- `GNB_CONFIG_PATH`: The path to the gNodeB configuration file. An example of this file can be seen in the `examples/` directory.

```console
export SWAGGER_HOST=10.1.182.28
export UPF_CONFIG_PATH=/path/to/upf_config.json
export GNB_CONFIG_PATH=/path/to/gnb_config.json

docker pull ghcr.io/canonical/sdcore-nms:0.2.0
docker run -it --env UPF_CONFIG_PATH --env GNB_CONFIG_PATH ghcr.io/canonical/sdcore-nms:0.2.0
docker run -it --env UPF_CONFIG_PATH --env GNB_CONFIG_PATH --env WEBUI_ENDPOINT ghcr.io/canonical/sdcore-nms:0.2.0
```

0 comments on commit f6b954b

Please sign in to comment.