- faq split

doc/serfaq/db_faq.sgml

@@ -0,0 +1,118 @@
+<!-- $Id$ -->
+
+<chapter>
+    <title>Database Related Questions</title>
+    <qandaset>
+	<qandaentry>
+	    <question>
+		<simpara>
+		    Mar 10 16:46:33 ttalksvr /usr/sbin/ser[6592]: connect_db(): Can't connect to
+		    local MySQL server through socket '/var/lib/mysql/mysql.sock' (2)
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    Make sure your MySQL server is running.
+		</simpara>
+	    </answer>
+	</qandaentry>
+
+	<qandaentry>
+	    <question>
+		<simpara>
+		    I get the following error:
+		</simpara>
+		<screen format="linespecific">
+0(5164) db_init(): Error while trying to connect database
+0(5164) mod_init(): Error while connecting database
+0(5164) init_modules(): Error while initializing module usrloc
+</screen>
+		<simpara>
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    Modules using database have variable called db_url which contains username,
+		    password, hostname, and name of the database. Make sure the settings are
+		    correct. See module documentation for more information.
+		</simpara>
+	    </answer>
+	</qandaentry>
+
+	<qandaentry>
+	    <question>
+		<simpara>
+		    Does MySQL/Postgres/Whatever have to reside on localhost?
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    No.
+		    </simpara>
+	    </answer>
+	</qandaentry>
+
+	<qandaentry>
+	    <question>
+		<simpara>
+		    Why do I need a database ?
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    Many modules need the database. Authentication modules retrieve users'
+		    crecentials from the database, user location module can be configured to store
+		    registered bindings into the database, accounting module can use database to
+		    store CDR and so on.
+		</simpara>
+	    </answer>
+	</qandaentry>
+	<qandaentry>
+	    <question>
+		<simpara>
+		    Which database engines are supported ?
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    Currently we support MySQL, Postgres and plaintext files.
+		</simpara>
+	    </answer>
+	</qandaentry>
+	
+	<qandaentry>
+	    <question>
+		<simpara>
+		    Which database engine should I use ?
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    That depends on your requirements. Performance aspects are probably not very
+		    important. The most stable and proven is MySQL module. Also serctl utility works
+		    well with this database.
+		</simpara>
+		<simpara>
+		    Another option is postgres support which was donated by Greg Faustak. The module
+		    still new and not that mature (read proven) yet. People using the module
+		    reported that it worked well.
+		</simpara>
+		<simpara>
+		    Last option is dbtext module which uses plaintext files to store the data. This
+		    module is somewhat experimental and shouldn't be used for any serious
+		    deployment. The module is quite slow, but it can fit well into small
+		    instalations containing only a couple of users or demos where you need to change
+		    the content of the database often by hand.
+		</simpara>
+	    </answer>
+	</qandaentry>
+
+    </qandaset>
+</chapter>
+
+
+<!-- Keep this element at the end of the file
+Local Variables:
+sgml-parent-document: ("serfaq.sgml" "Book" "chapter")
+End:
+-->

doc/serfaq/licensing_faq.sgml

@@ -0,0 +1,33 @@
+<!-- $Id$ -->
+
+<chapter>
+    <title>Licensing</title>
+    <qandaset>
+	<qandaentry>
+	    <question>
+		<simpara>
+		    Is the &sername; (&ser;) free ? Or do we need to pay ? Becaure my boss worry
+		    about that, please help me.
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    Yes, it is free. See
+		    <ulink url="http://cvs.berlios.de/cgi-bin/viewcvs.cgi/*checkout*/ser/sip_router/COPYING?rev=HEAD&amp;content-type=text/plain">
+			http://cvs.berlios.de/cgi-bin/viewcvs.cgi/*checkout*/ser/sip_router/COPYING?rev=HEAD&amp;content-type=text/plain
+		    </ulink>
+		</simpara>
+	    </answer>
+	</qandaentry>
+
+	
+
+    </qandaset>
+</chapter>
+
+
+<!-- Keep this element at the end of the file
+Local Variables:
+sgml-parent-document: ("serfaq.sgml" "Book" "chapter")
+End:
+-->

doc/serfaq/serfaq.sgml

@@ -3,6 +3,10 @@
 
 <!-- Include general SER documentation entities -->
 <!ENTITY % serentities SYSTEM "../ser_entities.sgml">
