fix: Update configuration for enabling RTSP Server (#1203)

Signed-off-by: Marc-Philippe Fuller <marc-philippe.fuller@intel.com>
edgexfoundry · Nov 29, 2023 · 02ba0a7 · 02ba0a7
1 parent 86b4e06
commit 02ba0a7
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/docs_src/examples/app-service-examples/camera-management/Ch-CameraManagement.md b/docs_src/examples/app-service-examples/camera-management/Ch-CameraManagement.md
@@ -96,14 +96,14 @@ sudo apt install build-essential
     !!! note
         This step is only required if you plan on using USB cameras.
 
-    a. Add enable rtsp server and the rtsp server hostname environment variables to the `device-usb-camera` service, where `your-local-ip-address` is the ip address of the machine running the `device-usb-camera` service.
+    a. Add these environment variables to enable the internal rtsp server and configure the rtsp server hostname. Set `your-local-ip-address` to the ip address of the machine running the `device-usb-camera` service.
 
     !!! example - "Snippet from `add-device-usb-camera.yml`"
         ```yml
         services:
           device-usb-camera:
             environment:
-              DRIVER_ENABLERTSPSERVER: "true"
+              DRIVER_RTSPSERVERMODE: "internal"
               DRIVER_RTSPSERVERHOSTNAME: "your-local-ip-address"
         ```
 

diff --git a/...rvices/device/services/device-usb-camera/supplementary-info/advanced-options.md b/...rvices/device/services/device-usb-camera/supplementary-info/advanced-options.md
@@ -354,14 +354,15 @@ curl -X POST http://localhost:59983/api/{{api_version}}/refreshdevicepaths
 
 It's recommended to trigger a check after re-plugging cameras.
 
-## Configurable RTSP server hostname and port
+## Configurable RTSP server
 
-Enable/Disable RTSP server and set hostname and port of the RTSP server to which the device service publishes video streams can be configured in the [Driver] section of the service configuration located in the `cmd/res/configuration.yaml` file. RTSP server is enabled by default.
+RTSP server mode can be set to `internal` to enable and start RTSP server locally, `external` to enable and indicate RTSP server is hosted externally or `none` to disable RTSP server. If RTSP server is enabled, set hostname and port of the RTSP server to which the device service publishes video streams can be configured in the [Driver] section of the service configuration located in the `cmd/res/configuration.yaml` file. RTSP server is enabled by default.
 
 !!! example - "Snippet from configuration.yaml"
     ```yaml
     Driver:
-        EnableRtspServer: "true"
+        RtspServerMode: "internal"
+        RtspServerExecutable: "./rtsp-simple-server"
         RtspServerHostName: "localhost"
         RtspTcpPort: "8554"
         RtspAuthenticationServer: "localhost:8000"

diff --git a/...src/microservices/device/services/device-usb-camera/walkthrough/custom-build.md b/...src/microservices/device/services/device-usb-camera/walkthrough/custom-build.md
@@ -105,6 +105,7 @@ The default values can be used in this guide.
     ```yaml
     Driver:
         RtspServerMode: "internal"
+        RtspServerExecutable: "./rtsp-simple-server"
         RtspServerHostName: "localhost"
         RtspTcpPort: "8554"
         RtspAuthenticationServer: "localhost:8000"