Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
mackhendricks committed Sep 26, 2023
1 parent 0f94ab7 commit bed7432
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 57 deletions.
Binary file added .DS_Store
Binary file not shown.
110 changes: 53 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,12 @@
# dSIPRouter Platform

> VoIP Service Management Simplified

## Supported Features
[<p align="center"><img src="docs/dsiprouter_300px.png" alt="dSIPRouter Logo" width="300"/></p>](https://dsiprouter.org)

- Carrier Management
- Manage carriers as a group
- Endpoint Management
- Manage endpoints as a group
- Call Limiting per Endpoint Group
- Call Detail Records generation per Endpoint Group
- High Availablity
- Mysql Active-Active replication
- Pacemaker / Corosync Active-Passive floating IP
- Consul DNS Load-balancing and DNS Failover
- dSIPRouter cluster synchronization
- Kamailio DMQ replication
- Notification System
- Over Call Limit Notifications
- Endpoint Failure Notifications
- Call Detail Record Notifications
- Enhanced DID Management
- DID Failover to a Carrier/Endpoint Group or DID
- DID Hard Forwarding to a Carrier/Endpoint Group or DID
- Flowroute DID synchronization
- Enhanced Route Management
- FusionPBX Domain Routing Enhancements
- Outbound / Inbound DID prefix routing
- Least Cost Locality Outbound routing
- Load balancing / sequential routing via groups
- Integration with your own custom Kamailio routes
- E911 Priority routing
- Local Extension routing
- Voicemail routing
- Security
- TLS Enabled by Default
- Rate-limiting / DOS protection
- Teleblock blacklist support
- Microsoft Teams Support (Subscription Required)
- WebSockets Enabled by Default
- Kamailio 5.3 Support
- RTPEngine Version 6.1 Support

## What is dSIPRouter?

dSIPRouter allows you to quickly turn [Kamailio](https://www.kamailio.org/) into an easy to use SIP Service Provider platform, which enables two basic use cases:
dSIPRouter allows you to quickly turn [Kamailio](https://www.kamailio.org/) into an easy to use SIP Service Provider platform, which enables three basic use cases:

- **SIP Trunking services:**
Provide services to customers that have an on-premise PBX such as FreePBX, FusionPBX, Avaya, etc.
Expand All @@ -57,9 +19,7 @@ We have an integration with FusionPBX that make this really easy and scalable!
- **Microsoft Teams Direct Routing:**
We can provide SBC functionality that allows dSIPRouter to interconnect your existing voice infrastructure or VoIP carrier to your Microsoft Teams environment.

- **Web Management Services**
Provide customers the ability to manage signaling, routes, security, CRM, CDR's, logging, and more from the dSIPRouter GUI.
We also make these services available to developers through the dSIPRouter API.
The dSIPRouter UI allows you to manage the platform. We also make it easy to intergrate dSIPRouter into your existing workflow by using our [API](https://www.postman.com/dopensource/workspace/dsiprouter/overview)

**Follow us at [#dsiprouter](https://twitter.com/dsiprouter) on Twitter to get the latest updates on dSIPRouter**

Expand All @@ -69,26 +29,17 @@ Check out our official website [dsiprouter.org](http://dsiprouter.org)

### Demo System

Try out our demo system [demo.dsiprouter.org](https://demo.dsiprouter.org:5000/)
Try out our demo system [demo.dsiprouter.net](https://demo.dsiprouter.net:5000/)

Demo system GUI Credentials:
- username: `admin`
- password: `ZmIwMTdmY2I5NjE4`

Demo system API Credentials:
- bearer token: `9lyrny3HOtwgjR6JIMwRaMej9LijIS835zhVbD8ywHDzXT07Xm6vem1sgfvWkFz3`

### HA Installation Notes
You can test out the API using the demo system. We have defined a [Postman](https://www.postman.com/dopensource/workspace/dsiprouter/overview) collection that will make the process easier. The API token is below:

The highly available mysql and pacemaker modules are installed seperately at this time:

- Both modules are deployed from an edge server that must connect through ssh to all nodes
- Currently 2 node clusters have been thoroughly tested but there is no limit to cluster size.

Supported SSH authentication methods for cluster configuration:

1. public key
2. password
- bearer token: `9lyrny3HOtwgjR6JIMwRaMej9LijIS835zhVbD8ywHDzXT07Xm6vem1sgfvWkFz3`

### Documentation

Expand All @@ -100,10 +51,17 @@ For a list of updates and changes refer to our [Changelog](CHANGELOG.md)
See the [Contributing Guidelines](CONTRIBUTING.md) for more details
A current list of contributors can be found [here](CONTRIBUTORS.md)

### Getting Started

You can find the steps to install of support operating systems:

- [Debian Based Systems](https://dsiprouter.readthedocs.io/en/latest/debian_install.html#debian-install)
- [Redhat Based Systems](https://dsiprouter.readthedocs.io/en/latest/rhel_install.html#rhel-install)

### Support

Free Support: [dSIPRouter Question & Answer Forum](https://groups.google.com/forum/#!forum/dsiprouter)
Paid Support: [dSIPRouter Support](https://dsiprouter.org/#fh5co-support-section)
- Free Support: [dSIPRouter Question & Answer Forum](https://groups.google.com/forum/#!forum/dsiprouter)
- Paid Support: [dSIPRouter Support](https://dsiprouter.org/#fh5co-support-section)

### Training

Expand All @@ -112,3 +70,41 @@ Details on training can be found [here](https://dopensource.com/product/dsiprout
### License

- Apache License 2.0, [read more here](LICENSE)

### Supported Features

- Carrier Management
- Manage carriers as a group
- Endpoint Management
- Manage endpoints as a group
- Call Limiting per Endpoint Group
- Call Detail Records generation per Endpoint Group
- Notification System
- Over Call Limit Notifications
- Endpoint Failure Notifications
- Call Detail Record Notifications
- Enhanced DID Management
- DID Failover to a Carrier/Endpoint Group or DID
- DID Hard Forwarding to a Carrier/Endpoint Group or DID
- Flowroute DID synchronization
- Enhanced Route Management
- FusionPBX Domain Routing Enhancements
- Outbound / Inbound DID prefix routing
- Least Cost Locality Outbound routing
- Load balancing / sequential routing via groups
- Integration with your own custom Kamailio routes
- E911 Priority routing
- Local Extension routing
- Voicemail routing
- Security
- TLS Enabled by Default
- Rate-limiting / DOS protection
- Teleblock blacklist support
- High Availablity (Subscription Required)
- Mysql Active-Active replication
- Pacemaker / Corosync Active-Passive floating IP
- Consul DNS Load-balancing and DNS Failover
- dSIPRouter cluster synchronization
- Kamailio DMQ replication
- Microsoft Teams Support (Subscription Required)
- WebSockets Enabled by Default
Binary file added docs/.DS_Store
Binary file not shown.

0 comments on commit bed7432

Please sign in to comment.