| 1 | |
|---|
| 2 | SIP chatserver |
|---|
| 3 | -------------- |
|---|
| 4 | |
|---|
| 5 | Copyright (c) 2009 AG Projects |
|---|
| 6 | http://ag-projects.com |
|---|
| 7 | |
|---|
| 8 | Author: Denis Bilenko |
|---|
| 9 | Home page: http://chatserver.ag-projects.com |
|---|
| 10 | |
|---|
| 11 | |
|---|
| 12 | Description |
|---|
| 13 | ----------- |
|---|
| 14 | |
|---|
| 15 | SIP chatserver is an open source conference bridge that supports MSRP chat |
|---|
| 16 | sessions. It can be used for ad-hoc conferencing by SIP end-points. |
|---|
| 17 | |
|---|
| 18 | |
|---|
| 19 | Background |
|---|
| 20 | ---------- |
|---|
| 21 | |
|---|
| 22 | The Message Session Relay Protocol (MSRP) [RFC4975] defines a mechanism for |
|---|
| 23 | sending a series of instant messages within a session. The Session |
|---|
| 24 | Initiation Protocol (SIP) [RFC3261] in combination with the Session |
|---|
| 25 | Description Protocol (SDP) [RFC3264] allows for two peers to establish and |
|---|
| 26 | manage such sessions. |
|---|
| 27 | |
|---|
| 28 | In another application of SIP, a user agent can join in a multi-party |
|---|
| 29 | conversation called a conference that is hosted by a specialized user agent |
|---|
| 30 | called a focus [RFC4353]. Such a conference can naturally involve an MSRP |
|---|
| 31 | session as one of possibly many media components. It is the responsibility |
|---|
| 32 | of an entity handling the media to relay instant messages received from one |
|---|
| 33 | participant to the rest of the participants in the conference. |
|---|
| 34 | |
|---|
| 35 | Participants in a chat room can be identified with a pseudonym or nickname, |
|---|
| 36 | and decide whether their real identity is disclosed to other participants. |
|---|
| 37 | Participants can also use a rich set of features such as the ability to send |
|---|
| 38 | private instant messages to other participants. They also allow combining |
|---|
| 39 | instant messaging with other media components, such as voice, video, white |
|---|
| 40 | boarding, screen sharing, and file transfer. |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | Features |
|---|
| 44 | -------- |
|---|
| 45 | |
|---|
| 46 | The server implements relevant features from the following standards: |
|---|
| 47 | |
|---|
| 48 | * MSRP protocol RFC4975 |
|---|
| 49 | * MSRP ad-hoc multi-party chat sessions draft-ietf-simple-chat-03 |
|---|
| 50 | * Common Presence and Instant Messaging (CPIM): Message Format RFC3862 |
|---|
| 51 | * Framework for Conferencing with the Session Initiation Protocol (SIP) RFC4353 |
|---|
| 52 | * Framework for Centralized Conferencing draft-ietf-xcon-framework-11 |
|---|
| 53 | * Conference event package RFC4575 |
|---|
| 54 | |
|---|
| 55 | For the complete list of implemented and planned features see docs/TODO.txt |
|---|
| 56 | and docs/STATUS.txt. |
|---|
| 57 | |
|---|
| 58 | |
|---|
| 59 | Debian package installation |
|---|
| 60 | --------------------------- |
|---|
| 61 | |
|---|
| 62 | Add the following lines to /etc/apt/sources.list |
|---|
| 63 | |
|---|
| 64 | # AG Projects software |
|---|
| 65 | deb http://ag-projects.com/debian unstable main |
|---|
| 66 | deb-src http://ag-projects.com/debian unstable main |
|---|
| 67 | |
|---|
| 68 | Install the AG Projects debian software signing key: |
|---|
| 69 | |
|---|
| 70 | wget http://download.ag-projects.com/agp-debian-gpg.key |
|---|
| 71 | apt-key add agp-debian-gpg.key |
|---|
| 72 | |
|---|
| 73 | After that, run: |
|---|
| 74 | |
|---|
| 75 | sudo apt-get update |
|---|
| 76 | sudo apt-get install sip-chatserver |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | Manual installation |
|---|
| 80 | ------------------- |
|---|
| 81 | |
|---|
| 82 | Download the tar archive from http://download.ag-projects.com/ChatServer |
|---|
| 83 | |
|---|
| 84 | Extract the tar archive and run under the newly created directory: |
|---|
| 85 | |
|---|
| 86 | sudo python setup.py install |
|---|
| 87 | |
|---|
| 88 | |
|---|
| 89 | Development version |
|---|
| 90 | ------------------- |
|---|
| 91 | |
|---|
| 92 | The source code is managed using darcs version control tool. The darcs |
|---|
| 93 | repository can be fetched with: |
|---|
| 94 | |
|---|
| 95 | darcs get http://devel.ag-projects.com/repositories/sip-chatserver |
|---|
| 96 | |
|---|
| 97 | To obtain the incremental changes after the initial get, go to the |
|---|
| 98 | sip-chatserver directory and run: |
|---|
| 99 | |
|---|
| 100 | cd sip-chatserver |
|---|
| 101 | darcs pull -a |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | Support |
|---|
| 105 | ------- |
|---|
| 106 | |
|---|
| 107 | The project is developed and supported by AG Projects. The support is |
|---|
| 108 | provided on a best-effort basis. "best-effort" means that we try to solve |
|---|
| 109 | the bugs you report or help fix your problems as soon as we can, subject to |
|---|
| 110 | available resources. |
|---|
| 111 | |
|---|
| 112 | To request support you must use the mailing list available at |
|---|
| 113 | |
|---|
| 114 | http://lists.ag-projects.com/mailman/listinfo/sipchatserver |
|---|
| 115 | |
|---|
| 116 | Patches and bug reports must be submitted by opening a ticket at |
|---|
| 117 | |
|---|
| 118 | http://chatserver.ag-projects.com/newticket |
|---|
| 119 | |
|---|
| 120 | To open ticket please Register first. |
|---|
| 121 | |
|---|
