documentation.txt

一个用PHP编写的

-------------------------------------------------------------------------------
Top  -  Requirements  -  Introduction  -  Installation  -  Setup script  - 
Configuration
Transformations  -  FAQ  -  Developers  -  Credits  -  Translators
-------------------------------------------------------------------------------

phpMyAdmin 2.8.2.1 Documentation

  * SourceForge phpMyAdmin project page   [ http://www.phpmyadmin.net/ ]
  * Local documents:
      + Version history: ChangeLog
      + General notes: README
      + License: LICENSE
  * Documentation version: $Id: Documentation.html,v 2.205.2.21.2.2 2006/08/02
    16:48:53 lem9 Exp $


Requirements

  * PHP
      + You need PHP 4.1.0 or newer, with session support (*)
      + You need GD2 support in PHP to display inline thumbnails of JPEGs
        ("image/jpeg: inline") with their original aspect ratio
      + You need PHP 4.3.0 or newer to use the "text/plain: external"
        MIME-based transformation
  * MySQL 3.23.32 or newer (details);
  * Not really a requirement but a strong suggestion: if you are using the
    "cookie" authentication method, having the mcrypt PHP extension on your web
    server accelerates not only the login phase but every other action that you
    do in phpMyAdmin.
  * Web browser with cookies enabled.


Introduction

phpMyAdmin can manage a whole MySQL server (needs a super-user) as well as a
single database. To accomplish the latter you'll need a properly set up MySQL
user who can read/write only the desired database. It's up to you to look up
the appropriate part in the MySQL manual.
Currently phpMyAdmin can:

  * easily browse through databases and tables
  * create, copy, rename, alter and drop databases
  * create, copy, rename, alter and drop tables
  * do table maintenance
  * add, edit and drop fields
  * execute any SQL-statement, even multiple queries
  * create, alter and drop indexes
  * load text files into tables
  * create (*) and read dumps of tables or databases
  * export (*) data to SQL, CSV, XML, Word, Excel, PDF and Latex formats
  * administer multiple servers
  * manage MySQL users and privileges
  * check server settings and runtime information with configuration hints
  * check referential integrity in MyISAM tables
  * using Query-by-example (QBE), create complex queries automatically
    connecting required tables
  * create PDF graphics of your Database layout
  * search globally in a database or a subset of it
  * transform stored data into any format using a set of predefined functions,
    like displaying BLOB-data as image or download-link
  * support InnoDB tables and foreign keys (see FAQ 3.6)
  * support mysqli, the improved MySQL extension (see FAQ 1.17)
  * communicate in 50 different languages

A word about users:

Many people have difficulty understanding the concept of user management with
regards to phpMyAdmin. When a user logs in to phpMyAdmin, that username and
password are passed directly to MySQL. phpMyAdmin does no account management on
its own (other than allowing one to manipulate the MySQL user account
information); all users must be valid MySQL users.

^1) phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats) dumps and
CSV exports if you use PHP with Zlib support (--with-zlib) and/or Bzip2 support
(--with-bz2). Proper support may also need changes in php.ini.


Installation

NOTE: phpMyAdmin does not apply any special security methods to the MySQL
database server. It is still the system administrator's job to grant
permissions on the MySQL databases properly. phpMyAdmin's "Privileges" page can
be used for this.

Warning for Mac users:if you are on a MacOS version before OS X, StuffIt
unstuffs with Mac formats.
So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts
before uploading them to your server, as PHP seems not to like Mac-style end of
lines character ("\r").

