[libss7-commits] mattf: trunk r97 - /trunk/README

[SVN commits to the libss7 project]

Author: mattf
Date: Fri Sep 21 14:49:37 2007
New Revision: 97

URL: http://svn.digium.com/view/libss7?view=rev&rev=97
Log:
Update the README file

Modified:
    trunk/README

Modified: trunk/README
URL: http://svn.digium.com/view/libss7/trunk/README?view=diff&rev=97&r1=96&r2=97
==============================================================================
--- trunk/README (original)
+++ trunk/README Fri Sep 21 14:49:37 2007
@@ -30,14 +30,92 @@
 
 To Use:
 =======
-Currently, to use it with asterisk you need to check out a special branch as follows:
-svn co http://svn.digium.com/svn/asterisk/team/mattf/asterisk-ss7
+In order to use libss7, you must get at least the following versions of Zaptel and Asterisk:
+Zaptel: 1.4.x
+Asterisk: trunk
+libss7: trunk (currently, there *only* is a trunk release).
 
-In zaptel.conf, your signalling channel should be a "dchan" and your bearers should
+You must then do a `make; make install` in each of the directories that you installed
+in the given order (Zaptel first, libss7 second, and Asterisk last).
+
+NOTE: In order to check out the code, you must have the subversion client installed.  This
+is how to check them out from the public subversion server.
+
+These are the commands you would type to install them:
+
+`svn co http://svn.digium.com/svn/zaptel/branches/1.4 zaptel-1.4`
+`cd zaptel-1.4`
+`make; make install`
+
+`svn co http://svn.digium.com/svn/libss7/trunk libss7-trunk`
+`cd libss7-trunk`
+`make; make install`
+
+`svn co http://svn.digium.com/svn/asterisk/trunk asterisk-trunk`
+`cd asterisk-trunk`
+`./configure; make; make install;`
+
+This should build Zaptel, libss7, and Asterisk with SS7 support.
+
+In the past, there was a special asterisk-ss7 branch to use which contained the SS7 code.
+That code has been merged back into the trunk version of Asterisk, and the old asterisk-ss7
+branch has been deprecated and removed.  If you are still using the asterisk-ss7 branch, it
+will not work against the current version of libss7, and you should switch to asterisk-trunk
+instead.
+
+CONFIGURATION:
+In zaptel.conf, your signalling channel(s) should be a "dchan" and your bearers should
 be set as "bchan".
 
 In the asterisk-ss7 branch, there is a sample zapata.conf that is installed which
 contains sample configuration for setting up an E1 link.
+
+In brief, here is a simple ss7 linkset setup:
+
+signalling = ss7
+ss7type = itu 		; or ansi if you are using an ANSI link
+
+linkset = 1		; Pick a number for your linkset identifier in zapata.conf
+
+pointcode = 28		; The decimal form of your point code.  If you are using an
+			; ANSI linkset, you can use the xxx-xxx-xxx notation for
+			; specifying your linkset pointcode.
+adjpointcode = 2	; The point code of the switch adjacent to your linkset
+
+defaultdpc = 3		; The point code of the switch you want to send your ISUP
+			; traffic to.  A lot of the time, this is the same as your
+			; adjpointcode.
+
+; Now we configure our Bearer channels (CICs)
+
+cicbeginswith = 1	; Number to start counting the CICs from.  So if Zap/1 to
+			; Zap/15 are CICs 1-15, you would set this to 1 before you
+			; declare channel=1-15
+
+channel=1-15		; Use Zap/1-15 and assign them to CICs 1-15
+
+cicbeginswith = 17	; Now for Zap/17 to Zap/31, they are CICs 17-31 so we initialize
+			; cicbeginswith to 17 before we declare those channels
+
+channel = 17-31		; This assigns CICs 17-31 to channels 17-31
+
+signchan = 16		; This is where you declare which Zap channel is your signalling
+			; channel.  In our case it is Zap/16.  You can add redundant
+			; signalling channels by adding additional sigchan= lines.
+			
+; If we want an alternate redundant signalling channel add this
+
+sigchan = 48		; This would put two signalling channels in our linkset, one at
+			; Zap/16 and one at Zap/48 which both would be used to send/receive
+			; ISUP traffic.
+
+; End of zapata.conf
+
+This is how a basic linkset is setup.  For more detailed zapata.conf SS7 config information
+as well as other options available for that file, see the default zapata.conf that comes
+with the samples in asterisk.  If you would like, you can do a `make samples` in your
+asterisk-trunk directory and it will install a sample zapata.conf for you that contains
+more information about SS7 setup.
 
 Completed:
 ==========