Skip to content

Commit f3b76c3

Browse files
committed
clean up docs
1 parent 90db8c4 commit f3b76c3

3 files changed

Lines changed: 7 additions & 9 deletions

File tree

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# drachtio-rtpengine-webrtcproxy
22

3-
An open-source webrtc proxy server built using [drachtio](https://drachtio.org) and [rtpengine](https://github.com/sipwise/rtpengine) that allows VoxOUT customers to place outbound calls from webrtc clients.
3+
An open-source webrtc proxy server built using [drachtio](https://drachtio.org) and [rtpengine](https://github.com/sipwise/rtpengine) that allows webrtc clients to place or receive calls from their VoIP provider. The server can optionally be configured to handle authentication against SIP trunks requiring digest authentication (otherwise, digest challenges are passed back to the client).
44

55
## Installation
66

@@ -37,7 +37,7 @@ The example configuration file (in config/default.json.example) looks like this:
3737
},
3838
"credentials": [
3939
{
40-
"trunk": "voxout.voxbone.com",
40+
"trunk": "my.voipprovider.com",
4141
"auth": {
4242
"username": "<yourusername>",
4343
"password": "<yourpassword>"
@@ -49,9 +49,7 @@ The example configuration file (in config/default.json.example) looks like this:
4949
The information is provided as follows:
5050
* `drachtio`: This is the location where the drachtio server is running and listening to connections from applications. In the example, the application would be running on the drachtio server itself, and thus the 'host' value is '127.0.0.1'. You could alternatively have the application running on a different server and connect to the drachtio server across the network, if you wish.
5151
* `rtpengine`: Similarly, this is the information needed for the application to connect to the rtpengine server, using the 'ng' protocol.
52-
* `credentials`: this is an array of SIP trunks that the webrtc proxy holds authorization credentials for, such that when an INVITE is being sent to that trunk and is subsequently challenged with a 401/407, the webrtc proxy will generate a new INVITE using the credentials provided.
53-
54-
In the case of the voxout service, as noted above you will need to substitute your voxout username and password where shown.
52+
* `credentials`: this is an optionaly array of SIP trunks that the webrtc proxy holds authorization credentials for, such that when an INVITE is being sent to that trunk and is subsequently challenged with a 401/407, the webrtc proxy will generate a new INVITE using the credentials provided.
5553

5654
## Basic operation
5755

@@ -63,7 +61,7 @@ When an incoming SIP INVITE is received, the application will allocate endpoints
6361

6462
If the host part of the Request-URI matches one of the configured trunks, the webrtc application will handle digest challenges from the far end.
6563

66-
Calls can be therefore be made to the PSTN (i.e. regular phone numbers) using voxout, or to any reachable SIP URI (e.g. an IP PBX).
64+
Calls can be therefore be made to the PSTN (i.e. regular phone numbers) using a VoIP carrier, or to any reachable SIP URI (e.g. an IP PBX).
6765

6866
## Advanced features
6967

config/default.json.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
},
1212
"credentials": [
1313
{
14-
"trunk": "voxout.voxbone.com",
14+
"trunk": "your.voipprovider.com",
1515
"auth": {
1616
"username": "<yourusername>",
1717
"password": "<yourpassword>"

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)