forked from phpmyadmin/phpmyadmin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathDocumentation.txt
1537 lines (1332 loc) · 71.7 KB
/
Documentation.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
phpMyAdmin 2.3.0-dev Documentation
* [1]Sourceforge phpMyAdmin project page [
http://www.phpmyadmin.net/ ]
* Local documents:
+ Version history: [2]ChangeLog
+ General notes: [3]README
+ License: [4]LICENSE
* Documentation version: $Id: Documentation.html,v 1.244 2002/06/02
19:37:54 loic1 Exp $
______________________________________________________________________
[5]Top - [6]Requirements - [7]Introduction - [8]Installation -
[9]Configuration - [10]FAQ - [11]Developers - [12]Credits
______________________________________________________________________
Requirements
* PHP3 or PHP4: 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 support;
* MySQL (tested with 3.21.x, 3.22.x, 3.23.x and 4.0.x);
* a web-browser (doh!).
______________________________________________________________________
[13]Top - [14]Requirements - [15]Introduction - [16]Installation
- [17]Configuration - [18]FAQ - [19]Developers - [20]Credits
______________________________________________________________________
Introduction
phpMyAdmin can manage a whole MySQL-server (needs a super-user) but
also 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:
* create and drop databases
* create, copy, drop and alter tables
* delete, edit and add fields
* execute any SQL-statement, even batch-queries
* manage keys on fields
* load text files into tables
* create (*) and read dumps of tables
* export (*) and import data to CSV values
* administer multiple servers and single databases
* check referential integrity
* create complex Queries automatically connecting required tables
* create PDF graphics of your Database layout
* communicate in more than [21]38 different languages
(*) phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats)
dumps and CSV exports if you use PHP4 >= 4.0.4 with Zlib support
(--with-zlib) and/or Bzip2 support (--with-bz2).
______________________________________________________________________
[22]Top - [23]Requirements - [24]Introduction - [25]Installation
- [26]Configuration - [27]FAQ - [28]Developers - [29]Credits
______________________________________________________________________
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.
Documentation warning: when you see in this document a .php3 file
extension, please transpose to .php if you are using a kit with files
having this extension.
Quick Install:
1. Use a distribution kit with the files having the extension (.php3
or .php) depending on the way your web/PHP server interprets those
extensions.
2. 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.
3. Open the file config.inc.php3 in your favourite editor and change
the values for host, user, password and authentication mode to fit
your environment. Also insert the correct value for
$cfg['PmaAbsoluteUri']. Have a look at [30]Configuration section
for an explanation of all values.
4. It is recommended that you protect the directory in which you
installed phpMyAdmin (unless it's on a closed intranet, or you
wish to use http or cookie authentication), for example with
HTTP-AUTH (in a .htaccess file). See the [31]FAQ section for
additional information.
5. Open the file <www.your-host.com>/<your-install-dir>/index.php3 in
your browser. phpMyAdmin should now display a welcome screen and
your databases, or a login dialog if using http or cookie
authentication mode.
Upgrading from an older version:
* Please do not copy your older config.inc.php3 over the new one: it
may offer new configuration variables, and the new version may
depend on these for normal behavior. It is suggested instead to
insert your site values in the new one.
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!
* Http and cookie authentication modes are secure: the MySQL
password does not need to be set in the phpMyAdmin configuration
file. (except for the "controluser" -see the Configuration
section-).
In cookie mode, we send the password in a temporary cookie, so
most browsers should not store the password in their cookie file.
* 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.tables_priv
(all columns except "Grantor" & "Timestamp") tables.
You must specify the details for the controluser in the
config.inc.php3 file under the $cfg['Servers'][$i]['controluser']&
$cfg['Servers'][$i]['controlpass'] settings.
This example assumes you want to use pma as the controluser and
pmapass as the controlpass:
GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY
'pmapass';
GRANT SELECT (Host, User, Select_priv, Insert_priv, Update_priv,
Delete_priv, Create_priv, Drop_priv, Reload_priv, Shutdown_priv,
Process_priv, File_priv, Grant_priv, References_priv, Index_priv,
Alter_priv) ON mysql.user TO 'pma'@'localhost';
GRANT SELECT ON mysql.db TO 'pma'@'localhost';
GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv) ON
mysql.tables_priv TO 'pma'@'localhost';
... and if you want to use the many new relation and bookmark features:
GRANT SELECT, INSERT, DELETE ON <pma_db> TO 'pma'@'localhost';
(this of course requires you to have a special DB for phpMyAdmin, the contents
will be explained later)
* Then each of the true users should be granted of a set of
privileges on a set of particular databases but shouldn't have any
global privileges. For example, to grant the user real_user with
all privileges on the database user_base:
GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost
IDENTIFIED BY 'real_password';
What the user may now do is controlled entirely by the MySQL user
management system.
With http or cookie auth mode, you don't need to fill the
user/password fields inside the $cfg['Servers'] array.
'http' authentication mode:
* Was called 'advanced' in versions before 2.2.3.
* Introduced in 1.3.0, it uses Basic HTTP authentication method and
allows you to login as any valid MySQL user.
* Is only supported with PHP running as an Apache module, not with
cgi.
'cookie' authentication mode:
* You can use this method as a replacement for the http
authentication (for example, if you're running IIS).
* Obviously, the user must enable cookies in the browser.
* With this mode, the use can truly logout of phpMyAdmin and login
back with the same username.
'config' authentication mode:
* This mode is the less secure one because it requires you to fill
the $cfg['Servers'][$i]['user'] and
$cfg['Servers'][$i]['password'] fields.
But you don't need to setup a "controluser" here: using the
$cfg['Servers'][$i]['only_db'] might be enough.
* In the ISP FAQ section, there is an entry explaining how to
protect your configuration file.
* For additional security in this mode, you may wish to consider the
Host authentication $cfg['Servers'][$i]['AllowDeny']['order'] and
$cfg['Servers'][$i]['AllowDeny']['rules'] configuration
directives.
______________________________________________________________________
[32]Top - [33]Requirements - [34]Introduction - [35]Installation
- [36]Configuration - [37]FAQ - [38]Developers - [39]Credits
______________________________________________________________________
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.
$cfg['PmaAbsoluteUri'] string
Sets here the complete url (with full path) to your phpMyAdmin
version. E.g.
http://www.your_web.net/path_to_your_phpMyAdmin_directory/.
Don't forget the slash at the end of your url. The url must
contain characters that are valid for a url, and on some
servers, the path is case-sensitive.
This setting can be dynamically completed. For example, you can
try to use such a kind of code:
$cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
. $_SERVER['HTTP_HOST']
. (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SER
VER_PORT'] : '')
. substr($_SERVER['PHP_SELF'], 0, strrpos($['PHP_SELF'],
'/')+1);
or
$cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
. $_SERVER['SERVER_NAME']
. (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SER
VER_PORT'] : '')
. substr($_SERVER['SCRIPT_NAME'], 0, strrpos($_SERVER['S
CRIPT_NAME'], '/')+1);
Please note that the $_SERVER array doesn't exist in
PHP < 4.1.0. Try to replace $_SERVER by $HTTP_SERVER_VARS or
$GLOBALS in this case.
$cfg['Servers'] array
Since version 1.4.2, phpMyAdmin supports the administration of
multiple MySQL servers. Therefore, a $cfg['Servers']-array has
been added which contains the login information for the
different servers. The first $cfg['Servers'][$i]['host']
contains the hostname of the first server, the second
$cfg['Servers'][$i]['host'] the hostname of the second server,
etc. If you have only one server to administer, simply leave
free the hostname of the other $cfg['Server']-entries.
$cfg['Servers'][$i]['host'] string
The hostname of your $i-th MySQL-server. E.g. localhost.
$cfg['Servers'][$i]['port'] string
The port-number of your $i-th MySQL-server. Default is 3306
(leave blank).
$cfg['Servers'][$i]['socket'] string
The path to the socket to use. Leave blank for default.
To use the socket feature you must run php 3.0.10 or more.
$cfg['Servers'][$i]['connect_type'] string
What type connection to use with the MySQL server. Your options
are 'socket' & 'tcp'. It defaults to 'tcp' as that is nearly
guarenteed to be available on all MySQL servers, while sockets
are not supported on some platforms.
$cfg['Servers'][$i]['controluser'] string
$cfg['Servers'][$i]['controlpass'] string
When using http or cookie authentication modes (or 'config'
authentication mode since phpMyAdmin 2.2.1), you need to supply
the details of a MySQL account that has SELECT privilege on the
mysql.user (all columns except "Password"), mysql.db (all
columns) & mysql.tables_priv (all columns except "Grantor" &
"Timestamp") tables. This account is used to check what
databases the user will see at login.
Please see the [40]install section on "Using http
authentication" for more information.
Note that if you try login to phpMyAdmin with this
"controluser", you could get some errors, depending the exact
privileges you gave to the "controluser". phpMyAdmin does not
support a direct login with the "controluser".
In versions before 2.2.5, those were called "stduser/stdpass".
$cfg['Servers'][$i]['auth_type'] string ['http'|'cookie'|'config']
Whether config or cookie or http authentication should be used
for this server.
+ 'config' authentication ($auth_type = 'config') is the plain
old way: username and password are stored in config.inc.php3.
+ 'cookie' authentication mode ($auth_type = 'cookie') as
introduced in 2.2.3 allows you to log in as any valid MySQL
user with the help of... cookies. Log name and password are
stored in cookies during the session and password is deleted
when it ends.
+ 'http' authentication (was called 'advanced' in older
versions) ($auth_type = 'http') as introduced in 1.3.0 allows
you to log in as any valid MySQL user via HTTP-Auth.
Please see the install section on "Using authentication modes"
for more information.
$cfg['Servers'][$i]['user'] string
$cfg['Servers'][$i]['password'] string
The user/password-pair which phpMyAdmin will use to connect to
this MySQL-server. This user/password pair is not needed when
http or cookie authentication is used, and should be empty.
$cfg['Servers'][$i]['only_db'] string or array
If set to a(an array of) database name(s), only this(these)
database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
this/these database(s) name(s) may contain MySQL wilcards
characters ("_" and "%"): if you want to use literal instances
of these characters, escape them (ie use 'my\_db' and not
'my_db').
This setting is an efficient way to lower the server charge
since the latter does not need to send MySQL requests to build
the available database list. But it 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.
$cfg['Servers'][$i]['verbose'] string
Only useful when using phpMyAdmin with multiple server entries.
If set, this string will be displayed instead of the hostname
in the pulldown menu on the main page. This can be useful if
you want to show only certain databases on your system, for
example.
$cfg['Servers'][$i]['pmadb'] string
Starting with Version 2.3.0 phpMyAdmin offers a lot of Features
to work with Master / Foreign - Tables. To use those as well as
the bookmarkfeature you will need to create a new db.
$cfg['Servers'][$i]['bookmarktable'] string
Since release 2.2.0 phpMyAdmin allows to bookmark queries. This
can be useful for queries you often run.
To use this functionality as superuser create a new database:
CREATE database phpmyadmin;
Note that controluser must have SELECT, INSERT and DELETE
privileges on the bookmark table. Here is a query to set up
those privileges (using "pma" as the controluser:
GRANT SELECT,INSERT,DELETE ON <pmadb> to
'pma'@localhost;
do _not_ give any other user rights on this db.
Enter the databasename in $cfg['Servers'][$i]['pmadb']
$cfg['Servers'][$i]['bookmarktable'] string
Inside your phpMyAdmin Databse create a table following this scheme:
CREATE TABLE bookmark (
id int(11) DEFAULT '0' NOT NULL auto_increment,
dbase varchar(255) NOT NULL,
user varchar(255) NOT NULL,
label varchar(255) NOT NULL,
query text NOT NULL,
PRIMARY KEY (id)
);
and add the name in $cfg['Servers'][$i]['bookmarktable']
$cfg['Servers'][$i]['relation'] string
Since release 2.2.4 you can describe, in a special 'relation'
table, which field is a key in another table (a foreign key).
phpMyAdmin currently uses this to
+ make clickable, when you browse the master table, the data
values that point to the foreign table;
+ display in an optional tooltip the "display field" when
browsing the master table, if you move the mouse to a column
containing a foreign key (use also the 'table_info' table);
+ display links on the table properties page, to check
referential integrity (display missing foreign keys) for each
described key;
+ in query-by-example, create automatic joints (see an example
in the FAQ, section "Using phpMyAdmin");
+ enable you to get a PDF schema of your database (also uses
the table_coords table).
The keys can be numeric or character.
To use this functionality you have to
+ set up a PMA database as
described above and inside this database create a table:
CREATE TABLE relation (
master_db varchar(64) NOT NULL default '',
master_table varchar(64) NOT NULL default '',
master_field varchar(64) NOT NULL default '',
foreign_db varchar(64) NOT NULL default '',
foreign_table varchar(64) NOT NULL default '',
foreign_field varchar(64) NOT NULL default '',
PRIMARY KEY (master_db,master_table,master_field),
KEY foreign_field (foreign_db,foreign_table)
) TYPE=MyISAM COMMENT='Table Relation';
+ put the relation table name in
$cfg['Servers'][$i]['relation']
+ on the tablestructure page you will find a link to edit
a tables relation which you can use to fill this table.
$cfg['Servers'][$i]['table_info'] string
Since release 2.3.0 you can describe, in a special 'table_info'
table, which field is to be displayed as a tooltip when moving
the cursor over the corresponding key.
This configuration variable will hold the name of this special
table.
+ To use this functionality you have to set up a PMA database as
described above and inside this database create a table:
CREATE TABLE table_info (
db_name varchar(64) NOT NULL default '',
table_name varchar(64) NOT NULL default '',
display_field varchar(64) NOT NULL default '',
PRIMARY KEY (db_name,table_name)
) TYPE=MyISAM COMMENT='Table information for phpMyAdmin';
+ put the table name in $cfg['Servers'][$i]['table_info']
+ then for each table where you want to use this feature, click
"Structure/Relation view/Choose field to display" to choose
the field.
Usage tip: [41]Display field.
$cfg['Servers'][$i]['table_coords'] string
$cfg['Servers'][$i]['pdf_pages'] string
Since release 2.3.0 you can have phpMyAdmin create a PDF showing
the relations within your Database. To use this feature you will
need a table that stores the PDF pages to create and the Coordinates
of Tables to use per page.
This configuration variable will hold the name of this special
table.
PDF output is supported under PHP4, and you must be using also
the 'relation' feature. Also, we used the fpdf library which
currently only supports iso-8859 (Latin1) character sets in
PDF.
To use this functionality you have to:
+ set up a PMA database as described above
+ inside this database create a table:
CREATE TABLE table_coords (
db_name varchar(64) NOT NULL default '',
table_name varchar(64) NOT NULL default '',
pdf_page_number int(11) NOT NULL default '0',
x float unsigned NOT NULL default '0',
y float unsigned NOT NULL default '0',
PRIMARY KEY (db_name,table_name,pdf_page_number)
) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin PDF output';
+ Also in the PMA database create the following table:
CREATE TABLE pdf_pages (
db_name varchar(64) NOT NULL default '',
page_nr int(10) unsigned NOT NULL auto_increment,
page_descr varchar(50) NOT NULL default '',
PRIMARY KEY (page_nr),
KEY db (db_name)
) TYPE=MyISAM COMMENT='PDF Relationpages for PMA';
+ put the first tables name in $cfg['Servers'][$i]['table_coords']
+ put the second tables name in $cfg['Servers'][$i]['pdf_pages']
+ on the bottom of the structurepage for databases there is a link
to create pdf pages, and once you created one also one to have the
pdf created
Usage tips: [42]PDF output.
$cfg['Servers'][$i]['column_comments'] string
Since release 2.3.0 you can store comments to describe each column
for each table. These will then be shown on the printview.
To use this functionality you have to:
+ set up a PMA database as described above
+ inside this database create a table:
CREATE TABLE column_comments (
id int(5) unsigned NOT NULL auto_increment,
db_name varchar(64) NOT NULL default '',
table_name varchar(64) NOT NULL default '',
column_name varchar(64) NOT NULL default '',
comment varchar(255) NOT NULL default '',
PRIMARY KEY (id),
UNIQUE KEY db_name (db_name,table_name,column_name)
) TYPE=MyISAM COMMENT='Comments for Columns';
+ put the tables name in $cfg['Servers'][$i]['column_comments']
$cfg['Servers'][$i]['AllowDeny']['order'] string
If your rule order is empty, then IP authentication is
disabled.
If your rule order is set to 'deny,allow' then the system
applies all deny rules followed by allow rules. Access is
allowed by default. Any client which does not match a Deny
command or does match an Allow command will be allowed access
to the server.
If your rule order is set to 'allow,deny' then the system
applies all allow rules followed by deny rules. Access is
denied by default. Any client which does not match an Allow
directive or does match a Deny directive will be denied access
to the server.
If your rule order is set to 'explicit', the authentication is
performed in a similar fashion to rule order 'deny,allow', with
the added restriction that your host/username combination must
be listed in the allow rules, and not listed in the deny rules.
This is the most secure means of using Allow/Deny rules, and
was available in Apache by specifying allow and deny rules
without setting any order.
$cfg['Servers'][$i]['AllowDeny']['rules'] array of strings
The general format for the rules is as such:
<'allow' | 'deny'> <username> [from] <ipmask>
If you wish to match all users, it is possible to use a '%' as
a wildcard in the username field.
There are a few shortcuts you can use in the ipmask field as
well:
'all' -> 0.0.0.0/0
'localhost' -> 127.0.0.1/8
Having an empty rule list is equivalent to either using 'allow
% from all' if your rule order is set to 'deny,allow' or 'deny
% from all' if your rule order is set to 'allow,deny' or
'explicit'.
For the IP matching system, the following work:
xxx.xxx.xxx.xxx (an exact IP address)
xxx.xxx.xxx.[yyy-zzz] (an IP address range)
xxx.xxx.xxx.xxx/nn (CIDR, Classless Inter-Domain Routing type
IP addresses)
But the following does not work:
xxx.xxx.xxx.xx[yyy-zzz] (partial IP address range)
$cfg['ServerDefault'] integer
If you have more than one server configured, you can set
$cfg['ServerDefault'] 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, $cfg['ServerDefault']
MUST be set to that server.
$cfg['OBGzip'] boolean
Defines whether to use gzip output buffering for increased
speed in HTTP transfers.
$cfg['PersistentConnections'] boolean
Whether persistent connections should be used or not
(mysql_connect or mysql_pconnect).
$cfg['ExecTimeLimit'] integer [number of seconds]
Set the number of seconds a script is allowed to run. If
seconds is set to zero, no time limit is imposed.
This setting is used while importing/exporting dump files but
has no effect when PHP is running in safe mode.
$cfg['SkipLockedTables'] boolean
Mark used tables and make it possible to show databases with
locked tables (since 3.23.30).
$cfg['ShowSQL'] boolean
Defines whether sql-queries generated by phpMyAdmin should be
displayed or not.
$cfg['AllowUserDropDatabase'] boolean
Defines whether normal users (non-administrator) are allowed to
delete their own database or not. If set as FALSE, the link
"Drop Database" will not be shown, and even a "DROP DATABASE
mydatabase" will be rejected. Quite practical for ISP's with
many customers.
$cfg['Confirm'] boolean
Whether a warning ("Are your really sure..") should be
displayed when you're about to loose data.
$cfg['ShowTooltip'] boolean
Defines whether to display table comment as tooltip in left
frame or not.
$cfg['LeftFrameLight'] boolean
Defines whether to use select-based menu and display only the
current tables in the left frame (smaller page).
$cfg['ShowMysqlInfo'] boolean
$cfg['ShowMysqlVars'] boolean
$cfg['ShowPhpInfo'] boolean
$cfg['ShowChgPassword'] boolean
Defines whether to display the "MySQL runtime information",
"MySQL system variables", "PHP information" and "Change
password " links or not for simple users at the starting main
(right) frame. This setting does not check MySQL commands
entered directly.
Please note that to block the usage of phpinfo() in scripts,
you have to put this in your php.ini:
disable_functions = phpinfo()
Also note that enabling the "Change password " link has no
effect with "config" authentication mode: because of the hard
coded password value in the configuration file, end users can't
be allowed to change their passwords.
$cfg['LoginCookieRecall'] boolean
Define whether the previous login should be recalled or not in
cookie authentication mode.
$cfg['UseDbSearch'] boolean
Define whether the "search string inside database" is enabled
or not.
$cfg['ShowStats'] 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.
$cfg['ShowBlob'] boolean
Defines whether BLOB fields are shown when browsing a table's
content or not.
$cfg['NavigationBarIconic'] boolean
Defines whether navigation bar buttons contain text or symbols
only.
$cfg['ShowAll'] boolean
Defines whether an user should be displayed a "show all
(records)" button in browse mode or not.
$cfg['MaxRows'] integer
Number of rows displayed when browsing a resultset. If the
resultset contains more rows, Previous/Next links will be
shown.
$cfg['Order'] string [DESC|ASC|SMART]
Defines whether fields are displayed in ascending (ASC) order,
in descending (DESC) order or in a "smart" (SMART) order -ie
descending order for fields of type TIME, DATE, DATETIME &
TIMESTAMP, ascending order else- by default.
$cfg['ProtectBinary'] boolean or string
Defines whether BLOB or BINARY fields are protected from
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.
$cfg['ShowFunctionFields'] boolean
Defines whether MySQL functions fields should be displayed or
not in edit/insert mode.
$cfg['ZipDump'] boolean
$cfg['GZipDump'] boolean
$cfg['BZipDump'] boolean
Defines whether to allow the use of zip/gzip/bzip compression
when creating a dump file or not.
$cfg['ManualBaseShort'] string
If set to an URL which points to the MySQL documentation (on
short pages), appropriate help links are generated.
$cfg['DefaultLang'] string
Defines the default language to use, if not browser-defined or
user-defined.
See the select_lang.inc.php3 script to know the valid values
for this setting.
$cfg['Lang'] string
Force: always use this language (must be defined in the
select_lang.inc.php3 script).
$cfg['LeftWidth'] integer
Left frame width in pixel.
$cfg['LeftBgColor'] string [HTML color]
$cfg['RightBgColor'] string [HTML color]
The background colors (HTML) used for both the frames.
$cfg['RightBgImage'] string
The URI of the background image used for the right frame. It
can be absolute as well as relative from your phpMyAdmin
directory.
$cfg['LeftPointerColor'] string [HTML color]
The color (HTML) used for the pointer in the left frame (does
not work with NS4).
$cfg['Border'] integer
The size of a table's border.
$cfg['ThBgcolor'] string [HTML color]
The color (HTML) used for table headers.
$cfg['BgcolorOne'] string [HTML color]
The color (HTML) #1 for table rows.
$cfg['BgcolorTwo'] string [HTML color]
The color (HTML) #2 for table rows.
$cfg['BrowsePointerColor'] string [HTML color]
$cfg['BrowseMarkerColor'] string [HTML color]
The colors (HTML) uses for the pointer and the marker in browse
mode (does not work with NS4).
The former feature highlights the row over which your mouse is
passing and the latter lets you visually mark/unmark rows by
clicking on them.
You can disable both of these features by emptying the
respective directive.
$cfg['TextareaCols'] integer
$cfg['TextareaRows'] integer
Number of columns and rows for the textareas.
This value will be emphasized (*2) for sql query textareas.
$cfg['LimitChars'] integer
Maximal number of Chars showed in a TEXT OR a BLOB field on
browse view. Can be turned off by a toggle button on the browse
page.
$cfg['ModifyDeleteAtLeft'] boolean
$cfg['ModifyDeleteAtRight'] boolean
Defines the place where modify and delete links would be put
when tables contents are displayed (you may have them displayed
both at the left and at the right). "Left" and "right" are
parsed as "top" and "bottom" with vertical display mode.
$cfg['DefaultDisplay'] string
There are 2 display modes: horizontal and vertical. Define
which one is displayed by default.
$cfg['RepeatCells'] integer
Repeat the headers every X cells, or 0 to deactivate.
$cfg['ColumnTypes'] array
All possible types of a MySQL column. In most cases you don't
need to edit this.
$cfg['AttributeTypes'] array
Possible attributes for fields. In most cases you don't need to
edit this.
$cfg['Functions'] array
A list of functions MySQL supports. In most cases you don't
need to edit this.
______________________________________________________________________
[43]Top - [44]Requirements - [45]Introduction - [46]Installation
- [47]Configuration - [48]FAQ - [49]Developers - [50]Credits
______________________________________________________________________
FAQ - Frequently Asked Questions
[51]Server - [52]Configuration - [53]Limitations -
[54]Multi-user - [55]Browsers - [56]Usage tips - [57]Project
[Server]
I'm running php 4+ and my server is crashing each time a specific
action is required or phpMyAdmin sends a blank page or a page full of
cryptic characters to my browser, what can I do?
There are some known php bugs with output buffering and compression.
Try to set the $cfg['OBGzip'] directive to FALSE in your
config.inc.php or .php3 file and the zlib.output_compression directive
to Off in your php configuration file.
Furthermore, we know about such problems connected to the release
candidates of php 4.2.0 (tested with php 4.2.0 RC1 to RC4) together
with MS Internet Explorer. Please upgrade to the release version php
4.2.0.
My Apache server crashes when using phpMyAdmin.
You should first try the latest versions of Apache (and possibly
MySQL).
See also the other FAQ entry about php bugs with output buffering.
If your server keeps crashing, please ask for help in the various
Apache support groups.
I'm running phpMyAdmin with "cookie" authentication mode under PHP
4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the
script: I'm always displayed the login screen.
This is a kown PHP bug (see this [58]bug report) from the official php
bug database. It means there is and won't be any phpMyAdmin fix
against it because there is no way to code a fix.
Using phpMyAdmin on IIS, I'm displayed the error message: "The
specified CGI application misbehaved by not returning a complete set
of HTTP headers...."
You just forgot to read the install.txt file from the php
distribution. Have a look at the last message in this [59]bug report
from the official php bug database.
Using phpMyAdmin on IIS, I'm facing crashes and/or many error messages
with the http or advanced authentication mode.
This is a known problem with the php ISAPI filter: it's not so stable.
For some more information and complete testings see the messages
posted by André B. aka "djdeluxe76" in [60]this thread from the
phpWizard forum.
Please use instead the cookie authentication mode.
I can't use phpMyAdmin on PWS: nothing is displayed!
This seems to be a PWS bug. Filippo Simoncini found a workaroud (at
this time there is no better fix): remove or comment the DOCTYPE
declarations (3 lines) from the scripts header.inc.php3, index.php3,
left.php3 and libraries/common.lib.php3.
How can I GZip or Bzip a dump or a CSV export. It seems to not work?
These features are based on the gzencode() and bzcompress() php
functions 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/Bzip2 support (--with-zlib and --with-bz2).
We faced php crashes when trying to download a dump with MS Internet
Explorer when phpMyAdmin is run with a release candidate of php 4.2.0.
In this case you should switch to the release version of php 4.2.0.
I cannot insert a text file in a table, and I get an error about safe
mode being in effect.
Your uploaded file is saved by PHP in the "upload dir", as defined in
php.ini by the variable upload_tmp_dir (usually the system default is
/tmp).
We recommend the following setup for Apache servers running in safe
mode, to enable uploads of files while being reasonably secure:
* create a separate directory for uploads: mkdir /tmp/php
* give ownership to the Apache server's user.group: chown
apache.apache /tmp/php
* give proper permission: chmod 600 /tmp/php
* put upload_tmp_dir = /tmp/php in php.ini
* restart Apache
I'm having troubles when uploading files. In general file uploads
don't work on my system and uploaded files have a Content-Type: header
in the first line.
It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat
7.0 and you updated your php rpm to php-4.0.4pl1-3.i386.rpm, didn't
you?
So the problem is that this package has a serious bug that was
corrected ages ago in php (2001-01-28: see [61]php's bug tracking
system for more details). The problem is that the bugged package is
still available though it was corrected (see [62]redhat's bugzilla for
more details).
So please download [63]the fixed package (4.0.4pl1-9) and the problem
should go away.
And that fixes the \r\n problem with file uploads!
I'm having troubles when uploading files with phpMyAdmin running on a
secure server. My browser is Internet Explorer and I'm using the
Apache server.
As suggested by "Rob M" in the phpWizard forum, add this line to your
httpd.conf:
SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown
It seems to clear up many problems between IE and SSL.
I get an 'open_basedir restriction' while uploading a file from the
query box.
Since version 2.2.4, phpMyAdmin supports servers with open_basedir
restrictions. Assuming that the restriction allows you to open files
in the current directory ('.'), all you have to do is create a 'tmp'
directory under the phpMyAdmin install directory, with permissions 777
and the same owner as the owner of your phpMyAdmin directory. The
uploaded files will be moved there, and after execution of your SQL
commands, removed.
I have lost my MySQL root password, what can I do?
The MySql manual explains how to [64]reset the permissions.
I get an error 'No SQL query' when trying to execute a bookmark.
If PHP does not have read/write access to its upload_tmp_dir, it
cannot access the uploaded query.
I get an error 'No SQL query' when trying to submit a query from the
convenient text area.
Check the post_max_size directive from your php configuration file and
try to increase it.
I have problems with mysql.user field names.
In older MySQL versions, the User and Password fields were named user
and password. Please modify your field names to align with current
standards.
I cannot upload big dump files.
The first things to check (or ask your host provider to check) are the
values of upload_max_filesize, memory_limit and post_max_size in the
php.ini configuration file.
All of these three settings limit the maximum size of data that can be
submitted and handled by php.
Does phpMyAdmin support MySQL 4?
MySQL 4 is not yet fully supported by phpMyAdmin.
Because of MySQL 4's backwards compatibility you can use phpMyAdmin
for administering MySQL 4 servers, but phpMyAdmin does not yet support
its new features. Please notice that in this case it is recommended to
use php >= 4.1 since older versions of php are not compatible to
MySQL 4.
Furthermore, several users reported problems with phpMyAdmin related
to bugs in MySQL 4. MySQL 4 is still an alpha release and should be
used for test purposes only!
I'm running MySQL 4.0.1 on a Windows NT machine. Each time I create a
table the table name is changed to lowercase.
This seems to be a bug of MySQL 4.0.1 because it also appears when
using the MySQL commandline. Currently we only know about its
appearance on Windows NT systems, but it is possible that it appears
on other systems, too.
If you encounter this bug together with another OS and/or MySQL
version or you know how to work around it, please post a message into
[65]our bug tracker at SourceForge.
I can't run the "display relations" feature because the script seems
not to know the font face I'm using!
The "FPDF" library we're using for this feature requires some special
files to use font faces.
Please refers to the [66]FPDF manual to build these files.
[Configuration]
The error message "Warning: Cannot add header information - headers
already sent by ..." is displayed, what's the problem?
Edit your config.inc.php or .php3 file and ensure there is nothing (ie
no blank lines, no spaces, no characters...) neither before the <?php
tag at the beginning, neither after the ?> tag at the end.
phpMyAdmin can't connect to MySQL. What's wrong?
Either there is an error with your PHP setup or your username/password
is wrong. Try to make a small script which uses mysql_connect and see
if it works. If it doesn't, it may be you haven't even compiled MySQL
support into PHP.
The error message "Warning: MySQL Connection Failed: Can't connect to
local MySQL server through socket '/tmp/mysql.sock' (111)...") is
displayed. What can I do?
For RedHat users, Harald Legner suggests this on the mailing list:
On my RedHat-Box the socket of mysql is /var/lib/mysql/mysql.sock. In
your php.ini you will find a line
mysql.default_socket = /tmp/mysql.sock
change it to
mysql.default_socket = /var/lib/mysql/mysql.sock
Then restart apache and it will work.
Here is a fix suggested by Brad Ummer in the [67]phpwizard forum:
* First, you need to determine what socket is being used by MySQL.
To do this, telnet to your server and go to the MySQL bin
directory. In this directory there should be a file named
mysqladmin. Type ./mysqladmin variables, and this should give you
a bunch of info about your MySQL server, including the socket
(/tmp/mysql.sock, for example).
* Then, you need to tell PHP to use this socket.
Assuming you are using PHP 3.0.10 or better, you can specify the
socket to use when you open the connection. To do this in
phpMyAdmin, you need to complete the socket information in the
config.inc.php3.
For example: $cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';
Have also a look at the [68]corresponding section of the MySQL
documentation.
Nothing is displayed by my browser when I try to run phpMyAdmin, what
can I do?
Try to set the $cfg['OBGZip'] directive to FALSE in the phpMyAdmin
configuration file. It helps sometime.
Also have a look at your php version number: if it contains "4.0b..."
it means you're running a beta version of PHP. That's not a so good
idea, please upgrade to a plain revision.
Each time I want to insert or change a record or drop a database or a
table, an error 404 (page not found) is displayed or, with http or
cookie authentication, I'm asked to login again. What's wrong?
Check the value you set for the $cfg['PmaAbsoluteUri'] directive in
the phpMyAdmin configuration file.
[Known limitations]
When using http authentication, an user who logged out can not relog
in with the same nick.
This is related to the authentication mechanism (protocol) used by
phpMyAdmin. We plan to change it as soon as we may find enough free
time to do it, but you can bypass this problem: just close all the
opened browser windows and then go back to phpMyAdmin. You should be
able to logs in again.
When dumping a large table in compressed mode, I get a memory limit
error or a time limit error.
As of version 2.2.4, we build the compressed dump in memory, so large
tables dumps may hang. The only alternative we can think about (using
system calls to mysqldump then gzip or bzip2) would not be applicable
in environments where PHP is in safe mode: access to system programs
is is limited by the system administrator, and time limit is enforced.
[ISPs, multi-user installations ]
I'm an ISP. Can I setup one central copy of phpMyAdmin or do I need to
install it for each customer?
Since version 2.0.3, you can setup a central copy of phpMyAdmin for
all your users. The development of this feature was kindly sponsored
by NetCologne GmbH. This requires a properly setup MySQL user
management and phpMyAdmin http or cookie authentication. See the
install section on "Using http authentication".
What's the preferred way of making phpMyAdmin secure against evil
access?
This depends on your system.
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, you should use
phpMyAdmin's http authentication 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.
I get errors about not being able to include a file in /lang or in
/libraries.
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.
phpMyAdmin always gives "Access denied" when using http
authentication.
This could happen for several reasons:
* $cfg['Servers'][$i]['controluser'] and/or
$cfg['Servers'][$i]['controlpass'] are wrong.
* The username/password you specify in the login-dialog are invalid.
* You have already setup a security mechanism for the
phpMyAdmin-directory, eg. a .htaccess file. This would interfere
with phpMyAdmin's authentication, so remove it.
Is it possible to let users create their own databases?
Starting with 2.2.5, in the user management page, you can enter a
wildcard database name for a user, and put the privileges you want.
For example, adding SELECT, INSERT, UPDATE, DELETE, CREATE, DROP,
INDEX, ALTER would let a user create/manage his/her database(s).