| 1 | |
|---|
| 2 | SIP chatserver installation |
|---|
| 3 | --------------------------- |
|---|
| 4 | |
|---|
| 5 | The software runs on Debian or Ubuntu Linux, MacOSX or any Unix variant |
|---|
| 6 | supported by its main dependency sipclient version >= 0.4.0 available from |
|---|
| 7 | http://sipsimpleclient.com |
|---|
| 8 | |
|---|
| 9 | You can install SIP chatserver in the following ways: |
|---|
| 10 | |
|---|
| 11 | a. From a Debian package |
|---|
| 12 | b. From a tar archive |
|---|
| 13 | c. From the version control repository |
|---|
| 14 | |
|---|
| 15 | |
|---|
| 16 | Debian package installation |
|---|
| 17 | --------------------------- |
|---|
| 18 | |
|---|
| 19 | For people running Debian or Ubuntu there is an official public repository |
|---|
| 20 | provided by AG Projects. To use it, add these lines in /etc/apt/sources.list |
|---|
| 21 | |
|---|
| 22 | # AG Projects software |
|---|
| 23 | deb http://ag-projects.com/debian unstable main |
|---|
| 24 | deb-src http://ag-projects.com/debian unstable main |
|---|
| 25 | |
|---|
| 26 | Install the AG Projects debian software signing key: |
|---|
| 27 | |
|---|
| 28 | wget http://download.ag-projects.com/agp-debian-gpg.key |
|---|
| 29 | apt-key add agp-debian-gpg.key |
|---|
| 30 | |
|---|
| 31 | After that, run: |
|---|
| 32 | |
|---|
| 33 | apt-get update |
|---|
| 34 | apt-get install sip-chatserver |
|---|
| 35 | |
|---|
| 36 | |
|---|
| 37 | Installing from the tar archive |
|---|
| 38 | ------------------------------- |
|---|
| 39 | |
|---|
| 40 | You must also install manually all software dependencies. |
|---|
| 41 | |
|---|
| 42 | The software can be downloaded as a tar archive from: |
|---|
| 43 | |
|---|
| 44 | http://download.ag-projects.com/SipChatServer/ |
|---|
| 45 | |
|---|
| 46 | Extract it using tar xzvf sip-chatserver-version.tar.gz |
|---|
| 47 | |
|---|
| 48 | To install the server run: |
|---|
| 49 | python setup.py install |
|---|
| 50 | |
|---|
| 51 | |
|---|
| 52 | Installing from the version control repository |
|---|
| 53 | ---------------------------------------------- |
|---|
| 54 | |
|---|
| 55 | The source code is managed using darcs version control tool. The darcs |
|---|
| 56 | repository can be fetched with: |
|---|
| 57 | |
|---|
| 58 | darcs get http://devel.ag-projects.com/repositories/sip-chatserver |
|---|
| 59 | |
|---|
| 60 | To obtain the incremental changes after the initial get: |
|---|
| 61 | |
|---|
| 62 | cd sip-chatserver |
|---|
| 63 | darcs pull -a |
|---|
| 64 | |
|---|
| 65 | To install the server run: |
|---|
| 66 | python setup.py install |
|---|
| 67 | |
|---|
| 68 | |
|---|
| 69 | Running server |
|---|
| 70 | -------------- |
|---|
| 71 | |
|---|
| 72 | The server configuration must reside in /etc/sip-chatserver. Copy |
|---|
| 73 | /etc/sip-chatserver/config.ini.sample to etc/sip-chatserver/config.ini and |
|---|
| 74 | edit it with the proper values. |
|---|
| 75 | |
|---|
| 76 | Start the server using the init.d script: |
|---|
| 77 | |
|---|
| 78 | /etc/init.d/sip-chatserver start |
|---|
| 79 | |
|---|
| 80 | All server activity messages are logged to syslog. |
|---|
| 81 | |
|---|
| 82 | |
|---|
| 83 | Using the server |
|---|
| 84 | ---------------- |
|---|
| 85 | |
|---|
| 86 | To use the server you need a SIP client with support for MSRP chat sessions. |
|---|
| 87 | You can use http://sipsimpleclient.com library that contains a test script |
|---|
| 88 | for establishing MSRP sessions (sip_im_session). |
|---|
| 89 | |
|---|
| 90 | To join a chat room send INVITE with MSRP media type to any SIP URI that |
|---|
| 91 | maps to the server address. The username part of the SIP URI will me used by |
|---|
| 92 | the server to generate a room. The room will exists as long as there is at |
|---|
| 93 | least one participant connected. |
|---|
| 94 | |
|---|
| 95 | Check the syslog messages to see the server activity related to users |
|---|
| 96 | joining or leaving the rooms. |
|---|
