diff --git a/webtools/bugzilla/docs/xml/installation.xml b/webtools/bugzilla/docs/xml/installation.xml index 14665de9d63..87e39ec7fee 100644 --- a/webtools/bugzilla/docs/xml/installation.xml +++ b/webtools/bugzilla/docs/xml/installation.xml @@ -1,5 +1,5 @@ - + Installing Bugzilla @@ -517,11 +517,13 @@ Configuration - Poorly-configured MySQL and Bugzilla installations have - given attackers full access to systems in the past. Please take the - security parts of these guidelines seriously, even for Bugzilla - machines hidden away behind your firewall. Be certain to read - for some important security tips. + + Poorly-configured MySQL and Bugzilla installations have + given attackers full access to systems in the past. Please take the + security parts of these guidelines seriously, even for Bugzilla + machines hidden away behind your firewall. Be certain to read + for some important security tips. +
@@ -530,16 +532,16 @@ Once you run checksetup.pl with all the correct modules installed, it displays a message about, and write out a - file called, - localconfig. This file contains the default - settings for a number of Bugzilla parameters. + file called, localconfig. This file contains + the default settings for a number of Bugzilla parameters. - Load this file in your editor. The only value you - need to change is $db_pass, the password for - the user you will create for your database. - Pick a strong password (for simplicity, it should not contain - single quote characters) and put it here. + + Load this file in your editor. The only value you + need to change is $db_pass, the password for + the user you will create for your database. Pick a strong + password (for simplicity, it should not contain single quote + characters) and put it here. @@ -553,8 +555,8 @@ You may also wish to change the names of the priorities, severities, operating systems and platforms for your installation. However, you can always change these after installation - has finished; if you then re-run - checksetup.pl, the changes will get picked up. + has finished; if you then re-run checksetup.pl, + the changes will get picked up.
@@ -562,30 +564,47 @@ MySQL - MySQL's default configuration is very insecure. - has some good information for - improving your installation's security. + + MySQL's default configuration is very insecure. + has some good information for + improving your installation's security.
Allow large attachments - You need to configure MySQL to accept large packets, if you - want to have attachments larger than 64K. Add the text - below to your - /etc/my.cnf. - There is also a parameter in Bugzilla - for setting the maximum allowable attachment size, (default 1MB). - Bugzilla will only accept attachments up to the lower of these two - sizes. + + By default, MySQL will only accept packets up to 64Kb in size. + If you want to have attachments larger than this, you will need + to modify your /etc/my.cnf as below. - [mysqld] + + If you are using MySQL 4.0 or newer, enter: + + [mysqld] + # Allow packets up to 1M + max_allowed_packet=1M + + + If you are using an older version of MySQL, enter: + + [mysqld] # Allow packets up to 1M set-variable = max_allowed_packet=1M + + + There is also a parameter in Bugzilla called 'maxattachmentsize' + (default = 1000 Kb) that controls the maximum allowable attachment + size. Attachments larger than either the + 'max_allowed_packet' or 'maxattachmentsize' value will not be + accepted by Bugzilla. +
+ +
Allow small words in full-text indexes @@ -616,47 +635,61 @@
Permit attachments table to grow beyond 4GB - By default, MySQL will limit the size of a table - to 4GB. This limit is present even if the underlying filesystem - has no such limit or if you are using RAID. To set a higher - limit, follow these instructions. - Run the MySQL command-line client and - enter: + + + By default, MySQL will limit the size of a table to 4GB. + This limit is present even if the underlying filesystem + has no such limit or if you are using RAID. To set a higher + limit, follow these instructions. + + + + Run the MySQL command-line client and + enter: + mysql> ALTER TABLE attachments AVG_ROW_LENGTH=1000000, MAX_ROWS=20000; - The above command will change the limit to 20GB. Mysql will have - to make a temporary copy of your entire table to do this. Ideally, - you should do this when your attachments table is still small. + + + The above command will change the limit to 20GB. Mysql will have + to make a temporary copy of your entire table to do this. Ideally, + you should do this when your attachments table is still small. +
Add a user to MySQL - You need to add a new MySQL user for - Bugzilla to use. (It's not safe to have Bugzilla use the MySQL root - account.) The following instructions assume the defaults in - localconfig; - if you changed those, you need to modify the - SQL command appropriately. You will need the - $db_pass password you set in - localconfig in - . + + You need to add a new MySQL user for Bugzilla to use. + (It's not safe to have Bugzilla use the MySQL root account.) + The following instructions assume the defaults in + localconfig; if you changed those, + you need to modify the SQL command appropriately. You will + need the $db_pass password you + set in localconfig in + . - We use an SQL GRANT command to create a - bugs - user. This also restricts the - bugs - user to operations within a database called - bugs, and only allows the account to connect from - localhost. - Modify it to reflect your setup if you will be connecting from - another machine or as a different user. + + We use an SQL GRANT command to create + a bugs user. This also restricts the + bugsuser to operations within a database + called bugs, and only allows the account + to connect from localhost. Modify it to + reflect your setup if you will be connecting from another + machine or as a different user. + - Run the mysql command-line client. - If you are using MySQL 4.0 or newer, enter: + + Run the mysql command-line client. + + + + If you are using MySQL 4.0 or newer, enter: + mysql> GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, ALTER, CREATE, LOCK TABLES, @@ -664,11 +697,14 @@ TO bugs@localhost IDENTIFIED BY '$db_pass'; mysql> FLUSH PRIVILEGES; - If you are using an older version of MySQL, - the LOCK TABLES and + + If you are using an older version of MySQL,the + LOCK TABLES and CREATE TEMPORARY TABLES - permissions will be unavailable and should be removed from the permissions - list. In this case, the following command line can be used: + permissions will be unavailable and should be removed from + the permissions list. In this case, the following command + line can be used: + mysql> GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, ALTER, CREATE, DROP,