OS-specific installation notes should be clearer in how to use ScriptInterpreterSource

RESOLVED FIXED in Bugzilla 3.0

Status

()

--
enhancement
RESOLVED FIXED
11 years ago
9 years ago

People

(Reporter: Wurblzap, Assigned: LpSolit)

Tracking

3.0.3
Bugzilla 3.0

Details

Attachments

(1 attachment, 2 obsolete attachments)

(Reporter)

Description

11 years ago
Created attachment 310575 [details] [diff] [review]
Patch

The OS-specific installation notes mention ScriptInterpreterSource and link to the Apache documentation, but that's rather generic and can be clearer and specific to Bugzilla.

Patch along the lines as the change proposed by robbe on IRC.
Attachment #310575 - Flags: review?(documentation)

Comment 1

11 years ago
The value "Registry-Strict" is apache 2.x minimum. In apache 1.x this would be "Registry", which has a lot of security implications, as described in the apache doc. 
I'm not sure to what extent apache 1.x users should be considerated and how much security warnings there should be.

(this is user robbe on irc, after pondering this again)

Comment 2

11 years ago
Don't worry about Apache 1.x users on Windows. By the time that Bugzilla supported Windows, Apache 2.x was the standard and 1.x was quite old.

Comment 3

11 years ago
I've just read the patch, and I'm confused...

The <para></para> block before this one tells me to set it to something involving the path to Perl, then this one tells me to go registry hacking and set it to something different.

I think this needs to be more consistent?

Comment 4

11 years ago
@Colin: Right. The para-block before is a reduced description. Fact is: you do not set the "ScriptInterpreterSource" directly to the path to Perl. Instead, there are exactly three values it can be set to: "Registry", "Registry-Strict" and "Script". If you set it to values "Registry" or "Registry-Strict", it will look up the path to Perl in the registry. 

This is a bit confusing, but since it is covered by the indicated apache doc, there is no need to explain that in bugzilla doc. Furthermore I'm not a native speaker, so it's difficult for me to express complex facts in an accurate way with few words.

After all I would propose to change both paragraphs to something like the following. Please note that it is importent to add the tags in the first paragraph again, which I omitted. 

-------
Note If using Apache on windows, you can set the ScriptInterpreterSource directive in your Apache config to avoid having to modify the first line of every script to contain your path to Perl instead of /usr/bin/perl. Do not forget to specify the -T flag to enable the taint mode.

To use the <programlisting>ScriptInterpreterSource</programlisting> directive with bugzilla, insert the line <programlisting>ScriptInterpreterSource Registry-Strict</programlisting> into your <filename>httpd.conf</filename> file, and create the key <option>HKEY_CLASSES_ROOT\.cgi\Shell\ExecCGI\Command</option> with the value <option>C:\Perl\bin\perl.exe -T</option> (adapt to your path if needed) in the registry. Be sure to know about the security implications as described in the apache doc.
-------
(Assignee)

Comment 5

11 years ago
Comment on attachment 310575 [details] [diff] [review]
Patch

I like Robbe's suggestion in comment 4 better. It's confusing and useless to repeat things twice. The first paragraph should be a quick note, then you immediately describe in details how to use ScriptInterpreterSource.
Attachment #310575 - Flags: review?(documentation) → review-
(Assignee)

Updated

10 years ago
Duplicate of this bug: 463838
(Assignee)

Comment 7

10 years ago
Marc, are you still working on it?
(Reporter)

Comment 8

10 years ago
Not atm. Not being a native speaker, I don't feel comfortable with any current options... It may be I'll pick it up again some time, but for now, I bail.
Assignee: wurblzap → documentation
Status: ASSIGNED → NEW
(Assignee)

Comment 9

9 years ago
Created attachment 391188 [details] [diff] [review]
patch, v2
Assignee: documentation → LpSolit
Attachment #310575 - Attachment is obsolete: true
Status: NEW → ASSIGNED
Attachment #391188 - Flags: review?(wurblzap)
(Assignee)

Comment 10

9 years ago
Note that the removal of the "win32-code-changes" section as part of this patch is intentional as we no longer support Bugzilla 2.x.
(Reporter)

Comment 11

9 years ago
Comment on attachment 391188 [details] [diff] [review]
patch, v2

Mostly all right, r=Wurblzap on an updated patch:

>Index: docs/en/xml/installation.xml
>@@ -1687,14 +1685,16 @@ C:\perl&gt; <command>ppm install &lt;mod
>+            Bugzilla looks at <filename>/usr/bin/perl</filename> to

It's not Bugzilla, it's the web server. I think that's an important distinction, because if it goes wrong, it's the web server's fault, not Bugzilla's :)
Attachment #391188 - Flags: review?(wurblzap) → review+
(Assignee)

Comment 12

9 years ago
Created attachment 391314 [details] [diff] [review]
patch, v2.1

s/Bugzilla looks at/The web server looks at/. Carrying forward Marc's r+.
Attachment #391188 - Attachment is obsolete: true
Attachment #391314 - Flags: review+
(Assignee)

Comment 13

9 years ago
tip:

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

3.4:

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

3.2.4:

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

3.0.8:

Checking in docs/xml/installation.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/Attic/installation.xml,v  <--  installation.xml
new revision: 1.136.2.18; previous revision: 1.136.2.17
done
Status: ASSIGNED → RESOLVED
Last Resolved: 9 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.