packaging - going well, with one exception

Bhuvaneswaran bhuvan at ubuntu.com
Tue Nov 29 07:26:49 UTC 2005


> several minutes)! I have no idea why, because running the relevant
> command in the command line is really fast. If anyone knows WHY this is

Fortunately, the problem is repeatable. If i run it from Makefile,
it's very slow. If i run it from the command line, it's fast. If it
run it from a dedidated Makefile (just an entry for serverguide
alone), it's fast.

When i debugged, i found it was due to the docbook version we use for
server guide. Currently, we're using v4.3. For almost all other
documents we use v4.1.2. So, i used v4.1.2 for server guide and it
solves the problem. I've attached the patch, please verify and apply.

Please follow these steps to apply this patch:

$ cp /tmp/ubuntu-doc.xml ubuntu-doc/common/authors/ # attached in this email
$ cd ubuntu-doc
$ apply the patch serverguide.diff

In addition, this server guide patch contains the sections for apache2
& ftp server.
--
Regards,
Bhuvaneswaran
www.symonds.net/~bhuvan/
GPG: 0x7A13E5B0
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ubuntu-doc.xml
Type: text/xml
Size: 216 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20051129/5f4d03a6/attachment.xml>
-------------- next part --------------
Index: libs/global.ent
===================================================================
--- libs/global.ent	(revision 2146)
+++ libs/global.ent	(working copy)
@@ -25,6 +25,7 @@
 <!ENTITY author-troy-williams SYSTEM '../common/authors/troy-williams.xml'>
 <!ENTITY author-matt-galvin SYSTEM '../common/authors/matt-galvin.xml'>
 <!ENTITY author-robert-stoffers SYSTEM '../common/authors/robert-stoffers.xml'>
+<!ENTITY ubuntu-doc SYSTEM '../common/authors/ubuntu-doc.xml'>
 
 <!ENTITY glossary SYSTEM '../common/C/glossary.xml' >
 
Index: generic/serverguide/C/installation.xml
===================================================================
--- generic/serverguide/C/installation.xml	(revision 2143)
+++ generic/serverguide/C/installation.xml	(working copy)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
-	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 <!ENTITY % globalent SYSTEM "../../../libs/global.ent">
 %globalent;
 <!ENTITY % cdo-C SYSTEM "../../../libs/cdo-C.ent">
Index: generic/serverguide/C/introduction.xml
===================================================================
--- generic/serverguide/C/introduction.xml	(revision 2143)
+++ generic/serverguide/C/introduction.xml	(working copy)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
-	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 <!ENTITY % globalent SYSTEM "../../../libs/global.ent">
 %globalent;
 <!ENTITY % cdo-C SYSTEM "../../../libs/cdo-C.ent">
Index: generic/serverguide/C/serverguide.xml
===================================================================
--- generic/serverguide/C/serverguide.xml	(revision 2143)
+++ generic/serverguide/C/serverguide.xml	(working copy)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
-	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 <!ENTITY % globalent SYSTEM "../../../libs/global.ent">
 %globalent;
 <!ENTITY % cdo-C SYSTEM "../../../libs/cdo-C.ent">
Index: generic/serverguide/C/packaging.xml
===================================================================
--- generic/serverguide/C/packaging.xml	(revision 2143)
+++ generic/serverguide/C/packaging.xml	(working copy)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
-	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 <!ENTITY % globalent SYSTEM "../../../libs/global.ent">
 %globalent;
 <!ENTITY % cdo-C SYSTEM "../../../libs/cdo-C.ent">
Index: generic/serverguide/C/preface.xml
===================================================================
--- generic/serverguide/C/preface.xml	(revision 2143)
+++ generic/serverguide/C/preface.xml	(working copy)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
-	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 <!ENTITY % globalent SYSTEM "../../../libs/global.ent">
 %globalent;
 <!ENTITY % cdo-C SYSTEM "../../../libs/cdo-C.ent">