+
+<!ENTITY % licensing SYSTEM "licensing.sgml">
+<!ENTITY % serweb SYSTEM "serweb.sgml">
+
 %serentities;
 
 ]>
@@ -23,15 +27,96 @@
 	</copyright>
 	<abstract>
 	    <para>
-		A compilation of questions and answers from serhelp, serusers, and serdev mailing lists.
+		A compilation of questions and answers from <email>[email protected]</email>,
+		<email>[email protected]</email>, and <email>[email protected]</email> mailing
+		lists.
 	    </para>
 	</abstract>
     </bookinfo>
     <toc></toc>
     
     <chapter>
-	<title>Frequently Asked Questions</title>
+	<title>General</title>
 	<qandaset>
+	    <qandaentry>
+		<question>
+		    <simpara>
+			Is it possible to use &ser; as a &sip; user agent (both of User Agent Client
+			(&uac;) and User Agent Server (&uas;)?
+		    </simpara>
+		</question>
+		<answer>
+		    <simpara>
+			Not easily. &ser; has built-in some functions that allow to use it as user
+			agent, but our primary goal is to develop a server so this is without
+			guarantee and can even dissapear in future versions.
+		    </simpara>
+		</answer>
+	    </qandaentry>
+	    <qandaentry>
+		<question>
+		    <simpara>
+			Can &ser; work well together with some of the location server (e. g.LDAP or DNS) ?
+		    </simpara>
+		</question>
+		<answer>
+		    <simpara>
+			&ser;'s built-in location server uses in-<acronym>RAM</acronym> database for
+			high performance and optionally MySQL for persistency. More database
+			protocols may be supplied on contractual basis. As far as I know,
+			<acronym>DNS</acronym> is not used in the industry for user location.
+		    </simpara>
+		</answer>
+	    </qandaentry>
+	    <qandaentry>
+		<question>
+		    <simpara>
+			What is a proxy server ?
+		    </simpara>
+		</question>
+		<answer>
+		    <simpara>
+			A proxy server is an entity that routes &sip; messages. See &sip
+			introduction which is part of the distribution.
+		    </simpara>
+		</answer>
+	    </qandaentry>
+	    <qandaentry>
+		<question>
+		    What is the difference between proxy server and back to back user agent (B2BUA) ?
+		</question>
+		<answer>
+		    <simpara>
+			The main difference is that proxy servers are transaction-stateful, while
+			B2BUAs are call stateful. That means proxy servers keep state only during
+			&sip; transactions (that is at the beginning and and of a call) and do not
+			keep any state during the whole call.
+		    </simpara>
+		    <simpara>
+			A B2BUA acts merely as connection of two or more user agents which are
+			connected through some means. B2BUAs keep some state (usualy some structures
+			in the memory) during the whole call.
+		    </simpara>
+		    <para>
+			This property gives B2BUA some interesting features that proxies don't
+			have. For example B2BUA can tear down and existing call--proxies can't do
+			that. On the other hand B2BUAs can easily become a bottleneck in terms of
+			scalability.
+		    </para>
+		</answer>
+	    </qandaentry>
+	    <qandaentry>
+		<question>
+		    <simpara>
+			So is &ser; proxy or B2BUA ? Can it terminate an existing call ?
+		    </simpara>
+		</question>
+		<answer>
+		    <simpara>
+			&ser; is a proxy. I can't terminate existing call.
+		    </simpara>
+		</answer>
+	    </qandaentry>
 	    <qandaentry>
 		<question>
 		    <simpara>
@@ -144,19 +229,6 @@
 		    </simpara>
 		</question>
 	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			Is there <quote>send IM</quote> page for sending instant messages only or
-			dies it accept replies as well (i.e. does it act like a full &ua;) ?
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			It can send messages only.
-		    </simpara>
-		</answer>
-	    </qandaentry>
 	    <qandaentry>
 		<question>
 		    <simpara>
@@ -178,22 +250,6 @@
 		    </simpara>
 		</answer>
 	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			Is the &sername; (&ser;) free ? Or do we need to pay ? Becaure my boss worry
-			about that, please help me.
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			Yes, it is free. See
-			<ulink url="http://cvs.berlios.de/cgi-bin/viewcvs.cgi/*checkout*/ser/sip_router/COPYING?rev=HEAD&amp;content-type=text/plain">
-			    http://cvs.berlios.de/cgi-bin/viewcvs.cgi/*checkout*/ser/sip_router/COPYING?rev=HEAD&amp;content-type=text/plain
-			</ulink>
-		    </simpara>
-		</answer>
-	    </qandaentry>
 	    <qandaentry>
 		<question>
 		    <simpara>
@@ -240,21 +296,6 @@
 		    </simpara>
 		</answer>
 	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			I have serweb running. I'm able to connect to <acronym>MySQL</acronym>
-			fine. But it doesn't seem like the form params are getting assigned to
-			variables. Is there something obvious I'm missing?
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			Please check if <varname>register_globals</varname> is set to On in your
-			<filename>php.ini</filename> file.
-		    </simpara>
-		</answer>
-	    </qandaentry>
 	    <qandaentry>
 		<question>
 		    <simpara>
@@ -407,7 +448,7 @@
 		</question>
 		<answer>
 		    <simpara>
-			we no longer disclose our operational policy to the public audience. The
+			We no longer disclose our operational policy to the public audience. The
 			configuration file is only available to our customers under <acronym>NDA</acronym>.
 		    </simpara>
 		</answer>
@@ -646,22 +687,6 @@ ser -E     2>/tmp/ser.log
 		    </simpara>
 		</answer>
 	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			Can somebody tell me how to configure the serweb? Which directory should I
-			put those files and which file and parameters should I modify. Or maybe this
-			question was asked previously by somebody already, then please provide me a
-			like to those answers.
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			Dan Austin's howto (see &ser; webpage) is probably the currently most
-			extensive documentation available.
-		    </simpara>
-		</answer>
-	    </qandaentry>
 	    <qandaentry>
 		<question>
 		    <simpara>
@@ -701,19 +726,6 @@ ser -E     2>/tmp/ser.log
 		    </simpara>
 		</answer>
 	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			Mar 10 16:46:33 ttalksvr /usr/sbin/ser[6592]: connect_db(): Can't connect to
-			local MySQL server through socket '/var/lib/mysql/mysql.sock' (2)
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			Make sure your MySQL server is running.
-		    </simpara>
-		</answer>
-	    </qandaentry>
 	    <qandaentry>
 		<question>
 		    <simpara>
@@ -848,27 +860,6 @@ ser -E     2>/tmp/ser.log
 		    </simpara>
 		</answer>
 	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			I get the following error:
-		    </simpara>
-		    <screen format="linespecific">
- 0(5164) db_init(): Error while trying to connect database
- 0(5164) mod_init(): Error while connecting database
- 0(5164) init_modules(): Error while initializing module usrloc
-</screen>
-		    <simpara>
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			usrloc module has variable called db_url which contains username, password,
-			hostname, and name of the database. Make sure the settings are correct. See
-			usrloc module documentation for more information.
-		    </simpara>
-		</answer>
-	    </qandaentry>
 	    <qandaentry>
 		<question>
 		    <simpara>
@@ -982,38 +973,6 @@ $ORIGIN 9.3.8.1.5.6.2.8.5.3.e164.arpa.
 		    </simpara>
 		</answer>
 	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			Trying to load the serweb page I get the following error message: Fatal
-			error: Call to undefined function: mysql_pconnect() in
-			/var/www/html/phplib/db_mysql.inc on line 73
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			Configure <acronym>PHP</acronym> to load the MySQL extension.
-		    </simpara>
-		</answer>
-	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			I can open the page and even make changes and save
-			them, but I'm receiving the following warning message:
-			Warning: fopen(?/tmp/ser_fifo?, ?w?) ? Permission
-			denied in /var/www/html/serweb/functions.php on line
-			172
-			Sorry - cannot open fifo
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			Make sure that the user under which the web server is running has read
-			and write access to the <acronym>FIFO</acronym>.
-		    </simpara>
-		</answer>
-	    </qandaentry>
 	    <qandaentry>
 		<question>
 		    <simpara>
@@ -1064,34 +1023,6 @@ $ORIGIN 9.3.8.1.5.6.2.8.5.3.e164.arpa.
 		    </simpara>
 		</answer>
 	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			Is there a way to add/edit/view aliases from serweb?
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			When new user confirm registration, new numeric alias is created. There is
-			no another way to add or edit aliases from serweb.
-		    </simpara>
-		</answer>
-	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			I am getting a <quote>Forbidden</quote> reply from the Apache. The Apache is
-			ponting to the +index.php for the serweb. I've only changed the &ip; address
-			of the local host to 127.0.0.1 in the +config.php. Does anyone have any
-			suggestions ?
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			Check if the file/folder has read permission for everybody.
-		    </simpara>
-		</answer>
-	    </qandaentry>
 
 	    <qandaentry>
 		<question>
@@ -1105,18 +1036,6 @@ $ORIGIN 9.3.8.1.5.6.2.8.5.3.e164.arpa.
 		    </simpara>
 		</answer>
 	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			Does MySQL have to reside on localhost?
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			No.
-		    </simpara>
-		</answer>
-	    </qandaentry>
 	    <qandaentry>
 		<question>
 		    <simpara>
@@ -1248,33 +1167,6 @@ out_uri=sip:addaline.com via_cnt==1".
 		    </simpara>
 		</answer>
 	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			I get following warnings and error on NetBSD when I call
-			user_interface/index.php:
-		    </simpara>
-		    <simpara>
-			[Wed Jul 16 09:56:53 2003] [error] PHP Warning: Call-time pass-by-reference
-			has been deprecated - argument passed by value; If you would like to pass it
-			by reference, modify the declaration of [runtime function name]().  If you
-			would like to enable call-time pass-by-reference, you can set
-			allow_call_time_pass_reference to true in your INI file.  However, future
-			versions may not support this any longer.  in
-			/usr/pkg/share/httpd/htdocs/iptel/phplib/user.inc on line 72 [Wed Jul 16
-			09:56:53 2003] [error] PHP Fatal error: Call to undefined function:
-			mysql_pconnect() in /usr/pkg/share/httpd/htdocs/iptel/phplib/db_mysql.inc on
-			line 73
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			Simply do what the text says: enable allow_call_time_pass_reference in
-			<filename>/usr/pkg/etc/php.ini</filename> and install <acronym>PHP</acronym>
-			MySQL support.
-		    </simpara>
-		</answer>
-	    </qandaentry>
 	    <qandaentry>
 		<question>
 		    <simpara>
@@ -1336,18 +1228,6 @@ out_uri=sip:addaline.com via_cnt==1".
 		    </simpara>
 		</answer>
 	    </qandaentry>
-	    <qandaentry>
-		<question>
-		    <simpara>
-			Is ser compatible with MySQL 4.x ?
-		    </simpara>
-		</question>
-		<answer>
-		    <simpara>
-			Yes.
-		    </simpara>
-		</answer>
-	    </qandaentry>
 	    <qandaentry>
 		<question>
 		    <simpara>
@@ -1405,6 +1285,20 @@ out_uri=sip:addaline.com via_cnt==1".
 		    </simpara>
 		</answer>
 	    </qandaentry>
+
+	    <qandaentry>
+		<question>
+		    <simpara>
+			Is ser compatible with MySQL 4.x ?
+		</simpara>
+		</question>
+		<answer>
+		    <simpara>
+			Yes.
+		    </simpara>
+		</answer>
+	    </qandaentry>
+
 	</qandaset>
     </chapter>
 </book>

doc/serfaq/serweb_faq.sgml

@@ -0,0 +1,184 @@
+<!-- $Id$ -->
+
+<chapter>
+    <title>SERWEB</title>
+    <qandaset>
+	<qandaentry>
+	    <question>
+		<simpara>
+		    Is there <quote>send IM</quote> page for sending instant messages only or does
+		    it accept replies as well (i.e. does it act like a full &ua;) ?
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    It can send messages only.
+		</simpara>
+	    </answer>
+	</qandaentry>
+	
+	<qandaentry>
+	    <question>
+		<simpara>
+		    I have serweb running. I'm able to connect to <acronym>MySQL</acronym> fine. But
+		    it doesn't seem like the form params are getting assigned to variables. Is there
+		    something obvious I'm missing?
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    Please check if <varname>register_globals</varname> is set to On in your
+		    <filename>php.ini</filename> file. The option is set off by default due to
+		    security reasons.
+		</simpara>
+	    </answer>
+	</qandaentry>
+	
+	<qandaentry>
+	    <question>
+		<simpara>
+		    Can somebody tell me how to configure the serweb? Which directory should I put
+		    those files and which file and parameters should I modify. Or maybe this
+		    question was asked previously by somebody already, then please provide me a like
+		    to those answers.
+		</simpara>
+	</question>
+	    <answer>
+		<simpara>
+		    Dan Austin's howto (see &ser; webpage) is probably the currently most extensive
+		    documentation available.
+		</simpara>
+	    </answer>
+	</qandaentry>
+	
+	<qandaentry>
+	    <question>
+		<simpara>
+		    Trying to load the serweb page I get the following error message: Fatal error:
+		    Call to undefined function: mysql_pconnect() in
+		    /var/www/html/phplib/db_mysql.inc on line 73
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    Configure <acronym>PHP</acronym> to load the MySQL extension.
+		</simpara>
+	    </answer>
+	</qandaentry>
+	
+	<qandaentry>
+	    <question>
+		<simpara>
+		    I can open the page and even make changes and save them, but I'm receiving the
+		    following warning message: Warning: fopen(<quote>/tmp/ser_fifo</quote>,
+		    <quote>w</quote>) ? Permission denied in /var/www/html/serweb/functions.php on
+		    line 172 Sorry - cannot open fifo.
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    Make sure that the user under which the web server is running has read and write
+		    access to the <acronym>FIFO</acronym>.
+		</simpara>
+	    </answer>
+	</qandaentry>
+    
+	<qandaentry>
+	    <question>
+		<simpara>
+		    Is there a way to add/edit/view aliases from serweb?
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    When new user confirm registration, new numeric alias is created. There is no
+		    another way to add or edit aliases from serweb.
+		</simpara>
+	    </answer>
+	</qandaentry>
+	
+	<qandaentry>
+	    <question>
+		<simpara>
+		    I am getting a <quote>Forbidden</quote> reply from the Apache. The Apache is
+		    pointing to the index.php for the serweb. I've only changed the &ip; address of
+		    the local host to 127.0.0.1 in the config.php. Does anyone have any suggestions
+		    ?
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    Check if the file/folder has read permission for everybody.
+		</simpara>
+	    </answer>
+	</qandaentry>
+
+	<qandaentry>
+	    <question>
+		<simpara>
+		    I get following warnings and error on NetBSD when I call
+		    user_interface/index.php:
+		    </simpara>
+		<simpara>
+		    [Wed Jul 16 09:56:53 2003] [error] PHP Warning: Call-time pass-by-reference has
+		    been deprecated - argument passed by value; If you would like to pass it by
+		    reference, modify the declaration of [runtime function name]().  If you would
+		    like to enable call-time pass-by-reference, you can set
+		    allow_call_time_pass_reference to true in your INI file.  However, future
+		    versions may not support this any longer.  in
+		    /usr/pkg/share/httpd/htdocs/iptel/phplib/user.inc on line 72 [Wed Jul 16
+		    09:56:53 2003] [error] PHP Fatal error: Call to undefined function:
+		    mysql_pconnect() in /usr/pkg/share/httpd/htdocs/iptel/phplib/db_mysql.inc on
+		    line 73
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    Simply do what the text says: enable allow_call_time_pass_reference in
+		    <filename>/usr/pkg/etc/php.ini</filename> and install <acronym>PHP</acronym>
+		    MySQL support.
+		</simpara>
+	    </answer>
+	</qandaentry>
+	
+	<qandaentry>
+	    <question>
+		<simpara>
+		    I started the webserver and got the following message: Starting up of httpd:
+		    [Thu Aug 14 15:16:51 2003] alert ] httpd: Could not determine the of server
+		    fully qualified domain name, using 127.0.0.1 for ServerName 
+		</simpara>
+		<simpara>
+		    Does anyone know where is the problem ?
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    Set ServerName variable in the configuration file of your webserver to hostname
+		    of your computer.
+		</simpara>
+	    </answer>
+	</qandaentry>
+	<qandaentry>
+	    <question>
+		<simpara>
+		    What version of ser should I use with serweb from the CVS ?
+		</simpara>
+	    </question>
+	    <answer>
+		<simpara>
+		    CVS version of serweb is aligned to the stable branch of ser. It will not work
+		    with ser 0.8.10 because the database tables have been changed recently.
+		</simpara>
+	    </answer>
+	</qandaentry>
+
+    </qandaset>
+</chapter>
+
+
+<!-- Keep this element at the end of the file
+Local Variables:
+sgml-parent-document: ("serfaq.sgml" "Book" "chapter")
+End:
+-->