Documentation updates for actual ejabberd 1.0.0 release.

SVN Revision: 471

doc/introduction.tex

@@ -6,7 +6,7 @@ Joeri}
 
 \ejabberd{} is a free (GPL) distributed fault-tolerant \Jabber{}/XMPP server and is mainly written in \footahref{http://www.erlang.org/}{Erlang}.
 
-\ejabberd{} is designed to be a \marking{stable} and \marking{feature rich} \Jabber{}/XMPP server.
+\ejabberd{} is designed to be a \marking{stable}, \marking{standards compliant}, and \marking{\mbox{feature rich}} \Jabber{}/XMPP server.
 
 \ejabberd{} is suitable for small servers, whether they need to be scalable or not, as well as extremely big servers.
 
@@ -41,39 +41,36 @@ Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation}
 
 \ejabberd{} is:
 \begin{itemize}
-\item \marking{Multiplatform:} \ejabberd{} runs under Windows NT/2000/XP and Unix derived systems such as Linux, FreeBSD and NetBSD.
+\item \marking{Multiplatform:} \ejabberd{} runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
 
-\item \marking{Distributed:} You can run \ejabberd{} on a cluster of machines and all of them will serve one \Jabber{} domain. When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support hundreds of concurrent users.
+\item \marking{Distributed:} You can run \ejabberd{} on a cluster of machines and all of them will serve one \Jabber{} domain. When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
 
 \item \marking{Fault-tolerant:} You can deploy an \ejabberd{} cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ``on the fly''.
-  
+
-\item \marking{Administrator Friendly:} \ejabberd{} is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already installed, and ready to run out of the box. Other benefits for administrators include:
+\item \marking{Administrator Friendly:} \ejabberd{} is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other  administrator benefits include:
 \begin{itemize}
