From 483ea809e12217f892b8c67169f009eb4137dd1d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Chapeaux?=
Date: Sat, 14 Jul 2001 15:07:47 +0000
Subject: [PATCH] Added a requirement section & rewritten the entry about the
use of advanced authentification
---
Documentation.html | 261 ++++++++++++++++++++++++++++-----------------
1 file changed, 161 insertions(+), 100 deletions(-)
diff --git a/Documentation.html b/Documentation.html
index 3c3911da8..07464bd66 100755
--- a/Documentation.html
+++ b/Documentation.html
@@ -91,16 +91,52 @@
+
+
+
+
+ Top -
+ Requirements -
+ Introduction -
+ Installation -
+ Configuration -
+ FAQ -
+ Developers -
+ Credits
+
+
+
+Requirements
+
+
+ -
+ phpMyAdmin widely uses the 'str_replace()' php function that was added
+ in PHP 3.0.6, but was buggy up until PHP 3.0.8.
+ Then you should not run this script with
+ PHP3 < 3.0.8.
+ PHP also needs to be compiled with mysql
+ and PRCE support;
+
+ -
+ MySQL (tested with 3.21.x, 3.22.x and 3.23.x);
+
+ -
+ a web-browser (doh!).
+
+
+
+
- Top -
- Introduction -
- Installation -
- Configuration -
- FAQ -
- Developers -
+ Top -
+ Requirements -
+ Introduction -
+ Installation -
+ Configuration -
+ FAQ -
+ Developers -
Credits
@@ -133,7 +169,7 @@
(*) |
phpMyAdmin can compress (GZip format - RFC 1952) dumps and CSV exports
- if you use PHP4>=4.0.4 with Zlib support (--with-zlib)
+ if you use PHP>=4.0.4 with Zlib support (--with-zlib)
|
@@ -143,12 +179,13 @@
- Top -
- Introduction -
- Installation -
- Configuration -
- FAQ -
- Developers -
+ Top -
+ Requirements -
+ Introduction -
+ Installation -
+ Configuration -
+ FAQ -
+ Developers -
Credits
@@ -165,7 +202,8 @@
values.
It is recommended that you protect the directory in which
you installed phpMyAdmin (unless it's on a closed intranet),
- for example with HTTP-AUTH (in a .htaccess file).
+ for example with HTTP-AUTH (in a .htaccess file). See the
+ FAQ section for additional information.
Open the file
<www.your-host.com>/<your-install-dir>/index.php3
in your browser. phpMyAdmin should now display a welcome screen
@@ -174,7 +212,8 @@
Installation notes:
- - Be sure to protect the phpMyAdmin-directory. By default, it is not
+
-
+ Be sure to protect the phpMyAdmin-directory. By default, it is not
protected in any way! It shouldn't be readable by anyone and
especially not by search-engines. Although I've added a "nofollow"
directive on every page, there may be search-engines that don't
@@ -183,11 +222,14 @@
You can get an overview of Apache's authentification methods at:
http://www.apacheweek.com/features/userauth
- - If you don't use the extension ".php3" for your scripts, you can use
+
+ -
+ If you don't use the extension ".php3" for your scripts, you can use
the bundled script extchg.sh to modify phpMyAdmin (or any other
script) to work with a different extension. Beware though, that
currently changing the extension from .html to something other won't
- work (it'd change all "string".htmlspecialchars() constructs).
+ work (it'd change all "string".htmlspecialchars() constructs).
+
Upgrading from an older version:
@@ -200,12 +242,13 @@
- Top -
- Introduction -
- Installation -
- Configuration -
- FAQ -
- Developers -
+ Top -
+ Requirements -
+ Introduction -
+ Installation -
+ Configuration -
+ FAQ -
+ Developers -
Credits
@@ -216,12 +259,12 @@
- $cfgServers array
-
- Since version 1.4.2, phpMyAdmin supports the adminstration of multiple
+ Since version 1.4.2, phpMyAdmin supports the administration of multiple
MySQL-server.
Therefore, a $cfgServers-array has been added which contains the login
- information for the different servers. $cfgServers[1]['host'] contains
- the hostname of the first server, $cfgServers[2]['host'] the hostname
- of the second server, etc.
+ information for the different servers. $cfgServers[1]['host']
+ contains the hostname of the first server,
+ $cfgServers[2]['host'] the hostname of the second server, etc.
If you have only one server to administer, simply leave free the
hostname of the other $cfgServer-entries.
@@ -244,10 +287,12 @@
-
Whether basic or advanced authentication should be used for this
server.
- Basic authentication ($adv_auth = false) is the plain old way:
- username and password are stored in config.inc.php3.
- Advanced authentication $adv_auth = true) as introduced in 1.3.0
- allows you to log in as any valid MySQL user via HTTP-Auth.
+ Basic authentication ($adv_auth = false) is the
+ plain old way: username and password are stored in
+ config.inc.php3.
+ Advanced authentication ($adv_auth = true) as
+ introduced in 1.3.0 allows you to log in as any valid MySQL user via
+ HTTP-Auth.
Please note that this authentication mode is
only supported with PHP running as an Apache
module, and not with cgi.
@@ -273,7 +318,10 @@
All you have to provide in config.inc is a standard user which can
connect to MySQL and read the mysql user/db table
- (see $cfgServers[n]['stduser']).
+ (see $cfgServers[n]['stduser']).
+
+
+ See also the FAQ section for more information about security.
@@ -339,17 +387,17 @@
-
- then complete the two variables $cfgServers[n]['bookmarkdb']
- and $cfgServers[n]['bookmarktable'] so phpMyAdmin will be able
- to find the bookmark table.
+ then complete the two variables
+ $cfgServers[n]['bookmarkdb'] and
+ $cfgServers[n]['bookmarktable'] so phpMyAdmin will be
+ able to find the bookmark table.
-
-
- For reasons of security, if you want to use bookmark feature and
- advenced authentification, you must configure a different cfgServers
- section for each user.
-
-
+
+
+ For security reasons, if you want to use the bookmark feature with
+ advanced authentification, you must configure a different
+ $cfgServers section for each user.
+
- $cfgServerDefault integer
@@ -358,8 +406,8 @@
$cfgServerDefault to any one of them to autoconnect to that server when
phpMyAdmin is started, or set it to 0 to be given a list of servers
without logging in.
- If you have only one server configured, $cfgServerDefault MUST be set
- to that server.
+ If you have only one server configured, $cfgServerDefault MUST
+ be set to that server.
@@ -421,17 +469,18 @@
- - $cfgOrder string ["DESC"|"ASC"]
+ - $cfgOrder string ["DESC"|"ASC"]
-
- Defines whether fields are displayed in ascending ("ASC") order or in
- descending ("DESC") order when you click on the field-name.
+ Defines whether fields are displayed in ascending ("ASC")
+ order or in descending ("DESC") order when you click on the
+ field-name.
- $cfgShowBlob boolean
-
- Defines whether BLOB fields are shown when browsing a table's content
- or not.
+ Defines whether BLOB fields are shown when browsing a table's
+ content or not.
@@ -495,12 +544,13 @@
- Top -
- Introduction -
- Installation -
- Configuration -
- FAQ -
- Developers -
+ Top -
+ Requirements -
+ Introduction -
+ Installation -
+ Configuration -
+ FAQ -
+ Developers -
Credits
@@ -515,8 +565,8 @@
Common errors include:
- - Using VARCHAR without a size argument
- - Using TEXT or BLOB with a size argument
+ - Using VARCHAR without a size argument
+ - Using TEXT or BLOB with a size argument
Also, look at the syntax chapter in the MySQL manual to confirm that your
@@ -558,18 +608,10 @@
host information in the config.inc.php file using the format
'host_name:socket_name'.
For example:
- $cfgServers[n]['host'] = 'localhost:/tmp/mysql.sock';
+ $cfgServers[n]['host'] = 'localhost:/tmp/mysql.sock';
-
- I cannot edit the content of a table, even if the README says this is a
- feature of phpMyAdmin.
-
- phpMyAdmin allows only editing of a table's content if the table contains
- a primary or unique key.
-
-
phpMyAdmin always gives "Access denied" when using advanced
authentification.
@@ -578,8 +620,8 @@
-
- $stduser/$stdpassword is wrong. Try to turn off $adv_auth and use this
- username and password to connect to MySQL.
+ $stduser/$stdpassword is wrong. Try to turn off $adv_auth and
+ use this username and password to connect to MySQL.
-
The username/password your specify in the login-dialog is wrong. Try
@@ -631,10 +673,25 @@
If you're running a server which cannot be accessed by other people, it's
sufficient to use the directory protection bundled with your webserver
(with Apache you can use .htaccess files, for example).
- If other people have telnet access to your server, it's not a good idea to
- store the MySQL password in clear text in your config.inc.php3 file.
- You should use phpMyAdmin's advanced authentification feature in this case.
+ If other people have telnet access to your server,
+ you should use phpMyAdmin's advanced authentification feature.
+
+ Suggestions:
+
+ -
+ Your config.inc.php3 file should be chmod 660.
+
+ -
+ All your phpMyAdmin files should be chown phpmy.apache, where phpmy
+ is a user whose password is only known to you, and apache is the
+ group under which Apache runs.
+
+ -
+ You should use PHP safe mode, to protect from other users that try
+ to include your config.inc.php3 in their scripts.
+
+
How can I insert a null value into my table?
@@ -657,20 +714,21 @@
-
- Select all entries from the mysql.user table where the
+ Select all entries from the mysql.user table where the
username/password matches the challenging user. If no rows are
returned, the authentication has failed. Otherwise, phpMyAdmin
continues with step 2.
-
- If the user's global Select_Priv is "N" (ie the user is not
- allowed to access all databases), phpMyAdmin searches the
- mysql.db table for entries with Select_Priv = "Y" belonging
- to the user. If no entries are found, the authentication has failed.
- Otherwise, phpMyAdmin shows all databases the user is allowed to view.
+ If the user's global Select_Priv is "N" (ie the user
+ is not allowed to access all databases), phpMyAdmin searches the
+ mysql.db table for entries with
+ Select_Priv = "Y" belonging to the user.
+ If no entries are found, the authentication has failed. Otherwise,
+ phpMyAdmin shows all databases the user is allowed to view.
- If the user's global Select_Priv is "Y", all databases in the
- system are shown.
+ If the user's global Select_Priv is "Y",
+ all databases in the system are shown.
@@ -694,7 +752,7 @@
This feature is based on gzencode() to be more independent of the platform
(Unix/Windows, Safe Mode or not, and so on).
- So, you must have PHP4 >= 4.0.4 and Zlib support (--with-zlib).
+ So, you must have PHP4 >= 4.0.4 and Zlib support (--with-zlib).
@@ -718,12 +776,13 @@
- Top -
- Introduction -
- Installation -
- Configuration -
- FAQ -
- Developers -
+ Top -
+ Requirements -
+ Introduction -
+ Installation -
+ Configuration -
+ FAQ -
+ Developers -
Credits
@@ -807,12 +866,13 @@
- Top -
- Introduction -
- Installation -
- Configuration -
- FAQ -
- Developers -
+ Top -
+ Requirements -
+ Introduction -
+ Installation -
+ Configuration -
+ FAQ -
+ Developers -
Credits
@@ -838,8 +898,8 @@ CREDITS, in chronological order
[lc] - Loïc Chapeaux <lolo@phpHeaven.net>
* rewrote and optimized javascript, DHTML and DOM stuff
- * started to rewrite the scripts so they are XHTML1.0, CSS2 compliant
- and fit the PEAR coding standards
+ * started to rewrite the scripts so they fit the PEAR coding standards
+ and generate XHTML1.0 and CSS2 compliant codes
* improved the language detection system
* bugfixes
@@ -915,12 +975,13 @@ Original Credits of Version 2.1.0
- Top -
- Introduction -
- Installation -
- Configuration -
- FAQ -
- Developers -
+ Top -
+ Requirements -
+ Introduction -
+ Installation -
+ Configuration -
+ FAQ -
+ Developers -
Credits