Updated documentation

linlin2018 · Mar 14, 2021 · 45106d9 · 45106d9
1 parent a09823e
commit 45106d9
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 3 deletions.
diff --git a/.charts/index.yaml b/.charts/index.yaml
@@ -3,13 +3,13 @@ entries:
   routr:
   - apiVersion: v2
     appVersion: 1.0.0-rc5
-    created: "2021-03-14T13:27:10.689894-04:00"
+    created: "2021-03-14T14:51:51.179883-04:00"
     dependencies:
     - name: redis
       repository: https://charts.bitnami.com/bitnami
       version: 10.6.18
     description: Next-generation SIP Server
-    digest: 4fd30cbb5ef23917fa8bf64849a27bc1ca06c35019c72479c8efbeb6f017dadb
+    digest: a734ebb8c5fc13537de434f388e2757f179e8f4717eff6e9e815fcd429f72942
     icon: https://routr.io/site_assets/images/avatar.png
     keywords:
     - routr
@@ -35,4 +35,4 @@ entries:
     urls:
     - routr-0.0.8.tgz
     version: 0.0.8
-generated: "2021-03-14T13:27:10.683535-04:00"
+generated: "2021-03-14T14:51:51.168884-04:00"
diff --git a/.charts/routr-0.0.8.tgz b/.charts/routr-0.0.8.tgz
diff --git a/.helm/README.md b/.helm/README.md
@@ -114,6 +114,14 @@ The following table lists the configurable parameters of the Routr chart and the
 | routr.securityContext.client.protocols.[*] | Accepted TLS protocols |`[TLSv1.2, TLSv1.1, TLSv1]` |
 | routr.securityContext.debugging | Turns `ON` or `OFF` SSL debugging | `false` |
 | routr.logLevel | Routr's logging level  | `info` |
+| routr.ex_rtpEngine.enabled | If enabled, it will send all media thru the RTPEngine. | `false` |
+| routr.ex_rtpEngine.proto | Reserved to allow for NG commands via `http`, `https`, and `udp`. Currently only `http` is supported | `http` |
+| routr.ex_rtpEngine.host | Address for RTPEngine | "" |
+| routr.ex_rtpEngine.port | Port for RTPEngine | `8080` |
+| routr.ex_convertTelToE164 | If enabled, it will convert the number on ingress calls to `E164` format before routing the call | `false` |
+| routr.ex_uniqueGatewayPerHostPort | If enabled, it will yield an error if a Gateway with the same host and port combination already exists | `false` |
+
+> Variables prefixed with `ex_` are experimental features and may be removed or renamed in the future.
 
 ### Routr Images [advanced] (optional)
 

diff --git a/docs/configuration/general.md b/docs/configuration/general.md
@@ -36,6 +36,14 @@ can be provided using the file `config/config.yml` located at the root of your R
 | spec.securityContext.client.authType | Type of client authentication. Defaults to `DisabledAll`. See https://goo.gl/1vKbXW for more options | No |
 | spec.securityContext.client.protocols.[*] | Accepted TLS protocols. Defaults to [`TLSv1.2`, `TLSv1.1`, `TLSv1`] | No |
 | spec.securityContext.debugging | Turns ON or OFF ssl debugging. Defaults to `false` | No |
+| spec.ex_rtpEngine.enabled | If enabled, it will send all media thru the RTPEngine. Defaults to `false` | No |
+| spec.ex_rtpEngine.proto | Reserved to allow for NG commands via `http`, `https`, and `udp`. Currently only `http` is supported | No |
+| spec.ex_rtpEngine.host | Address for RTPEngine | No |
+| spec.ex_rtpEngine.port | Port for RTPEngine | No |
+| spec.ex_convertTelToE164 | If enabled, it will convert the number on ingress calls to `E164` format before routing the call. Defaults to `false` | No |
+| spec.ex_uniqueGatewayPerHostPort | If enabled, it will yield an error if a Gateway with the same host and port combination already exists. Defaults to `false` | No |
+
+> Variables prefixed with `ex_` are experimental features and may be removed or renamed in the future.
 
 ## Transport Configuration