-\item Comprehensive documentation.\moreinfo{ --- You can start in the \footahref{http://ejabberd.jabber.ru/book}{ejabberd Book}.}
+\item Comprehensive documentation.\improved{}\moreinfo{ --- You can start in the \footahref{http://ejabberd.jabber.ru/book}{ejabberd Book}.}
 \item Straightforward installers for Windows and Linux.\moreinfo{ --- (\footahref{http://ejabberd.jabber.ru/screenshots-linux-installer}{Screenshots}).}
-\item Web interface for administration tasks.\moreinfo{ --- With HTTPS secure access. \footahref{http://ejabberd.jabber.ru/online-demo-webadmin}{Demo}.}
+\item Web interface for administration tasks.\improved{}\moreinfo{ --- With HTTPS secure access. \footahref{http://ejabberd.jabber.ru/online-demo-webadmin}{Demo}.}
 \item Shared Roster groups.\improved{}\moreinfo{ --- The administrator can setup a common list of \Jabber{} users for all users on the server. Those users are virtually added to all rosters. They cannot be removed, but can be renamed or moved into different roster groups. Does not require client implementation. Not related to \jepref{0144} (Roster Item Exchange).\footahref{http://ejabberd.jabber.ru/screenshots-shared-roster-groups}{Screenshots})}
 \item Command line administration tool.\moreinfo{ --- Some basic administration tasks can be acomplished using the command line: register/remove users, backup/restore database, amongst others (\footahref{http://ejabberd.jabber.ru/screenshots-administration#ejabberdctl}{Screenshots}).}
 \item Can integrate with existing authentication mechanisms.
 \item Capability to send announce messages.
-\item Statistics via \jepref{0039} (Statistics Gathering).
 \end{itemize}
 
 \item \marking{Internationalized:} \ejabberd{} leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
-
 \begin{itemize}
 \item Translated in 11 languages.\moreinfo{ --- More information is available \footahref{http://ejabberd.jabber.ru/localization}{here}.}
 \item Support for \footahref{http://www.ietf.org/rfc/rfc3490.txt}{IDNA}.
-\item Support for \ns{xml:lang}.
 \end{itemize}
 
-\item \marking{Modular:} \ejabberd{}'s modular architecture allows easy customization:
+\item \marking{Open Standards:} \ejabberd{} is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
 \begin{itemize}
-\item Load only the modules you want.
+\item Fully XMPP compliant \moreinfo{ --- ejabberd is fully compliant with XMPP Core 1.0 and XMPP IM 1.0. Check the \footahref{http://ejabberd.jabber.ru/protocols}{supported protocols}.} \new{}
-\item Extend \ejabberd{} with your own custom modules.\moreinfo{ --- A list of contributed modules and patches is available on the \footahref{http://ejabberd.jabber.ru/contributions}{contributions page}.}
+\item XML-based protocol
+\item \footahref{http://ejabberd.jabber.ru/protocols}{Many JEPs supported}.
 \end{itemize}
 
-
 \end{itemize}
 
 \newpage
@@ -87,30 +84,23 @@ Justin Karneges, Founder of the Psi and the Delta projects}
 
 Besides common \Jabber{} server features, \ejabberd{} comes with a wide range of other features:
 \begin{itemize}
-\item The ability to interface via external components with networks such as:
+\item Modular: \ejabberd{}'s modular architecture allows easy customization:
 \begin{itemize}
-\item AIM
+\item Load only the modules you want.
-\item ICQ
+\item Extend \ejabberd{} with your own custom modules.\moreinfo{ --- A list of contributed modules and patches is available on the \footahref{http://ejabberd.jabber.ru/contributions}{contributions page}.}
-\item MSN
-\item Yahoo!
-\end{itemize}
-\item Open Standards
-\begin{itemize}
-\item \footahref{http://ejabberd.jabber.ru/protocols}{Many JEPs supported}.
-\item XML-based protocol
-\item Fully XMPP compliant for c2s connections (Core \& IM) \moreinfo{ --- ejabberd supports all XMPP Core 1.0 and XMPP IM 1.0, or is close to it. Check the \footahref{http://ejabberd.jabber.ru/protocols}{supported protocols}.}
 \end{itemize}
 \item Security
 \begin{itemize}
-\item SASL and STARTTLS for c2s connections.
+\item SASL and STARTTLS for c2s and s2s connections.\improved{}
 \item STARTTLS and Dialback s2s connections.\new{}
 \item Obsolete SSL for c2s connections also supported.
 \item Web interface accessible via HTTPS secure access.
 \end{itemize}
 \item Databases
 \begin{itemize}
+\item Native PostgreSQL support. \new{}
 \item Mnesia.
-\item ODBC data storage support (tested against PostgreSQL). \moreinfo{ --- ODBC requests can be load balanced between several connections.}
+\item ODBC data storage support. \improved{}\moreinfo{ --- ODBC requests can be load balanced between several connections.}
 \end{itemize}
 \item Authentication
 \begin{itemize}
@@ -118,14 +108,21 @@ Besides common \Jabber{} server features, \ejabberd{} comes with a wide range of
 \item External Authentication script.
 \item Internal Authentication.
 \end{itemize}
+\item The ability to interface via external components with networks such as:
+\begin{itemize}
+\item AIM
+\item ICQ
+\item MSN
+\end{itemize}
 \item Others
 \begin{itemize}
 \item IPv6 support both for c2s and s2s connections. 
-\item Support for virtual hosting. \moreinfo{ --- Several \Jabber{} hosts can be hosted on the same \ejabberd{} instance. As simple as adding a new domain name to the list of hosts in the configuration file.}
+\item Support for virtual hosting. \improved{}\moreinfo{ --- Several \Jabber{} hosts can be hosted on the same \ejabberd{} instance. As simple as adding a new domain name to the list of hosts in the configuration file.}
 \item \tjepref{0025}{HTTP Polling} service
 \item \tjepref{0045}{Multi-User Chat} module.
 \item IRC transport.
 \item \tjepref{0060}{Publish-Subscribe} component.
 \item Users Directory based on users vCards.
+\item Statistics via Statistics Gathering (\jepref{0039}).
 \end{itemize}
 \end{itemize}

doc/release_notes_1.0.0.txt

@@ -1,112 +1,113 @@
-			    Release notes
+			    Release Notes
 			    ejabberd 1.0.0
-			      2005-12-13
+			    14 December 2005
 
-   This document describes the main changes in ejabberd 1.0.0. This version is
+   This document describes the main changes in ejabberd 1.0.0. Unique in this
-   compliant with the XMPP (eXtensible Messaging and Presence Protocol)
+   version is the compliancy with the XMPP (eXtensible Messaging and Presence
-   standard. ejabberd is the first Open Source server claiming to fully
+   Protocol) standard. ejabberd is the first Open Source Jabber server claiming
-   comply to the XMPP standard.
+   to fully comply to the XMPP standard.
 
-   The code can be downloaded from the Process-one website:
+   ejabberd can be downloaded from the Process-one website:
    http://www.process-one.net/en/projects/ejabberd/
 
-   For more detailed information, please refer to ejabberd User Guide
+   Detailed information can be found in the ejabberd Feature Sheet and User
-   on the Process-one website:
+   Guide which are available on the Process-one website:
    http://www.process-one.net/en/projects/ejabberd/docs.html
 
 
-   Recent changes include....
+   Recent changes include:
 
 
-Encrypted server-to-server connections
+Server-to-server Encryption for Enhanced Security
 
-  - Support for STARTTLS+SASL EXTERNAL for Server-to-Server connections.
+  - Support for STARTTLS and SASL EXTERNAL to secure server-to-server traffic
-  - STARTTLS+Dialback has been implemented for Server-to-Server (s2s)
+    has been added.
-    connections. Those options are handled with two new config file options
+  - Also, STARTTLS and Dialback has been implemented for server-to-server (s2s)
-    (s2s_use_starttls and s2s_certfile). See ejabberd.cfg.example for usage
+    connections. Detailed information about these new features can be found on
-    examples.
+    http://ejabberd.jabber.ru/s2s-encryption
-  - DNSName certificate field and DNS name matching are supported.
+  - commonName and dNSName fields matching were introduced to ease the process
-  - Per virtual host certificate can be defined.
+    of retrieving certificates.
+  - Different certificates can be defined for each virtual host.
 
 ODBC Support
 
   - ODBC support has been improved to allow production use of ejabberd with
     relational databases.
-  - Support for VCard storage in ODBC has been added.
+  - Support for vCard storage in ODBC has been added.
-  - ejd2odbc.erl: is a program that convert an installation from Erlang Mnesia
+  - ejd2odbc.erl is a tool to convert an installation from Erlang's database
-    database to an ODBC relational database.
+    Mnesia to an ODBC compatible relational database.
 
-Native PostgreSQL support
+Native PostgreSQL Support
 
-  - Native postgreSQL support has been added: You can now use a PostgreSQL
+  - Native PostgreSQL support gives you a better performance when you use
-    database without the need to go through the ODBC driver.
+    PostgreSQL.
 
-Shared roster
+Shared Roster groups
 
-  - Shared roster support have been improved: You can specify all users in a
+  - Shared Roster groups support has been enhanced. New is the ability to add
-    virtual host for addition in a group.
+    all registered users to everyone's roster. Detailed information about this
+    new feature can be found on http://ejabberd.jabber.ru/shared-roster-all
 
-Web interface
+Web Interface
 
-   - The Web interface internal code has been modified for better integration
+   - The web interface internal code has been modified for better integration
-     and compliance with J-EAI.
+     and compliancy with J-EAI, an ejabberd-based Enterprise Application
-   - The Web interface is now compliant to XHTML 1.0 Transitional.
+     Integration platform.
-   - Several bugs have been fixed.
+   - More XHTML 1.0 Transitional compliancy work was done.
 
 Transports
 
-   - A transport workaround can be enabled with the compile time option. You
+   - A transport workaround can be enabled during compilation. To do this, you
      can pass the "--enable-roster-gateway-workaround" option to the configure
-     script. For example:
+     script. (./configure --enable-roster-gateway-workaround)
-     ./configure --enable-roster-gateway-workaround
+     This option allows transports to add items with subscription "to" in the
-     This option allows to add items with subscription "to" in roster by
+     roster by sending <presence type='subscribed'/> stanza to user. This option
-     sending <presence type='subscribed'/> stanza to user. This option is
+     is only needed for JIT ICQ transport.
-     needed for JIT ICQ transport.
+     Warning: by enabling this option, ejabberd will not be fully XMPP compliant
-     Warning: By using this option, ejabberd is not fully XMPP compliant.
+              anymore.
 
-Documentation and translations
+Documentation and Internationalization
 
-   - Documentation has been improved to cover more topics.
+   - Documentation has been extended to cover more topics.
-   - Translations have been updated to support the new features.
+   - Translations have been updated.
 
 Bugfixes
 
    - This release contains several bugfixes.
-
+   - Among other bugfixes include improvements to the client-to-server (c2s)
-     Among other bugfixes include improvements to the Client-to-Server
+     connection management module.
-     connection management module. Please refer to the ChangeLog file supplied
+   - Please refer to the ChangeLog file supplied
      with this release regarding all improvements in ejabberd.
 
-Erlang version supported
 
-   - You now need at least Erlang/OTP R9C to be able to run ejabberd 1.0.0.
+   Installation Notes
 
-Installers
 
-   Installers are provided for Microsoft Windows and Linux/x86. The Linux
+Supported Erlang Version
-   installer includes Erlang ASN.1 modules for LDAP authentication support.
+
-   Installers are available from:
+   - You need at least Erlang/OTP R9C to run ejabberd 1.0.0.
+
+Installation
+
+   Installers are provided for Microsoft Windows and Linux/x86.
+   Installers can be retrieved from:
    http://www.process-one.net/en/projects/ejabberd/download.html
 
-Migration
+Migration Notes
 
    - Before any migration, ejabberd system and database must be properly
-     backed-up.
+     backed up.
-   - System migrating from a previous ODBC based install will need to change
+   - When upgrading an ODBC-based installation, you will need to change the
-     their relational database schema. The following SQL commands must be run
+     relational database schema. The following SQL commands must be run on the
-     on the database:
+     database:
-    CREATE SEQUENCE spool_seq_seq;
+       CREATE SEQUENCE spool_seq_seq;
-    ALTER TABLE spool ADD COLUMN seq integer;
+       ALTER TABLE spool ADD COLUMN seq integer;
-    ALTER TABLE spool ALTER COLUMN seq SET DEFAULT nextval('spool_seq_seq');
+       ALTER TABLE spool ALTER COLUMN seq SET DEFAULT nextval('spool_seq_seq');
-    UPDATE spool SET seq = DEFAULT;
+       UPDATE spool SET seq = DEFAULT;
-    ALTER TABLE spool ALTER COLUMN seq SET NOT NULL;
+       ALTER TABLE spool ALTER COLUMN seq SET NOT NULL;
 
 References
 
-   The ejabberd feature sheet helps comparing with other Jabber/XMPP 
-   servers:
-   http://www.process-one.net/en/projects/ejabberd/docs/features.pdf
-
    Contributed tutorials of interest are:
    - Migration from Jabberd1.4 to ejabberd:
      http://ejabberd.jabber.ru/jabberd1-to-ejabberd