<span style="display:block;height:15px!important"></span>
<p align="center"><img src="https://git.doublebastion.com/roundpin/raw/develop/images/login-logo.png" alt="Roundpin" width="380px" height="108px"/></p>

<span style="display:block;height:20px!important"></span>

**A fully featured browser phone that implements audio/video calling, video conferencing and text messaging using SIP over WebSocket and WebRTC. It can connect to SIP providers 
via Asterisk or directly.**

Roundpin is intended to be used in conjunction with Asterisk, to benefit from the control, autonomy and advanced PBX features offered by Asterisk. Nevertheless, Roundpin can be 
also used without Asterisk, by connecting it directly to SIP providers, if they allow direct connections from web applications that use SIP over WebSocket.

If Asterisk is used, you can have free **video, audio and text conversations** with other extensions configured on the same Asterisk server. By connecting your Asterisk server to a
SIP provider like Telnyx or Localphone, you can also make and receive audio phone calls to/from any phone number in the world, using a real phone number attached to your SIP account. 
In the installation instructions mentioned below, we describe in detail how to configure Asterisk and how to connect it to a Telnyx or Localphone account. Any SIP provider that allows 
external Asterisk servers to connect to them, will work.

Roundpin also implements **video conferencing**. Users can initiate video conferences with other extensions configured in Asterisk but also with external users who don’t have Roundpin
accounts. If they have a device with a video camera, to participate in a conference, external users only need a browser and the link to the conference.

Roundpin logs recent phone calls and their duration, it allows pausing, muting and transferring phone calls, as well as in-browser call recording for one-to-one audio/video calls.
The underlying Asterisk server can be used to implement **advanced PBX features**, such as **Interactive Voice Response (IVR or voice menu), voicemail, queue management, music on hold,
number blacklisting, call recording**, etc., as we describe in detail in the documentation mentioned below. All these can be done independently of your SIP provider. You need a SIP 
provider only to attach a regular phone number to your SIP account and be able to interface with the Public Switched Telephone Network (PSTN); all the rest can be done on your own 
server, including the IVR, voicemail, call recording, etc. This allows you to have total control over your communications and more privacy than if you were using your SIP provider’s 
voicemail, call recording, etc.

If you connect Roundpin to a SIP provider like Telnyx via Asterisk, you can make very cheap phone calls at prices starting from $0.005 per minute in the US. Phone numbers in various 
countries are offered at around $1/phone number/month. Double Bastion is not affiliated with Telnyx or Localphone.

<span style="display:block;height:20px!important"></span>

## Main Features
<span style="display:block;height:10px!important"></span>

- SIP audio calls
- SIP video calls
- SIP video conferences
- Call transfer/mute/hold
- In-browser call recording for video conferences and one-to-one audio/video calls
- Screen sharing during video calls and video conferences
- Link-based access to video conferences for external users
- Encrypted text messaging (AES + RSA encryption, in addition to TLS)
- File transfer during text chat
- Public and private text messaging during video conferences
- Roundcube email integration
- Responsive, mobile friendly interface

<span style="display:block;height:20px!important"></span>