Quick Install

 1. Untar or unzip the distribution (be sure to unzip the subdirectories): tar
    -xzvf phpMyAdmin_x.x.x.tar.gz in your webserver's document root. If you
    don't have direct access to your document root, put the files in a
    directory on your local machine, and, after step 3, transfer the directory
    on your web server using, for example, ftp.
 2. Ensure that all the scripts have the appropriate owner (if PHP is running
    in safe mode, having some scripts with an owner different from the owner of
    other scripts will be a problem). See FAQ 4.2 and FAQ 1.26 for suggestions.
 3. Now you must configure your installation. There are two methods that can be
    used. Traditionally, users have hand-edited a copy of config.inc.php, but
    now a wizard-style setup script is provided for those who prefer a
    graphical installation. Creating a config.inc.php is still a quick way to
    get started and needed for some advanced features.
      + To manually create the file, simply use your text editor to create the
        file config.inc.php in the main (top-level) phpMyAdmin directory (the
        one that contains index.php). phpMyAdmin first loads libraries/
        config.default.php and then overrides those values with anything found
        in config.inc.php. If the default value is okay for a particular
        setting, there is no need to include it in config.inc.php. You'll need
        a few directives to get going, a simple configuration may look like
        this:

        <?php
        $cfg['blowfish_secret'] = 'ba17c1ec07d65003';  // use here a value of your choice

        $i=0;
        $i++;
        $cfg['Servers'][$i]['auth_type']     = 'cookie';
        ?>

        Or, if you prefer to not be prompted every time you log in:

        <?php

        $i=0;
        $i++;
        $cfg['Servers'][$i]['user']          = 'root';
        $cfg['Servers'][$i]['password']      = 'cbb74bc'; // use here your password
        ?>

        For a full explanation of possible configuration values, see the
        Configuration Section of this document.
      + Instead of manually editing config.inc.php, you can use the Setup
        Script. First you must manually create a folder config in the
        phpMyAdmin directory. This is a security measure. On a Linux/Unix
        system you can use the following commands:

        cd phpMyAdmin
        mkdir config                        # create directory for saving
        chmod o+rw config                   # give it world writable permissions

        And to edit an existing configuration, copy it over first:

        cp config.inc.php config/           # copy current configuration for editing
        chmod o+w config/config.inc.php     # give it world writable permissions

        On other platforms, simply create the folder and ensure that your web
        server has read and write access to it. FAQ 1.26 can help with this.

        Next, open scripts/setup.php in your browser. Note that changes are not
        saved to disk until explicitly choose Save from the Configuration area
        of the screen. Normally the script saves the new config.inc.php to the
        config/ directory, but if the webserver does not have the proper
        permissions you may see the error "Cannot load or save configuration."
        Ensure that the config/ directory exists and has the proper permissions
        - or use the Download link to save the config file locally and upload
        (via FTP or some similar means) to the proper location.

        Once the file has been saved, it must be moved out of the config/
        directory and the permissions must be reset, again as a security
        measure:

        mv config/config.inc.php .         # move file to current directory
        chmod o-rw config.inc.php          # remove world read and write permissions

        Now the file is ready to be used. You can choose to review or edit the
        file with your favorite editor, if you prefer to set some advanced
        options which the setup script does not provide.
 4. If you are using the auth_type configuration directive, it is suggested
    that you protect the phpMyAdmin installation directory, for example with
    HTTP?AUTH in a .htaccess file. See the multi?user sub?section of this FAQ
    for additional information, especially FAQ 4.4.
 5. Open the main phpMyAdmin directory in your browser. phpMyAdmin should now
    display a welcome screen and your databases, or a login dialog if using
    HTTP or cookie authentication mode.
 6. You should deny access to the libraries subfolder in your webserver
    configuration. For Apache you can use supplied .htaccess file in that
    folder, for other webservers, you should configure this yourself. Such
    configuration prevents from possible path exposure and cross side scripting
    vulnerabilities that might happen to be found in that code.

Linked-tables infrastructure

For a whole set of new features (bookmarks, comments, SQL-history,
PDF-generation, field contents transformation, etc.) you need to create a set
of special tables. Those tables can be located in your own database, or in a
central database for a multi-user installation (this database would then be
accessed by the controluser, so no other user should have rights to it).

Please look at your scripts/ directory, where you should find a file called
create_tables.sql. (If you are using a Windows server, pay special attention to
FAQ 1.23).

If your MySQL server's version is 4.1.2 or later, please use
create_tables_mysql_4_1_2+.sql instead, for a new installation.

If you already had this infrastructure and upgraded to MySQL 4.1.2 or later,
please use upgrade_tables_mysql_4_1_2+.sql.

You can use your phpMyAdmin to create the tables for you. Please be aware that
you may need special (administrator) privileges to create the database and
tables, and that the script may need some tuning, depending on the database
name.

After having imported the create_tables.sql file, you should specify the table
names in your config.inc.php file. The directives used for that can be found in
the Configuration section. You will also need to have a controluser with the
proper rights to those tables (see section Using authentication modes below).

Upgrading from an older version

Simply copy ./config.inc.php from your previous installation into the newly
unpacked one. Configuration files from very old versions (2.3.0 or older) may
require some tweaking as some options have been changed or removed.

You should not copy libraries/config.default.php over config.inc.php because
the default configuration file is version-specific.

If you have upgraded your MySQL server from a version older than 4.1.2 to
version 4.1.2 or newer and if you use the pmadb/linked table infrastructure,
you should run the SQL script found in scripts/upgrade_tables_mysql_4_1_2+.sql.

Using authentication modes

  * HTTP and cookie authentication modes are recommended in a multi-user
    environment where you want to give users access to their own database and
    don't want them to play around with others.
    Nevertheless be aware that MS Internet Explorer seems to be really buggy
    about cookies, at least till version 6. And PHP 4.1.1 is also a bit buggy
    in this area!
    Even in a single-user environment, you might prefer to use HTTP or cookie
    mode so that your user/password pair are not in clear in the configuration
    file.

  * HTTP and cookie authentication modes are more secure: the MySQL login
    information does not need to be set in the phpMyAdmin configuration file
    (except possibly for the controluser).
    However, keep in mind that the password travels in plain text, unless you
    are using the HTTPS protocol.
    In cookie mode, the password is stored, encrypted with the blowfish
    algorithm, in a temporary cookie.

  * Note: starting with phpMyAdmin 2.6.1, this section is only applicable if
    your MySQL server is older than 4.1.2, or is running with
    --skip-show-database.

    For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that has only
    the SELECT privilege on the mysql.user (all columns except "Password"),
    mysql.db (all columns), mysql.host (all columns) and mysql.tables_priv (all
    columns except "Grantor" & "Timestamp") tables.
    You must specify the details for the controluser in the config.inc.php file