Changeset 66

Show
Ignore:
Timestamp:
02/18/09 10:27:01 (18 months ago)
Author:
Adrian Georgescu <ag@ag-projects.com>
Hashname:
20090218092701-58252-e7d48dc4199df526a8feb3f81678aefe490cff16
Message:

Moved documentation under docs/

Files:
1 added
1 modified
2 moved

Legend:

Unmodified
Added
Removed

  • README

    r34 r66  
    1313----------- 
    1414 
    15 SIP chatserver is an open source conference bridge that supports MSRP chat 
    16 sessions and RTP audio streams. It can be used for ad-hoc conferencing by 
    17 SIP end-points. For SIP end-points without MSRP capability, SIP MESSAGE 
    18 method can be used for exchanging instant messaging (IM) with the server. 
     15SIP chatserver is a conference bridge with supports for instant messaging 
     16based on MSRP protocol and RTP audio sessions. It can be used for ad-hoc 
     17IM and voice conferencing by SIP end-points. 
    1918 
    2019 
    … …  
    5554 * Conference event package RFC4575 
    5655 
     56For the complete list of implemented and planned features see docs/TODO.txt 
     57and docs/STATUS.txt. 
     58 
    5759 
    5860Support 

  • docs/INSTALL.txt

    r28 r66  
    44 
    55The software runs on Debian or Ubuntu Linux, MacOSX or any Unix variant 
    6 supported by its main dependency, which is sipclient version >= 0.4.0 
    7 available from http://sipsimpleclient.com 
     6supported by its main dependency sipclient version >= 0.4.0 available from 
     7http://sipsimpleclient.com 
    88 
    99You can install SIP chatserver in the following ways: 
    1010 
    11 a. From Debian package 
     11a. From a Debian package 
    1212b. From a tar archive 
    13 c. From version control repository 
     13c. From the version control repository 
    1414 
    1515 
    … …  
    8080All server activity messages are logged to syslog. 
    8181 
     82 
     83Using the server 
     84---------------- 
     85 
     86To use the server you need a SIP client with support for MSRP chat sessions. 
     87You can use http://sipsimpleclient.com library that contains a test script 
     88for establishing MSRP sessions (sip_im_session). 
     89 
     90To join a chat room send INVITE with MSRP media type to any SIP URI that 
     91maps to the server address. The username part of the SIP URI will me used by 
     92the server to generate a room. The room will exists as long as there is at 
     93least one participant connected. 
     94 
     95Check the syslog messages to see the server activity related to users 
     96joining or leaving the rooms. 

  • docs/TODO.txt

    r65 r66  
     1 
     2Media 
     3----- 
     4 
     5 * Audio bridge support 
    16 
    27Chatroom 
    … …  
    4651   - Allow anonymous URI reservation (default no) 
    4752 
    48    Jabber/MUC extension specs: http://xmpp.org/extensions/xep-0045.html 
     53   Jabber/MUC extension specifications: 
     54   http://xmpp.org/extensions/xep-0045.html 
    4955 
    5056 
    … …  
    5864 * Schedule session at a later time 
    5965 
    60  
    61 Media 
    62 ----- 
    63  
    64  * Audio bridge support 
    65