nettika/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated

Browse Source
This commit is contained in:
Loïc Chapeaux
2001-10-19 14:43:21 +00:00
parent a7abeeac50
commit 29d99afcaa
1 changed files with 132 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

191
Documentation.txt
View File

@@ -1,16 +1,16 @@
phpMyAdmin 2.2.0 Documentation phpMyAdmin 2.2.1-rc1 Documentation
* [1]Official phpMyAdmin project homepage * [1]Official phpMyAdmin project homepage [
http://www.phpwizard.net/projects/phpMyAdmin/ http://www.phpwizard.net/projects/phpMyAdmin/ ]
* [2]Sourceforge phpMyAdmin download page * [2]Sourceforge phpMyAdmin download page [
http://phpmyadmin.sourceforge.net/ http://phpmyadmin.sourceforge.net/ ]
* Local documents: * Local documents:
+ Version history: [3]ChangeLog + Version history: [3]ChangeLog
+ General notes: [4]README + General notes: [4]README
+ License: [5]LICENSE + License: [5]LICENSE
* Documentation version: * Documentation version: $Id: Documentation.html,v 1.80 2001/10/19
$Id$ 14:05:30 loic1 Exp $
______________________________________________________________________ ______________________________________________________________________
Requirements Requirements
@@ -41,13 +41,22 @@ Introduction
* administer multiple servers and single databases * administer multiple servers and single databases
* communicate in more than 20 different languages * communicate in more than 20 different languages
(*) phpMyAdmin can compress (GZip format -RFC 1952- or Bzip2) dumps (*) phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats)
and CSV exports if you use PHP4 >= 4.0.4 with Zlib support dumps and CSV exports if you use PHP4 >= 4.0.4 with Zlib support
(--with-zlib) and/or Bzip2 support (--with-bz2). (--with-zlib) and/or Bzip2 support (--with-bz2).
______________________________________________________________________ ______________________________________________________________________
Installation Installation
NOTE: phpMyAdmin does not apply any special security methods to the
MySQL database server. It is still the sysadmin's job to grant
permissions on the MySQL databases properly.
Warning for Mac users: php seems not to like Mac end of lines
character ("\r") and Stuffit unstuffs with Mac formats, of course.
So you'll have to resave as in Bbedit to unix style ALL phpMyAdmin
scripts before uploading them to your server.
Quick Install: Quick Install:
1. Untar or unzip the distribution (be sure to unzip the 1. Untar or unzip the distribution (be sure to unzip the
subdirectories): tar xzvf phpMyAdmin_x.x.x.tar.gz subdirectories): tar xzvf phpMyAdmin_x.x.x.tar.gz
@@ -73,6 +82,11 @@ Installation
Configuration Configuration
Warning for Mac users: php seems not to like Mac end of lines
character ("\r"). So ensure you choose the option that allows to use
the *nix end of line character ("\n") in your text editor before
registering a script you have modified.
All configurable data is placed in config.inc.php3. All configurable data is placed in config.inc.php3.
$cfgPmaAbsoluteUri string $cfgPmaAbsoluteUri string
@@ -128,6 +142,10 @@ Configuration
All you have to provide in config.inc is a standard user which 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 can connect to MySQL and read the mysql user/db table (see
$cfgServers[n]['stduser']). $cfgServers[n]['stduser']).
Please also note that if you try a phpMyAdmin login with this
stduser, you could get some errors, depending on the exact
privileges you gave to this stduser. phpMyAdmin does not
support a direct login with the the stduser.
See also the FAQ section for more information about security. See also the FAQ section for more information about security.
$cfgServers[n]['stduser'] string $cfgServers[n]['stduser'] string
@@ -146,6 +164,10 @@ Configuration
$cfgServers[n]['only_db'] string or array $cfgServers[n]['only_db'] string or array
If set to a(an array of) database name(s), only this(these) If set to a(an array of) database name(s), only this(these)
database(s) will be shown to the user. database(s) will be shown to the user.
Warning: this setting does not replace the privileges rules of
the MySQL database server. If set, it just means only these
databases will be displayed but not at all other databases
can't be used.
$cfgServers[n]['verbose'] string $cfgServers[n]['verbose'] string
Only useful when using phpMyAdmin with multiple server entries. Only useful when using phpMyAdmin with multiple server entries.
@@ -185,21 +207,21 @@ Configuration
If you have only one server configured, $cfgServerDefault MUST If you have only one server configured, $cfgServerDefault MUST
be set to that server. be set to that server.
$cfgConfirm boolean $cfgOBGzip boolean
Whether a warning ("Are your really sure..") should be Defines whether to use gzip output buffering for increased
displayed when you're about to loose data. speed in HTTP transfers.
$cfgPersistentConnections boolean $cfgPersistentConnections boolean
Whether persistent connections should be used or not Whether persistent connections should be used or not
(mysql_connect or mysql_pconnect). (mysql_connect or mysql_pconnect).
$cfgShowBlob boolean $cfgSkipLockedTables boolean
Defines whether BLOB fields are shown when browsing a table's Mark used tables and make it possible to show databases with
content or not. locked tables (since 3.23.30).
$cfgProtectBlob boolean $cfgShowSQL boolean
Defines whether BLOB fields are protected from edition when Defines whether sql-queries generated by phpMyAdmin should be
browsing a table's content or not. displayed or not.
$cfgAllowUserDropDatabase boolean $cfgAllowUserDropDatabase boolean
Defines whether standard users (non administrator) are allowed Defines whether standard users (non administrator) are allowed
@@ -208,13 +230,28 @@ Configuration
mydatabase" will be rejected. Quite practical for ISP's with mydatabase" will be rejected. Quite practical for ISP's with
many customers. many customers.
$cfgShowSQL boolean $cfgConfirm boolean
Defines whether sql-queries generated by phpMyAdmin should be Whether a warning ("Are your really sure..") should be
displayed or not. displayed when you're about to loose data.
$cfgSkipLockedTables boolean $cfgShowTooltip boolean
Mark used tables and make it possible to show databases with Defines whether to display table comment as tooltip in left
locked tables (since 3.23.30). frame or not.
$cfgShowStats boolean
Defines whether to display space usage and statistics about
databases and tables or not.
Note that statistics requires at least MySQL 3.23.3 and that,
at this date, MySQL doesn't return such information for
Berkeley DB tables.
$cfgShowBlob boolean
Defines whether BLOB fields are shown when browsing a table's
content or not.
$cfgShowAll boolean
Defines whether an user should be displayed a "show all
(records)" button in browse mode or not.
$cfgMaxRows integer $cfgMaxRows integer
Number of rows displayed when browsing a resultset. If the Number of rows displayed when browsing a resultset. If the
@@ -227,14 +264,19 @@ Configuration
descending order for fields of type TIME, DATE, DATETIME & descending order for fields of type TIME, DATE, DATETIME &
TIMESTAMP, ascending order else- by default. TIMESTAMP, ascending order else- by default.
$cfgOBGzip boolean $cfgProtectBinary boolean
Defines whether to use gzip output buffering for increased Defines whether BLOB or BINARY fields are protected from
speed in HTTP transfers. edition when browsing a table's content or not. Valid values
are:
- FALSE to allow edition of all fields;
- blob to allow edition of all fields except BLOBS;
- all to disallow edition of all BINARY or BLOB fields.
$cfgZipDump boolean
$cfgGZipDump boolean $cfgGZipDump boolean
$cfgBZipDump boolean $cfgBZipDump boolean
Defines whether to allow the use of gzip/bzip compression when Defines whether to allow the use of zip/gzip/bzip compression
creating a dump file or not. when creating a dump file or not.
$cfgManualBase string $cfgManualBase string
If set to an URL which points to the MySQL documentation, If set to an URL which points to the MySQL documentation,
@@ -250,6 +292,10 @@ Configuration
Force: always use this language (must be defined in the Force: always use this language (must be defined in the
select_lang.inc.php3 script). select_lang.inc.php3 script).
$cfgLeftBgColor string [HTML color] $cfgRightBgColor string [HTML
color]
The background colors (HTML) used for both the frames.
$cfgBorder integer $cfgBorder integer
The size of a table's border. The size of a table's border.
@@ -267,8 +313,9 @@ Configuration
Number of columns and rows for the textareas. Number of columns and rows for the textareas.
$cfgLimitChars integer $cfgLimitChars integer
Maximal number of Chars showed in a TEXT field on browse view. Maximal number of Chars showed in a TEXT OR a BLOB field on
Can be turned off by a toggle button on the browse page. browse view. Can be turned off by a toggle button on the browse
page.
$cfgModifyDeleteAtLeft boolean $cfgModifyDeleteAtLeft boolean
$cfgModifyDeleteAtRight boolean $cfgModifyDeleteAtRight boolean
@@ -294,10 +341,19 @@ Configuration
FAQ - Frequently Asked Questions FAQ - Frequently Asked Questions
I'm running php 4+ and my server is crashing each time a specific
action is required or phpMyAdmin send a blank page to my browser, what
can I do?
There is some known php bugs with output buffering and compression.
Try to set the $cfgOBGzip directive to FALSE in your config.inc.php or
.php3 file and the zlib.output_compression directive to Off in your
php configuration file.
The error message "Warning: Cannot add header information - headers The error message "Warning: Cannot add header information - headers
already sent by ..." is displayed, what's the problem? already sent by ..." is displayed, what's the problem?
Look at the end of your config.inc.php or .php3 file, there must be no Edit your config.inc.php or .php3 file and ensure there is nothing (ie
blank lines or spaces after the ?>. no blank lines, no spaces, no characters...) neither before the <?php
tag at the beginning, neither after the ?> tag at the end.
I can't insert new rows into a table - MySQL brings up a SQL-error. I can't insert new rows into a table - MySQL brings up a SQL-error.
Examine the SQL error with care. I've found that many programmers Examine the SQL error with care. I've found that many programmers
@@ -332,6 +388,9 @@ FAQ - Frequently Asked Questions
config.inc.php3. config.inc.php3.
For example: $cfgServers[n]['socket'] = '/tmp/mysql.sock'; For example: $cfgServers[n]['socket'] = '/tmp/mysql.sock';
Have also a look at the [48]corresponding section of the MySQL
documentation.
phpMyAdmin always gives "Access denied" when using advanced phpMyAdmin always gives "Access denied" when using advanced
authentication. authentication.
This could happen for some reasons: This could happen for some reasons:
@@ -365,11 +424,11 @@ FAQ - Frequently Asked Questions
[This will create a new sub-directory named phpMyAdmin] [This will create a new sub-directory named phpMyAdmin]
* add your stuff * add your stuff
* put the modified files (tar'ed and gzip'ed) inside the patch * put the modified files (tar'ed and gzip'ed) inside the patch
tracker of the [48]phpMyAdmin SourceForge account. tracker of the [49]phpMyAdmin SourceForge account.
Write access to the CVS tree is granted only to experienced developers Write access to the CVS tree is granted only to experienced developers
who have already contributed something useful to phpMyAdmin. who have already contributed something useful to phpMyAdmin.
Also, have a look at the [49]Developers section. Also, have a look at the [50]Developers section.
What's the preferred way of making phpMyAdmin secure against evil What's the preferred way of making phpMyAdmin secure against evil
access? access?
@@ -449,11 +508,11 @@ FAQ - Frequently Asked Questions
7.0 and you updated your php rpm to php-4.0.4pl1-3.i386.rpm, didn't 7.0 and you updated your php rpm to php-4.0.4pl1-3.i386.rpm, didn't
you? you?
So the problem is that this package has a serious bug that was So the problem is that this package has a serious bug that was
corrected ages ago in php (2001-01-28: see [50]php's bug tracking corrected ages ago in php (2001-01-28: see [51]php's bug tracking
system for more details). The problem is that the bugged package is system for more details). The problem is that the bugged package is
still available though it was corrected (see [51]redhat's bugzilla for still available though it was corrected (see [52]redhat's bugzilla for
more details). more details).
So please download [52]the fixed package and the problem should go So please download [53]the fixed package and the problem should go
away. away.
And that fixes the \r\n problem with file uploads! And that fixes the \r\n problem with file uploads!
@@ -466,16 +525,23 @@ FAQ - Frequently Asked Questions
I get an out of memory error, and my controls are non-functional, when I get an out of memory error, and my controls are non-functional, when
trying to create a table with more than 14 fields. trying to create a table with more than 14 fields.
This is a problem under investigation. Seems to be OS and/or browser- We could reproduce this problem only under Win98/98SE. Testing under
dependent. For now, create a smaller number of fields, then come back WinNT4 or Win2K, we could easily create more than 60 fields.
A workaround is to create a smaller number of fields, then come back
to your table properties and add the other fields. to your table properties and add the other fields.
I have found a bug. How do I inform developpers? I get errors about not being able to include a file in /lang
Check php.ini, or ask your sysadmin to check it. The include_path must
contain "." somewhere in it, and open_basedir, if used, must contain
"." and "./lang" to allow normal operation of phpMyAdmin.
I have found a bug. How do I inform developers?
Our Bug Tracker is located at Our Bug Tracker is located at
[53]http://sourceforge.net/projects/phpmyadmin under the Bugs section. [54]http://sourceforge.net/projects/phpmyadmin/ under the Bugs
section.
But please first discuss your bug with other users: But please first discuss your bug with other users:
[54]http://sourceforge.net/projects/phpmyadmin (and choose Forums) [55]http://sourceforge.net/projects/phpmyadmin/ (and choose Forums)
[55]http://www.phpwizard.net/projects/phpMyAdmin (and choose Support [56]http://www.phpwizard.net/projects/phpMyAdmin/ (and choose Support
Forum) Forum)
______________________________________________________________________ ______________________________________________________________________
@@ -487,16 +553,18 @@ Developers Information
If you're planning to contribute source, please read the following If you're planning to contribute source, please read the following
information: information:
* All files include header.inc.php3 (layout), lib.inc.php3 (common * All files include header.inc.php3 (layout),
functions) and config.inc.php3. libraries/common.lib.php3 (common functions) and config.inc.php3.
All configuration data belongs in config.inc.php3. Please keep it All configuration data belongs in config.inc.php3. Please keep it
free from other code. free from other code.
Commonly used functions should be added to lib.inc.php3. Commonly used functions should be added to libraries/lib.inc.php3
and more specific ones may be added within a library stored into
the libraries sub-directory.
* Obviously, you're free to use whatever coding style you want. But * Obviously, you're free to use whatever coding style you want. But
please try to keep your code as simple as possible: beginners are please try to keep your code as simple as possible: beginners are
using phpMyAdmin as an example application. using phpMyAdmin as an example application.
By the way, we're currently updating all the scripts so they will By the way, we're currently updating all the scripts so they will
be XHTML1.0 and CSS2 compliant on one hand, they will fit [64]PEAR be XHTML1.0 and CSS2 compliant on one hand, they will fit [65]PEAR
coding standards on the other hand. Please pay attention to this. coding standards on the other hand. Please pay attention to this.
* Please try to keep up the file-naming conventions. Table-related * Please try to keep up the file-naming conventions. Table-related
stuff goes to tbl_*.php3, db-related code to db_*.php3 and so on. stuff goes to tbl_*.php3, db-related code to db_*.php3 and so on.
@@ -519,7 +587,7 @@ Developers Information
* add your stuff * add your stuff
* put the modified files (tar'ed and gzip'ed) inside the patch * put the modified files (tar'ed and gzip'ed) inside the patch
tracker of the phpMyAdmin SourceForge account tracker of the phpMyAdmin SourceForge account
([65]http://sourceforge.net/projects/phpmyadmin/) ([66]http://sourceforge.net/projects/phpmyadmin/)
Write access to the CVS tree is granted only to developers who have Write access to the CVS tree is granted only to developers who have
already contributed something useful to phpMyAdmin. If you're already contributed something useful to phpMyAdmin. If you're
@@ -639,21 +707,22 @@ Original Credits of Version 2.1.0
and or just some feedback. and or just some feedback.
______________________________________________________________________ ______________________________________________________________________
[82]Valid XHTML 1.0! [83]Valid CSS! [83]Valid XHTML 1.0! [84]Valid CSS!
References References
1. http://www.phpwizard.net/projects/phpMyAdmin/ 1. http://www.phpwizard.net/projects/phpMyAdmin/
2. http://phpmyadmin.sourceforge.net/ 2. http://phpmyadmin.sourceforge.net/
47. http://www.phpwizard.net/phorum/list.php?f=1 47. http://www.phpwizard.net/phorum/list.php?f=1
48. https://sourceforge.net/projects/phpmyadmin/ 48. http://www.mysql.com/doc/C/a/Can_not_connect_to_server.html
50. http://www.php.net/bugs.php?id=8966 49. https://sourceforge.net/projects/phpmyadmin/
51. http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=24933 51. http://www.php.net/bugs.php?id=8966
52. http://people.redhat.com/nalin/test/php-4.0.4pl1-7.i386.rpm 52. http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=24933
53. http://sourceforge.net/projects/phpmyadmin 53. http://people.redhat.com/nalin/test/php-4.0.4pl1-7.i386.rpm
54. http://sourceforge.net/projects/phpmyadmin 54. http://sourceforge.net/projects/phpmyadmin/
55. http://www.phpwizard.net/projects/phpMyAdmin 55. http://sourceforge.net/projects/phpmyadmin/
64. http://pear.php.net/ 56. http://www.phpwizard.net/projects/phpMyAdmin/
65. http://sourceforge.net/projects/phpmyadmin/ 65. http://pear.php.net/
82. http://validator.w3.org/check/referer 66. http://sourceforge.net/projects/phpmyadmin/
83. http://jigsaw.w3.org/css-validator/ 83. http://validator.w3.org/check/referer
84. http://jigsaw.w3.org/css-validator/