From 761a2d64a3dea5ed38e07798a2d303a6f12c031a Mon Sep 17 00:00:00 2001 From: Damien Regad Date: Fri, 11 May 2012 15:55:12 +0200 Subject: [PATCH] Documentation update: revised Admin Guide / Installation --- docbook/adminguide/en/installation.sgml | 101 +++++++++++++----------- 1 file changed, 55 insertions(+), 46 deletions(-) diff --git a/docbook/adminguide/en/installation.sgml b/docbook/adminguide/en/installation.sgml index 59c1b73126..fa11303bca 100644 --- a/docbook/adminguide/en/installation.sgml +++ b/docbook/adminguide/en/installation.sgml @@ -33,7 +33,7 @@ - Tranfer files + Transfer files Uncompress files @@ -62,30 +62,35 @@ - First, transfer the file to your webserver using whatever - method you likebest (ftp, scp, etc). You will need to telnet/ssh - into the server machine forthe next steps. + First, transfer the downloaded file to your webserver + using whatever method you like best (ftp, scp, etc). You + will need to telnet/ssh into the server machine for the + next steps. Next, untar/gunzip it to the directory that you want.The usual command is (1 step): - tar zxvf <filename.tar.gz> + tar -xzf filename.tar.gz OR (2 steps): - gunzip <filename.tar.gz> tar xvf <filename.tar> + +gunzip filename.tar.gz +tar -xf filename.tar + Winzip, Stuffit, and other programs should also be able to - handledecompression of the archive.At this point you may want to + handle decompression of the archive. At this point you may want to rename the directory to something simpler like 'mantisbt'. You will use the mv command to rename a directory (Windows users substitute the "ren" command or use explorer). - mv <directoryname> mantisbt + mv directoryname mantisbt - Next we will create the necessary database tables and a - basic configurationfile.From your web server, access - http://yoursite/mantisbt/admin/install.php. This page will walk through - the following steps: + Next we will create the necessary database tables and a + basic configuration file. From your web browser, access + + http://yoursite/mantisbt/admin/install.php + This page will walk you through the following steps: @@ -93,29 +98,28 @@ prompt for the database type and location, and a database - user/passwordpair. For installion, an administrative user/password - pair can also be provided. The operating user requires SELECT, - INSERT, UPDATE, and DELETE privileges. For installation, INDEX, - CREATE, ALTER, and DROP privileges arealso required. + user/password pair. For installation, a high-privileged account + can also be provided. If unspecified, the database user will be + used. + The database user requires SELECT, INSERT, UPDATE, and DELETE privileges. + For installation, additional INDEX, CREATE, ALTER, and DROP privileges + are also required. create the database and tables. - WARNING: A DEFAULT ADMINISTRATOR level account is created. The - account name and password are administrator / root. - Use this when you first login to MantisBT. Immediately go to Manage - and create at least one administrator level account. Immediately - after that DISABLE or DELETE the administrator account. You can - recreate it but you should delete the account to prevent the - cookie_string from being used to trick the package. It would be - even better to rename the account or delete it permanently. - REMEMBER: After setting up the package, REMOVE the default - administrator account. + WARNING: a default Administrator user account + is created at this stage, to allow the initial login + and setup of MantisBT. + The id and password are administrator / root. + You should immediately go to Manage Users, + and create another administrator level account, + then either DISABLE or DELETE the default one. write a basic "config_inc.php file to define the - database. + database connection parameters. @@ -129,28 +133,32 @@ The next part involves configuring the installation to - work with yourspecific setup.Open the file in an editor and add - anyother values that are required. There aremany more that you can - use to customize your MantisBT installation. - See Configuration for - in depth explanations.The file will overwrite the default values - with those necessary for setup.You can load up admin/check.php to - see if you set things up correctly. + work with your specific setup. There are many options that + you can set to customize your MantisBT installation. See + Configuration for + in depth explanations. + + Open the file config_inc.php in an + editor and add any values that are required. These will + override the default values. + + You can load up admin/check.php to validate if you set + things up correctly. NOTE: check.php sometimes reports the value of - register_globalsincorrectly. - Create a page with this line in it: <? phpinfo() ?>, save - itwith a .php extension and load it up in your web browser. It - will, among amultitude of other things, have the correct value of - register_globals that youare using. + register_globals incorrectly. To + confirm the correct value, + Create a page with this line in it: + <?php phpinfo(); ?> + save it with a .php extension and load it up in your web browser. - MantisBT now uses only .php files.If your webserver is - configured for other extensions (.PHP3, .PHTML) then youwill have - to have the administrator add support for .PHP files. This shouldbe - a trivial modification.Documentation can be found at: - http://www.php.net/manual/en/installation.php + MantisBT uses only .php files. If your webserver is + configured for other extensions (.PHP3, .PHTML) then you will have + to have the administrator add support for .PHP files. This should be + a trivial modification. Further details can be found in the + PHP documentation @@ -158,11 +166,12 @@ Login to your bugtracker and go to the manage section. Click on the projects link. You will need to ADD a new project. Then EDIT the new project and remember to ADD at least one category. - Otherwise you won't be able to add any issues. That should be - it. You're off and running. + Otherwise you won't be able to add any issues. + That should be it. You're off and running. +