251338 - Installation section doesn't mention that you need an MTA installed

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Dave Miller [:justdave]]

This is probably going to be less of an issue for 2.19 once bug 84876 lands, but
it'd probably be a good idea for the 2.16 and 2.18 docs.

Subject: Bugzilla manual upgrade suggestion.
Date: Wed, 14 Jul 2004 11:44:31 +0200
From: "Willem J.W. Semmelink" <[e-mail]>
To: <[e-mail]>

Hi Dave
I got your email address from http://www.bugzilla.org/developers/how_to_help.html
, particularly the item
"If you think you can help with the documentation for Bugzilla, please contact
Dave Miller."

I would like to suggest that the Linux installation guide be updated with an
additional item to remind the reader that some sendmail facility should be
present.   

In the 2-19 release, (PDF version), on Page 4, 
	1. Install Perl (5.6.0 or above)
	2. Install MySQL (3.23.41 or above)
	3. Install a Webserver
	4. Install Bugzilla
	5. Install Perl modules
>> ADD  Install and configure an MTA (Mail transfer Agent).
	6. Configure all of the above.


In the same release, on Page 8
Just before 2. Configuration, I suggest adding something like:

1.6. Install and configure an MTA. 
  Bugzilla is dependent on the availability of an e-mail system for it's user
authentication and for other tasks. 
  On Linux, any Sendmail-compatible MTA (Mail Transfer Agency) will suffice.
Sendmail, Postfix, qmail and Exim are MTAs. Sendmail is the original Unix MTA,
but the others are easier to configure, and therefore many people replace
Sendmail with Postfix or Exim. They are drop-in replacements, so that Bugzilla
will not distinguish between them.

Consult the manual for the specific MTA you chose for detailed installation
instructions. Each of these programs have their own config files where you must
configure certain parameters to ensure that the mail is delivered properly. They
are implemented as services, and you should ensure that the MTA is in the
auto-start list of services for the machine. 
 
If a simple mail sent with the command-line 'mail' program succeeded, then
Bugzilla should also be fine. 


Hope my 2c worth does contribute something

Regards
Willem Semmelink

Comment 1

[Colin Ogilvie [:cso]]

Attachment: Patch v1

Patch with a slightly modified version of the description above, from the 2.18
branch.

I should probably add a bit on MTAs on Windows, but I'm not really sure of any
that exist, as I usually just use Net::SMTP in my Perl programs.

Comment 2

[Vlad Dascalu]

Comment on attachment 153221 [details] [diff] [review]
Patch v1

You also need to add a pointer to the section at the beginning, something in
the lines of:

      <step>
	<para><link linkend="install-MTA">Install a Mail Transfer Agent
(MTA)</link>
	</para>
      </step>

Comment 3

[Colin Ogilvie [:cso]]

Attachment: Patch v2

Add title..

Comment 4

[Vlad Dascalu]

Comment on attachment 157959 [details] [diff] [review]
Patch v2

"They are drop-in replacements, so that Bugzilla will not distinguish between
them." is not exactly true as we have sendmail hard-coded in the code at least
on 2.16, so at least a symlink or something like that is required, and we
should consider this if we commit this for the 2.16 docs, but it looks good
overall!

Comment 5

[Dave Miller [:justdave]]

Please change "succeeded" to "succeeds" in the last paragraph when this is
checked in.  I don't know if this will apply as-is to the 2.16 branch, but this
text should be added to the 2.16 docs as well.

Comment 6

[Colin Ogilvie [:cso]]

Attachment: Patch v3 (2.18 Branch / Trunk)

Patch for the 2.18 Branch updated per Dave's comment.

No changes other than updating the typo, so hopefully the review from vladd
still stands.

Comment 7

[Colin Ogilvie [:cso]]

Attachment: Patch v1 (2.16 Branch)

This adds it to the 2.16 Branch documentation; after checksetup.pl but before
Configuring Bugzilla.

http://www.colinogilvie.co.uk/bugzilla/installation.html and
http://www.colinogilvie.co.uk/bugzilla/stepbystep.html show it...

Comment 8

[Vlad Dascalu]

Comment on attachment 160164 [details] [diff] [review]
Patch v1 (2.16 Branch)

+      <para>Bugzilla is dependent on the availability of an e-mail system for
it's user

it's --> its

Comment 9

[Colin Ogilvie [:cso]]

Attachment: Parch v2 (2.16 Branch)

Typo Fixed. Rest of comment as above.

Comment 10

[Colin Ogilvie [:cso]]

Attachment: Patch v4 (2.18 Branch / Trunk)

Typo Vladd mentioned in the 2.16 branch also occurs here.

Comment 11

[Colin Ogilvie [:cso]]

Attachment: Patch v3 (2.16 Branch)

Comment 12

[Colin Ogilvie [:cso]]

Attachment: Patch v5 (2.18 Branch / Trunk)

Comment 13

[Vlad Dascalu]

Checking in docs/xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <-- 
installation.xml
new revision: 1.18.2.18; previous revision: 1.18.2.17
done

Checking in docs/xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <-- 
installation.xml
new revision: 1.72.2.4; previous revision: 1.72.2.3
done

Checking in docs/xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/installation.xml,v  <-- 
installation.xml
new revision: 1.76; previous revision: 1.75
done