Index: generic/serverguide/C/bookinfo.xml
===================================================================
--- generic/serverguide/C/bookinfo.xml	(revision 2143)
+++ generic/serverguide/C/bookinfo.xml	(working copy)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
-	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 <!ENTITY % globalent SYSTEM "../../../libs/global.ent">
 %globalent;
 <!ENTITY % cdo-C SYSTEM "../../../libs/cdo-C.ent">
@@ -46,12 +46,7 @@
 	<!-- <para>&revhistory;</para> -->
 	</legalnotice>
         ©right;
-        <authorgroup>
-            <author>
-                <firstname>Ubuntu Documentation Project</firstname>
-                <email>ubuntu-doc at lists.ubuntu.com</email>
-            </author>
-        </authorgroup>
+        <authorgroup> &ubuntu-doc; </authorgroup>
         <abstract>
             <para>The Ubuntu Server Starter guide aims to assist
             Administrators to install the Ubuntu Server. It explains
Index: generic/serverguide/C/system-conf.xml
===================================================================
--- generic/serverguide/C/system-conf.xml	(revision 2143)
+++ generic/serverguide/C/system-conf.xml	(working copy)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
-	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 <!ENTITY % globalent SYSTEM "../../../libs/global.ent">
 %globalent;
 <!ENTITY % cdo-C SYSTEM "../../../libs/cdo-C.ent">
Index: generic/serverguide/C/network-applications.xml
===================================================================
--- generic/serverguide/C/network-applications.xml	(revision 2143)
+++ generic/serverguide/C/network-applications.xml	(working copy)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
-	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 <!ENTITY % globalent SYSTEM "../../../libs/global.ent">
 %globalent;
 <!ENTITY % cdo-C SYSTEM "../../../libs/cdo-C.ent">
@@ -136,22 +136,73 @@
         </sect2>
     </sect1>
 	<sect1 id="vsftpd-ftp-server" status="writing">
-		<title>vsftpd - FTP Server</title>
-          <para>
-            vsftpd - FTP Server para ...
-          </para>
-      <sect2 id="ftp-introduction" status="writing">
         <title>FTP Introduction</title> 
-          <para>
-            FTP Introduction para ...
-          </para>
-          </sect2>
-        <sect2 id="ftp-configuration" status="writing">
-          <title>FTP Configuration</title>
-            <para>
-              FTP Configuration para ...
-            </para>
-        </sect2>
+            <para>FTP (File Transfer Protocol) is a TCP protocol for uploading and downloading large
+                files between computers. FTP works on a client/server model. The server component is
+                called a <emphasis>FTP daemon</emphasis>, it continuosly checks for FTP requests
+                from remote clients. When a request is received it manages the the login and sets up
+                the connection. For the duration of a session it executes any of commands sent by
+                the FTP client.</para>
+            <para>Access to an FTP server can be managed in two ways:</para>
+            <itemizedlist spacing="compact">
+                <listitem>
+                    <para>Anonymous</para>
+                </listitem>
+                <listitem>
+                    <para>Authenticated</para>
+                </listitem>
+            </itemizedlist>
+            <para>In the Anonymous mode, remote clients can access the FTP server using the a
+                default user called 'anonymous" or "ftp" and
+                sending thier email address as the password. In the Authenticated mode a user must
+                have an account and password. User access to the FTP server directories and files is
+                dependant on the permissions defined for the account used at login. As a general
+                rule the FTP daemon will hide the root directory of the FTP server and change it to
+                the FTP Home directory. This hides the rest of the file system from remote
+            sessions.</para>
+            <sect2>
+                <title>vsftpd - FTP Server</title>
+                <procedure><step>
+                    <para>vsftpd is a FTP daemon available in
+                    Ubuntu Linux. It is easy to install, setup and
+                    maintain.</para></step>
+                </procedure>
+            <variablelist>
+                <varlistentry>
+                    <term>Installation:</term>
+                    <listitem>
+                        <para>At the prompt enter the following command to install
+                                <application>vsftpd</application>:</para>
+                        <para>
+                            <command>sudo apt-get install vsftpd</command>
+                        </para>
+                    </listitem>
+                </varlistentry>
+                </variablelist>
+                <variablelist>
+                <varlistentry>
+                    <term>Configuration:</term>
+                    <listitem>
+                        <para>
+                        You may edit vsftpd configuration file to the
+                        change default settings. More information about
+                        each configuration parameter is available in
+                        the configuration file.
+                        </para>
+                        <para>
+                            <command>sudo vim /etc/vsftpd.conf</command>
+                        </para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>Manage Service:</term>
+                    <listitem>
+                        <para> <command>sudo /etc/init.d/vsftpd start</command></para>
+                        <para><command>sudo /etc/init.d/vsftpd stop</command> </para>
+                    </listitem>
+                </varlistentry>
+            </variablelist>
+                </sect2>
     </sect1>
 	<sect1 id="network-file-system" status="writing">
 		<title>Network File System (NFS)</title>