Audio conversation
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_audio_conversation.png)
<span style="display:block;height:40px!important"></span>
Video conversation
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_video_conversation.png)
<span style="display:block;height:40px!important"></span>
Text conversation
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_text_conversations.png)
<span style="display:block;height:40px!important"></span>
Send media files
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_sending_media_files.png)
<span style="display:block;height:40px!important"></span>
Text conference
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_text_conference.png)
<span style="display:block;height:40px!important"></span>
Incoming call and onscreen notifications
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_incoming_call_and_notifications.png)
<span style="display:block;height:40px!important"></span>
Call transfer
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_call_transfer.png)
<span style="display:block;height:40px!important"></span>
User menu
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_logged_in_user_menu.png)
<span style="display:block;height:40px!important"></span>
Main dialpad
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_main_dialpad.png)
<span style="display:block;height:40px!important"></span>
Settings
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_settings.png)
<span style="display:block;height:40px!important"></span>
Edit contact
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_edit_contact.png)
<span style="display:block;height:40px!important"></span>
Check emails
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_checking_emails.png)
<span style="display:block;height:40px!important"></span>
Compose email
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_composing_email.png)
<span style="display:block;height:40px!important"></span>
Video conference
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_video_conference.png)
<span style="display:block;height:40px!important"></span>
Send public messages during video conference
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_video_conference_chat.png)
<span style="display:block;height:40px!important"></span>
Call graphs
<span style="display:block;height:10px!important"></span>
![Image of Roundpin Interface](https://git.doublebastion.com/roundpin/raw/develop/images/roundpin_call_graphs.png)
<span style="display:block;height:40px!important"></span>


## Browsers
<span style="display:block;height:10px!important"></span>

All major browsers are supported. Firefox is recommended.

<span style="display:block;height:20px!important"></span>

## Programming Languages
<span style="display:block;height:10px!important"></span>

Roundpin only uses PHP, SQL, JavaScript / jQuery, CSS and HTML. This means it's efficient, light-weight and easy to maintain and debug.

<span style="display:block;height:20px!important"></span>

## Minimum Requirements
<span style="display:block;height:10px!important"></span>

- **VPS or dedicated server** with **1 CPU core and 1 GB RAM**. The size on disk is about 24 MB. It can function on machines with much lower specifications. Yet, for video conferences 
  with a large number of participants, it's recommended to use 1 GB of RAM or more.

- **The LEMP stack**. It should also work with Apache but we recommend Nginx.

If you decide to connect Roundpin to your SIP provider via Asterisk, you will need **Asterisk** v18.0.0 (with **chan_pjsip** enabled) or newer, installed on a VPS or dedicated server. 
If you want to use a STUN server, we recommend Coturn v4.5.1.1 or newer.

Note: Roundpin is a component of <a rel="noreferrer noopener" href="https://www.doublebastion.com" target="_blank">RED SCARF Suite</a>. You can install and use Roundpin alone, but if 
you want to install all the applications that make up RED SCARF Suite, you will need a VPS or dedicated server with 2 GB RAM.

<span style="display:block;height:20px!important"></span>

## Installation
<span style="display:block;height:10px!important"></span>

Complete and detailed instructions on how to install and use Roundpin can be found <a rel="noreferrer noopener" href="https://www.doublebastion.com/install-roundpin/" target="_blank">here</a>.
That documentation also contains the links to the instructions for installing Asterisk and Coturn (Coturn can be used as a STUN server to assist Roundpin in connecting users who are 
behind routers).

Please note that the installation instructions for Asterisk presents in detail how to implement 4 classes of dial plans, but you should choose only the one that is the closest to your 
situation.

Asterisk version 18.0.0 is coded such as by default it allows a maximum of 15 video conference participants. However, this number can be increased to around 100 by changing the code 
before compiling, as we explain in detail in the above mentioned documentation.

If you want to integrate Roundcube with Roundpin, to be able to open a new email window with one click, to easily send emails to your Roundpin contacts, and to be able to check incoming 
emails from inside Roundpin, you will need to install a complete mail server by following the detailed instructions presented 
<a rel="noreferrer noopener" href="https://www.doublebastion.com/install-the-mail-server/" target="_blank">here</a>.

<span style="display:block;height:20px!important"></span>

## Contribute
<span style="display:block;height:10px!important"></span>

This is the official repository of the Roundpin project. The <a rel="noreferrer noopener" href="https://github.com/CoverTowerSuperAdmin/roundpin" target="_blank">GitHub Roundpin
repository</a> is just a pointer to this repository. We don’t use GitHub for developing Roundpin because GitHub is owned by one of the companies that proved their disrespect for
digital freedom over the years and because centralized services create autonomy and privacy issues, in spite of all the benefits.

If you want to contribute code to this project, please submit <a rel="noreferrer noopener" href="https://git.doublebastion.com/roundpin/pullrequests/contrib" target="_blank">this form</a>, 
mentioning your intended changes. We'll send you the credentials needed to push code to the "contrib" branch of this repository. After we review the changes we can include them in the 
project. We'll list the names of all the contributors, in the Contributors.txt file located in the root directory.

Please post any bugs that are not security related, or feature requests, on the <a rel="noreferrer noopener" href="https://git.doublebastion.com/roundpin/issues/develop" target="_blank">
issue tracker</a>. If you notice bugs related to security, don’t post them on the issue tracker; instead, send them to manager [at] doublebastion [dot] com .

<span style="display:block;height:20px!important"></span>

## License
<span style="display:block;height:10px!important"></span>

Roundpin as a whole is licensed under the GNU Affero General Public License, version 3 or any later version (See the file COPYING.txt located in the root directory, for the text of the 
license).

Roundpin includes large parts of "Browser Phone", licensed under GNU AGPL v3.0 and of "Cyber Mega Phone 2k" licensed under the MIT License. It also includes parts from other 
programs/libraries licensed under different free software licenses. We listed these programs/libraries and their respective copyright notices in the LICENSE.txt file located in the 
root directory.