@@ -257,31 +308,221 @@
     </sect1>
 	<sect1 id="http" status="writing">
 		<title>HTTP - Apache2 Web Server</title>
-          <para>
-            HTTP para ...
-          </para>
-      <sect2 id="http-installation" status="writing">
-        <title>Installation</title>
-          <para>
-            Installation para ...
-          </para>
+      <para>Apache is the most commonly used Web Server on Linux systems. Web Servers are used
+          to serve Web Pages requested by client computers. Clients typically request and view
+          Web Pages using Web Browser applications such as <application>Firefox</application>,
+              <application>Opera</application> or <application>Mozilla</application>.</para>
+      <para>Users enter a URL (Uniform Resource Locater) to point to a Web server by means of
+          its FQDN and a path to the required resource. For example, to view the home page of
+          the <ulink url="&ubuntu-web;">Ubuntu Web site</ulink> a user will enter only the FQDN. To request specific information about 
+              <ulink url="&ubuntu-paidsupport;">paid
+              support</ulink> a user will enter the FQDN followed by a path.</para>
+      <para>The most common protocol used to transfer Web pages is HTTP (HyperText Transfer
+          Protocol). Protocols such as HTTPS, a secure, encrypted version of HTTP, and FTP
+          (File Transfer Protocol), a protocol for uploading and downloading files, are also
+          supported.</para>
+      <para>Apache Web Servers are often combined with the <application>MySQL</application>
+          database, <application>PHP</application>, popular scripting languages such as
+              <application>Python</application> and <application>Perl</application>. This
+          configuration is termed LAMP (Linux, Apache, MySQL and Perl/Python/PHP) and forms a
+          powerful and robust platform for the development and serving of Web-based
+          applications.</para>
+<sect2 id="http-installation" status="writing">
+  <title>Installation</title>
+          <procedure><step>
+                  <para>Apache2 web server is available in Ubuntu
+                  Linux. This section explains howto install
+                  Apache2 in Ubuntu Linux.</para></step>
+          </procedure>
+      <variablelist>
+          <varlistentry>
+              <term>Packages:</term>
+              <listitem>
+                  <para><application>apache2</application></para>
+                  <para><application>apache2-common</application></para>
+              </listitem>
+          </varlistentry>
+          <varlistentry>
+              <term>Installation:</term>
+              <listitem>
+                  <para>At the prompt enter the following command to install
+                          <application>apache2</application> and
+                          <application>apache2-common</application>:</para>
+                  <para>
+                      <command>sudo apt-get install apache2 apache2-common</command>
+                  </para>
+              </listitem>
+          </varlistentry>
+          </variablelist>
       </sect2>
       <sect2 id="http-configuration" status="writing">
         <title>Configuration</title>
           <para>
-            Configuration para ...
+          Apache is configured by placing directives in plain text
+          configuration files. The main configuration file is usually
+          called apache2.conf. The location of this file is set at
+          compile-time, but may be overridden with the -f  command line
+          flag. In addition, other configuration files may be added
+          using the Include  directive, and wildcards can be used to
+          include many configuration files. Any directive may be placed
+          in any of these configuration files. Changes to the main
+          configuration files are only recognized by Apache2 when it is
+          started or restarted.</para>
+
+          <para>The server also reads a file containing mime document types;
+          the filename is set by the TypesConfig directive, and is
+          mime.types by default.</para>
+
+          <para>The default Apache2 configuration file is /etc/apache2/apache2.conf.
+          You must edit this file to configure the Apache2 server. You can
+          configure the port number, document root, modules, log files, 
+          virutal hosts, etc.
           </para>
+          <para>
+              <command>sudo vim /etc/apache2/apache2.conf</command>
+          </para>
         <sect3 id="http-basic-settings" status="writing">
           <title>Basic Settings</title>
             <para>
-              Basic Settings para ...
+             This section explains Apache2 server essential configuration
+             parameters. You must refer <ulink
+             url="http://httpd.apache.org/docs/2.0/">Apache2
+             Documentation</ulink> for more details.</para>
+
+             <itemizedlist>
+
+             <listitem><para>
+             Enter a fully qualified domain name that you have the
+             right to use in the Server Name text area. This option
+             corresponds to the ServerName  directive in apache2.conf.
+             The ServerName directive sets the hostname of the Web
+             server.
+            </para></listitem>
+
+             <listitem><para>Enter the email address of the person who maintains the
+             Web server in the Webmaster email address text area. This
+             option corresponds to the ServerAdmin  directive in
+             apache2.conf. If you configure the server's error pages to
+             contain an email address, this email address will be used
+             so that users can report a problem by sending email to the
+             server's administrator. The default value is
+             root at localhost.</para></listitem>
+
+             <listitem><para>Enter the port number of Apache2 server. 
+             This option corresponds to the Listen  directive in
+             apache2.conf. The default value is 80. 
+             </para></listitem>
+            </itemizedlist>
+
+            <tip>
+            <para>
+            If you set the server to listen to a port under 1024, you
+            must be root to start it. For port 1024 and above,
+            <application>apache2</application> can be started as a
+            regular user.
             </para>
+            </tip>
         </sect3>
         <sect3 id="default-settings" status="writing">
           <title>Default Settings</title>
             <para>
-              Default Settings para ...
+             This section explains configuring the default settings of
+             the Apache2 server.  For example, if you add a virtual host, 
+             the settings you configure for the virtual host take
+             precedence for that virtual host. For a directive not
+             defined within the virtual host settings, the default
+             value is used.
             </para>
+
+            <itemizedlist>
+            <listitem>
+            <para>
+             The DirectoryIndex is the default page served by the
+             server when a user requests an index of a directory by
+             specifying a forward slash (/) at the end of the directory
+             name.</para>
+
+             <para>For example, when a user requests the page
+             http://www.example.com/this_directory/, they are going to
+             get either the DirectoryIndex page if it exists, or a
+             server-generated directory list. The server will try to
+             find one of the files listed in the DirectoryIndex
+             directive and will return the first one it finds. If it
+             does not find any of these files and if Options Indexes is
+             set for that directory, the server will generate and
+             return a list, in HTML format, of the subdirectories and
+             files in the directory. 
+            </para>
+            </listitem>
+
+            <listitem>
+            <para>
+             Use the Error Code section to configure Apache2 Server
+             to redirect the client to a local or external URL in the
+             event of a problem or error. This option corresponds to
+             the ErrorDocument  directive.
+            </para>
+            </listitem>
+
+
+            <listitem>
+            <para>
+             By default, the server writes the transfer log to the file
+             /var/log/apache2/access.log. You can configure a custom
+             log format. This option corresponds to LogFormat
+             directive. The server writes the error log to the
+             /var/log/apache2/error.log file. This option corresponds
+             to the ErrorLog directive. The log level can be set using
+             LogLevel directive.
+            </para>
+            </listitem>
+
+            <listitem>
+            <para>
+            You can configure the Default Directory Options for all
+            directories. This option corresponds to Option directive
+            within <Directory> directive. You can configure the
+            following options:
+            </para>
+            <itemizedlist spacing="compact">
+                <listitem>
+                    <para><emphasis role="bold">ExecCGI</emphasis> — Allow
+                    execution of CGI scripts. CGI scripts are not
+                    executed if this option is not chosen.</para>
+                </listitem>
+                <listitem>
+                    <para><emphasis role="bold">Includes</emphasis> — Allow server-side includes.</para>
+                </listitem>
+                <listitem>
+                    <para><emphasis
+                    role="bold">IncludesNOEXEC</emphasis> — Allow server-side includes,
+                    but disable the #exec and #include commands in CGI
+                    scripts.</para>
+                </listitem>
+                <listitem>
+                    <para>
+                    <emphasis role="bold">Indexes</emphasis> — Display a formatted list of the
+                    directory's contents, if no DirectoryIndex (such as
+                    index.html) exists in the requested directory.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>
+                    <emphasis role="bold">Multiview</emphasis> — Support content-negotiated multiviews;
+                    this option is disabled by default.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>
+                    <emphasis role="bold">SymLinksIfOwnerMatch</emphasis> — Only follow symbolic links
+                    if the target file or directory has the same owner
+                      as the link.
+                    </para>
+                </listitem>
+            </itemizedlist>
+
+            </listitem>
+            </itemizedlist>
         </sect3>
         <sect3 id="virtual-hosts-settings" status="writing">
           <title>Virtual Hosts Settings</title>
@@ -297,9 +538,41 @@
         </sect3>
         <sect3 id="apache-modules" status="writing">
           <title>Apache Modules</title>
-            <para>
-              Apache Modules para ...
-            </para>
+              <para>
+
+              Apache is a modular server. This implies that only the most
+              basic functionality is included in the core server. Extended
+              features are available through modules which can be loaded
+              into Apache. By default, a base set of modules is included in
+              the server at compile-time. If the server is compiled to use
+              dynamically loaded  modules, then modules can be compiled
+              separately and added at any time using the LoadModule
+              directive. Otherwise, Apache must be recompiled to add or
+              remove modules. Configuration directives may be included
+              conditional on a presence of a particular module by enclosing
+              them in an <IfModule> block.
+
+              You can install the Apache2 module and use them
+              with your web server. You can install Apache2
+              module using <command>apt-get</command>
+              command. For example, to install Apache2 module
+              for MYSQL authentication, you can run the
+                following command:</para>
+                
+                <para>
+                  <command>sudo apt-get install apache2 apache2-common</command>
+                </para>
+                <para>
+                Once you install the module, the module would
+                be available under
+                /etc/apache2/mods-available directory. You can use
+              <command>a2enmod</command> command to
+              enable a module. You can use
+              <command>a2dismod</command> command to
+              disable a module. Once you enable the module,
+              the module would be available under
+              /etc/apache2/mods-enabled directory.
+              </para>
         </sect3>
       </sect2>
       <sect2 id="https-configuration" status="writing">
@@ -353,7 +626,8 @@
       <sect2 id="http-references" status="writing">
         <title>References</title>
           <para>
-            References para ...
+          <ulink url="http://httpd.apache.org/docs/2.0/">Apache2
+          Documentation</ulink>
           </para>
       </sect2>
     </sect1>
Index: generic/serverguide/C/windows-networking.xml
===================================================================
--- generic/serverguide/C/windows-networking.xml	(revision 2143)
+++ generic/serverguide/C/windows-networking.xml	(working copy)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
-	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 <!ENTITY % globalent SYSTEM "../../../libs/global.ent">
 %globalent;
 <!ENTITY % cdo-C SYSTEM "../../../libs/cdo-C.ent">


More information about the ubuntu-doc mailing list