config.rst 86 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769
  1. .. index:: config.inc.php
  2. .. _config:
  3. Configuration
  4. =============
  5. Almost all configurable data is placed in :file:`config.inc.php`. If this file
  6. does not exist, please refer to the :ref:`setup` section to create one. This
  7. file only needs to contain the parameters you want to change from their
  8. corresponding default value in :file:`libraries/config.default.php`.
  9. If a directive is missing from your file, you can just add another line with
  10. the file. This file is for over-writing the defaults; if you wish to use the
  11. default value there's no need to add a line here.
  12. The parameters which relate to design (like colors) are placed in
  13. :file:`themes/themename/layout.inc.php`. You might also want to create
  14. :file:`config.footer.inc.php` and :file:`config.header.inc.php` files to add
  15. your site specific code to be included on start and end of each page.
  16. .. note::
  17. Some distributions (eg. Debian or Ubuntu) store :file:`config.inc.php` in
  18. ``/etc/phpmyadmin`` instead of within phpMyAdmin sources.
  19. .. warning::
  20. :term:`Mac` users should note that if you are on a version before
  21. :term:`Mac OS X`, PHP does not seem to
  22. like :term:`Mac` end of lines character (``\r``). So
  23. ensure you choose the option that allows to use the \*nix end of line
  24. character (``\n``) in your text editor before saving a script you have
  25. modified.
  26. Basic settings
  27. --------------
  28. .. config:option:: $cfg['PmaAbsoluteUri']
  29. :type: string
  30. :default: ``''``
  31. Sets here the complete :term:`URL` (with full path) to your phpMyAdmin
  32. installation's directory. E.g.
  33. ``http://www.example.net/path_to_your_phpMyAdmin_directory/``. Note also
  34. that the :term:`URL` on most of web servers are case–sensitive. Don’t
  35. forget the trailing slash at the end.
  36. Starting with version 2.3.0, it is advisable to try leaving this blank. In
  37. most cases phpMyAdmin automatically detects the proper setting. Users of
  38. port forwarding will need to set :config:option:`$cfg['PmaAbsoluteUri']`
  39. (`more info <https://sourceforge.net/p/phpmyadmin/support-requests/795/>`_).
  40. A good test is to browse a table, edit a row and save it. There should be
  41. an error message if phpMyAdmin is having trouble auto–detecting the correct
  42. value. If you get an error that this must be set or if the autodetect code
  43. fails to detect your path, please post a bug report on our bug tracker so
  44. we can improve the code.
  45. .. seealso:: :ref:`faq1_40`
  46. .. config:option:: $cfg['PmaNoRelation_DisableWarning']
  47. :type: boolean
  48. :default: false
  49. Starting with version 2.3.0 phpMyAdmin offers a lot of features to
  50. work with master / foreign – tables (see :config:option:`$cfg['Servers'][$i]['pmadb']`).
  51. If you tried to set this
  52. up and it does not work for you, have a look on the :guilabel:`Structure` page
  53. of one database where you would like to use it. You will find a link
  54. that will analyze why those features have been disabled.
  55. If you do not want to use those features set this variable to ``true`` to
  56. stop this message from appearing.
  57. .. config:option:: $cfg['SuhosinDisableWarning']
  58. :type: boolean
  59. :default: false
  60. A warning is displayed on the main page if Suhosin is detected.
  61. You can set this parameter to ``true`` to stop this message from appearing.
  62. .. config:option:: $cfg['ServerLibraryDifference_DisableWarning']
  63. :type: boolean
  64. :default: false
  65. A warning is displayed on the main page if there is a difference
  66. between the MySQL library and server version.
  67. You can set this parameter to ``true`` to stop this message from appearing.
  68. .. config:option:: $cfg['ReservedWordDisableWarning']
  69. :type: boolean
  70. :default: false
  71. This warning is displayed on the Structure page of a table if one or more
  72. column names match with words which are MySQL reserved.
  73. If you want to turn off this warning, you can set it to ``true`` and
  74. warning will no longer be displayed.
  75. .. config:option:: $cfg['TranslationWarningThreshold']
  76. :type: integer
  77. :default: 80
  78. Show warning about incomplete translations on certain threshold.
  79. .. config:option:: $cfg['SendErrorReports']
  80. :type: string
  81. :default: ``'ask'``
  82. Sets the default behavior for JavaScript error reporting.
  83. Whenever an error is detected in the JavaScript execution, an error report
  84. may be sent to the phpMyAdmin team if the user agrees.
  85. The default setting of ``'ask'`` will ask the user everytime there is a new
  86. error report. However you can set this parameter to ``'always'`` to send error
  87. reports without asking for confirmation or you can set it to ``'never'`` to
  88. never send error reports.
  89. This directive is available both in the configuration file and in users
  90. preferences. If the person in charge of a multi-user installation prefers
  91. to disable this feature for all users, a value of ``'never'`` should be
  92. set, and the :config:option:`$cfg['UserprefsDisallow']` directive should
  93. contain ``'SendErrorReports'`` in one of its array values.
  94. .. config:option:: $cfg['AllowThirdPartyFraming']
  95. :type: boolean
  96. :default: false
  97. Setting this to ``true`` allows phpMyAdmin to be included inside a frame,
  98. and is a potential security hole allowing cross-frame scripting attacks or
  99. clickjacking.
  100. Server connection settings
  101. --------------------------
  102. .. config:option:: $cfg['Servers']
  103. :type: array
  104. :default: one server array with settings listed bellow
  105. Since version 1.4.2, phpMyAdmin supports the administration of multiple
  106. MySQL servers. Therefore, a :config:option:`$cfg['Servers']`-array has been
  107. added which contains the login information for the different servers. The
  108. first :config:option:`$cfg['Servers'][$i]['host']` contains the hostname of
  109. the first server, the second :config:option:`$cfg['Servers'][$i]['host']`
  110. the hostname of the second server, etc. In
  111. :file:`libraries/config.default.php`, there is only one section for server
  112. definition, however you can put as many as you need in
  113. :file:`config.inc.php`, copy that block or needed parts (you don't have to
  114. define all settings, just those you need to change).
  115. .. note::
  116. The :config:option:`$cfg['Servers']` array starts with
  117. $cfg['Servers'][1]. Do not use $cfg['Servers'][0]. If you want more
  118. than one server, just copy following section (including $i
  119. incrementation) serveral times. There is no need to define full server
  120. array, just define values you need to change.
  121. .. config:option:: $cfg['Servers'][$i]['host']
  122. :type: string
  123. :default: ``'localhost'``
  124. The hostname or :term:`IP` address of your $i-th MySQL-server. E.g.
  125. ``localhost``.
  126. Possible values are:
  127. * hostname, e.g., ``'localhost'`` or ``'mydb.example.org'``
  128. * IP address, e.g., ``'127.0.0.1'`` or ``'192.168.10.1'``
  129. * dot - ``'.'``, i.e., use named pipes on windows systems
  130. * empty - ``''``, disables this server
  131. .. note::
  132. phpMyAdmin supports connecting to MySQL servers reachable via IPv6 only.
  133. To connect to an IPv6 MySQL server, enter its IPv6 address in this field.
  134. .. config:option:: $cfg['Servers'][$i]['port']
  135. :type: string
  136. :default: ``''``
  137. The port-number of your $i-th MySQL-server. Default is 3306 (leave
  138. blank).
  139. .. note::
  140. If you use ``localhost`` as the hostname, MySQL ignores this port number
  141. and connects with the socket, so if you want to connect to a port
  142. different from the default port, use ``127.0.0.1`` or the real hostname
  143. in :config:option:`$cfg['Servers'][$i]['host']`.
  144. .. config:option:: $cfg['Servers'][$i]['socket']
  145. :type: string
  146. :default: ``''``
  147. The path to the socket to use. Leave blank for default. To determine
  148. the correct socket, check your MySQL configuration or, using the
  149. :command:`mysql` command–line client, issue the ``status`` command. Among the
  150. resulting information displayed will be the socket used.
  151. .. config:option:: $cfg['Servers'][$i]['ssl']
  152. :type: boolean
  153. :default: false
  154. Whether to enable SSL for the connection between phpMyAdmin and the MySQL server.
  155. When using the ``'mysql'`` extension,
  156. none of the remaining ``'ssl...'`` configuration options apply.
  157. We strongly recommend the ``'mysqli'`` extension when using this option.
  158. .. config:option:: $cfg['Servers'][$i]['ssl_key']
  159. :type: string
  160. :default: NULL
  161. Path to the key file when using SSL for connecting to the MySQL server.
  162. For example:
  163. .. code-block:: php
  164. $cfg['Servers'][$i]['ssl_key'] = '/etc/mysql/server-key.pem';
  165. .. config:option:: $cfg['Servers'][$i]['ssl_cert']
  166. :type: string
  167. :default: NULL
  168. Path to the cert file when using SSL for connecting to the MySQL server.
  169. .. config:option:: $cfg['Servers'][$i]['ssl_ca']
  170. :type: string
  171. :default: NULL
  172. Path to the CA file when using SSL for connecting to the MySQL server.
  173. .. config:option:: $cfg['Servers'][$i]['ssl_ca_path']
  174. :type: string
  175. :default: NULL
  176. Directory containing trusted SSL CA certificates in PEM format.
  177. .. config:option:: $cfg['Servers'][$i]['ssl_ciphers']
  178. :type: string
  179. :default: NULL
  180. List of allowable ciphers for SSL connections to the MySQL server.
  181. .. config:option:: $cfg['Servers'][$i]['connect_type']
  182. :type: string
  183. :default: ``'tcp'``
  184. What type connection to use with the MySQL server. Your options are
  185. ``'socket'`` and ``'tcp'``. It defaults to tcp as that is nearly guaranteed
  186. to be available on all MySQL servers, while sockets are not supported on
  187. some platforms. To use the socket mode, your MySQL server must be on the
  188. same machine as the Web server.
  189. .. config:option:: $cfg['Servers'][$i]['compress']
  190. :type: boolean
  191. :default: false
  192. Whether to use a compressed protocol for the MySQL server connection
  193. or not (experimental).
  194. .. _controlhost:
  195. .. config:option:: $cfg['Servers'][$i]['controlhost']
  196. :type: string
  197. :default: ``''``
  198. Permits to use an alternate host to hold the configuration storage
  199. data.
  200. .. _controlport:
  201. .. config:option:: $cfg['Servers'][$i]['controlport']
  202. :type: string
  203. :default: ``''``
  204. Permits to use an alternate port to connect to the host that
  205. holds the configuration storage.
  206. .. _controluser:
  207. .. config:option:: $cfg['Servers'][$i]['controluser']
  208. :type: string
  209. :default: ``''``
  210. .. config:option:: $cfg['Servers'][$i]['controlpass']
  211. :type: string
  212. :default: ``''``
  213. This special account is used for 2 distinct purposes: to make possible all
  214. relational features (see :config:option:`$cfg['Servers'][$i]['pmadb']`).
  215. .. versionchanged:: 2.2.5
  216. those were called ``stduser`` and ``stdpass``
  217. .. seealso:: :ref:`setup`, :ref:`authentication_modes`, :ref:`linked-tables`
  218. .. config:option:: $cfg['Servers'][$i]['auth_type']
  219. :type: string
  220. :default: ``'cookie'``
  221. Whether config or cookie or :term:`HTTP` or signon authentication should be
  222. used for this server.
  223. * 'config' authentication (``$auth_type = 'config'``) is the plain old
  224. way: username and password are stored in :file:`config.inc.php`.
  225. * 'cookie' authentication mode (``$auth_type = 'cookie'``) as
  226. introduced in 2.2.3 allows you to log in as any valid MySQL user with
  227. the help of cookies. Username and password are stored in cookies
  228. during the session and password is deleted when it ends. This can also
  229. allow you to log in in arbitrary server if :config:option:`$cfg['AllowArbitraryServer']` enabled.
  230. * 'http' authentication (was
  231. called 'advanced' in previous versions and can be written also as
  232. 'http') (``$auth_type = 'http';'``) as introduced in 1.3.0 allows you to log in as any
  233. valid MySQL user via HTTP-Auth.
  234. * 'signon' authentication mode (``$auth_type = 'signon'``) as
  235. introduced in 2.10.0 allows you to log in from prepared PHP session
  236. data or using supplied PHP script. This is useful for implementing
  237. single signon from another application. Sample way how to seed session
  238. is in signon example: :file:`examples/signon.php`. There is also
  239. alternative example using OpenID - :file:`examples/openid.php` and example
  240. for scripts based solution - :file:`examples/signon-script.php`. You need
  241. to configure :config:option:`$cfg['Servers'][$i]['SignonSession']` or
  242. :config:option:`$cfg['Servers'][$i]['SignonScript']` and
  243. :config:option:`$cfg['Servers'][$i]['SignonURL']` to use this authentication
  244. method.
  245. .. seealso:: :ref:`authentication_modes`
  246. .. _servers_auth_http_realm:
  247. .. config:option:: $cfg['Servers'][$i]['auth_http_realm']
  248. :type: string
  249. :default: ``''``
  250. When using auth\_type = ``http``, this field allows to define a custom
  251. :term:`HTTP` Basic Auth Realm which will be displayed to the user. If not
  252. explicitly specified in your configuration, a string combined of
  253. "phpMyAdmin " and either :config:option:`$cfg['Servers'][$i]['verbose']` or
  254. :config:option:`$cfg['Servers'][$i]['host']` will be used.
  255. .. _servers_auth_swekey_config:
  256. .. config:option:: $cfg['Servers'][$i]['auth_swekey_config']
  257. :type: string
  258. :default: ``''``
  259. The name of the file containing :ref:`swekey` ids and login names for hardware
  260. authentication. Leave empty to deactivate this feature.
  261. .. _servers_user:
  262. .. config:option:: $cfg['Servers'][$i]['user']
  263. :type: string
  264. :default: ``'root'``
  265. .. config:option:: $cfg['Servers'][$i]['password']
  266. :type: string
  267. :default: ``''``
  268. When using :config:option:`$cfg['Servers'][$i]['auth_type']` set to
  269. 'config', this is the user/password-pair which phpMyAdmin will use to
  270. connect to the MySQL server. This user/password pair is not needed when
  271. :term:`HTTP` or cookie authentication is used
  272. and should be empty.
  273. .. _servers_nopassword:
  274. .. config:option:: $cfg['Servers'][$i]['nopassword']
  275. :type: boolean
  276. :default: false
  277. Allow attempt to log in without password when a login with password
  278. fails. This can be used together with http authentication, when
  279. authentication is done some other way and phpMyAdmin gets user name
  280. from auth and uses empty password for connecting to MySQL. Password
  281. login is still tried first, but as fallback, no password method is
  282. tried.
  283. .. _servers_only_db:
  284. .. config:option:: $cfg['Servers'][$i]['only_db']
  285. :type: string or array
  286. :default: ``''``
  287. If set to a (an array of) database name(s), only this (these)
  288. database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
  289. this/these database(s) name(s) may contain MySQL wildcards characters
  290. ("\_" and "%"): if you want to use literal instances of these
  291. characters, escape them (I.E. use ``'my\_db'`` and not ``'my_db'``).
  292. This setting is an efficient way to lower the server load since the
  293. latter does not need to send MySQL requests to build the available
  294. database list. But **it does not replace the privileges rules of the
  295. MySQL database server**. If set, it just means only these databases
  296. will be displayed but **not that all other databases can't be used.**
  297. An example of using more that one database:
  298. .. code-block:: php
  299. $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');
  300. .. versionchanged:: 4.0.0
  301. Previous versions permitted to specify the display order of
  302. the database names via this directive.
  303. .. config:option:: $cfg['Servers'][$i]['hide_db']
  304. :type: string
  305. :default: ``''``
  306. Regular expression for hiding some databases from unprivileged users.
  307. This only hides them from listing, but a user is still able to access
  308. them (using, for example, the SQL query area). To limit access, use
  309. the MySQL privilege system. For example, to hide all databases
  310. starting with the letter "a", use
  311. .. code-block:: php
  312. $cfg['Servers'][$i]['hide_db'] = '^a';
  313. and to hide both "db1" and "db2" use
  314. .. code-block:: php
  315. $cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$';
  316. More information on regular expressions can be found in the `PCRE
  317. pattern syntax
  318. <http://php.net/manual/en/reference.pcre.pattern.syntax.php>`_ portion
  319. of the PHP reference manual.
  320. .. config:option:: $cfg['Servers'][$i]['verbose']
  321. :type: string
  322. :default: ``''``
  323. Only useful when using phpMyAdmin with multiple server entries. If
  324. set, this string will be displayed instead of the hostname in the
  325. pull-down menu on the main page. This can be useful if you want to
  326. show only certain databases on your system, for example. For HTTP
  327. auth, all non-US-ASCII characters will be stripped.
  328. .. config:option:: $cfg['Servers'][$i]['pmadb']
  329. :type: string
  330. :default: ``''``
  331. The name of the database containing the phpMyAdmin configuration
  332. storage.
  333. See the :ref:`linked-tables` section in this document to see the benefits of
  334. this feature, and for a quick way of creating this database and the needed
  335. tables.
  336. If you are the only user of this phpMyAdmin installation, you can use your
  337. current database to store those special tables; in this case, just put your
  338. current database name in :config:option:`$cfg['Servers'][$i]['pmadb']`. For a
  339. multi-user installation, set this parameter to the name of your central
  340. database containing the phpMyAdmin configuration storage.
  341. .. _bookmark:
  342. .. config:option:: $cfg['Servers'][$i]['bookmarktable']
  343. :type: string
  344. :default: ``''``
  345. Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This
  346. can be useful for queries you often run. To allow the usage of this
  347. functionality:
  348. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  349. * enter the table name in :config:option:`$cfg['Servers'][$i]['bookmarktable']`
  350. .. _relation:
  351. .. config:option:: $cfg['Servers'][$i]['relation']
  352. :type: string
  353. :default: ``''``
  354. Since release 2.2.4 you can describe, in a special 'relation' table,
  355. which column is a key in another table (a foreign key). phpMyAdmin
  356. currently uses this to:
  357. * make clickable, when you browse the master table, the data values that
  358. point to the foreign table;
  359. * display in an optional tool-tip the "display column" when browsing the
  360. master table, if you move the mouse to a column containing a foreign
  361. key (use also the 'table\_info' table); (see :ref:`faqdisplay`)
  362. * in edit/insert mode, display a drop-down list of possible foreign keys
  363. (key value and "display column" are shown) (see :ref:`faq6_21`)
  364. * display links on the table properties page, to check referential
  365. integrity (display missing foreign keys) for each described key;
  366. * in query-by-example, create automatic joins (see :ref:`faq6_6`)
  367. * enable you to get a :term:`PDF` schema of
  368. your database (also uses the table\_coords table).
  369. The keys can be numeric or character.
  370. To allow the usage of this functionality:
  371. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  372. * put the relation table name in :config:option:`$cfg['Servers'][$i]['relation']`
  373. * now as normal user open phpMyAdmin and for each one of your tables
  374. where you want to use this feature, click :guilabel:`Structure/Relation view/`
  375. and choose foreign columns.
  376. .. note::
  377. In the current version, ``master_db`` must be the same as ``foreign_db``.
  378. Those columns have been put in future development of the cross-db
  379. relations.
  380. .. _table_info:
  381. .. config:option:: $cfg['Servers'][$i]['table_info']
  382. :type: string
  383. :default: ``''``
  384. Since release 2.3.0 you can describe, in a special 'table\_info'
  385. table, which column is to be displayed as a tool-tip when moving the
  386. cursor over the corresponding key. This configuration variable will
  387. hold the name of this special table. To allow the usage of this
  388. functionality:
  389. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  390. * put the table name in :config:option:`$cfg['Servers'][$i]['table\_info']` (e.g.
  391. ``pma__table_info``)
  392. * then for each table where you want to use this feature, click
  393. "Structure/Relation view/Choose column to display" to choose the
  394. column.
  395. .. seealso:: :ref:`faqdisplay`
  396. .. _table_coords:
  397. .. config:option:: $cfg['Servers'][$i]['table_coords']
  398. :type: string
  399. :default: ``''``
  400. .. config:option:: $cfg['Servers'][$i]['pdf_pages']
  401. :type: string
  402. :default: ``''``
  403. Since release 2.3.0 you can have phpMyAdmin create :term:`PDF` pages
  404. showing the relations between your tables. To do this it needs two tables
  405. "pdf\_pages" (storing information about the available :term:`PDF` pages)
  406. and "table\_coords" (storing coordinates where each table will be placed on
  407. a :term:`PDF` schema output). You must be using the "relation" feature.
  408. To allow the usage of this functionality:
  409. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  410. * put the correct table names in
  411. :config:option:`$cfg['Servers'][$i]['table\_coords']` and
  412. :config:option:`$cfg['Servers'][$i]['pdf\_pages']`
  413. .. seealso:: :ref:`faqpdf`.
  414. .. _col_com:
  415. .. config:option:: $cfg['Servers'][$i]['column_info']
  416. :type: string
  417. :default: ``''``
  418. This part requires a content update! Since release 2.3.0 you can
  419. store comments to describe each column for each table. These will then
  420. be shown on the "printview".
  421. Starting with release 2.5.0, comments are consequently used on the table
  422. property pages and table browse view, showing up as tool-tips above the
  423. column name (properties page) or embedded within the header of table in
  424. browse view. They can also be shown in a table dump. Please see the
  425. relevant configuration directives later on.
  426. Also new in release 2.5.0 is a MIME- transformation system which is also
  427. based on the following table structure. See :ref:`transformations` for
  428. further information. To use the MIME- transformation system, your
  429. column\_info table has to have the three new columns 'mimetype',
  430. 'transformation', 'transformation\_options'.
  431. To allow the usage of this functionality:
  432. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  433. * put the table name in :config:option:`$cfg['Servers'][$i]['column\_info']` (e.g.
  434. ``pma__column_info``)
  435. * to update your PRE-2.5.0 Column\_comments Table use this: and
  436. remember that the Variable in :file:`config.inc.php` has been renamed from
  437. :config:option:`$cfg['Servers'][$i]['column\_comments']` to
  438. :config:option:`$cfg['Servers'][$i]['column\_info']`
  439. .. code-block:: mysql
  440. ALTER TABLE `pma__column_comments`
  441. ADD `mimetype` VARCHAR( 255 ) NOT NULL,
  442. ADD `transformation` VARCHAR( 255 ) NOT NULL,
  443. ADD `transformation_options` VARCHAR( 255 ) NOT NULL;
  444. .. _history:
  445. .. config:option:: $cfg['Servers'][$i]['history']
  446. :type: string
  447. :default: ``''``
  448. Since release 2.5.0 you can store your :term:`SQL` history, which means all
  449. queries you entered manually into the phpMyAdmin interface. If you don't
  450. want to use a table-based history, you can use the JavaScript-based
  451. history.
  452. Using that, all your history items are deleted when closing the window.
  453. Using :config:option:`$cfg['QueryHistoryMax']` you can specify an amount of
  454. history items you want to have on hold. On every login, this list gets cut
  455. to the maximum amount.
  456. The query history is only available if JavaScript is enabled in
  457. your browser.
  458. To allow the usage of this functionality:
  459. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  460. * put the table name in :config:option:`$cfg['Servers'][$i]['history']` (e.g.
  461. ``pma__history``)
  462. .. _recent:
  463. .. config:option:: $cfg['Servers'][$i]['recent']
  464. :type: string
  465. :default: ``''``
  466. Since release 3.5.0 you can show recently used tables in the
  467. navigation panel. It helps you to jump across table directly, without
  468. the need to select the database, and then select the table. Using
  469. :config:option:`$cfg['NumRecentTables']` you can configure the maximum number
  470. of recent tables shown. When you select a table from the list, it will jump to
  471. the page specified in :config:option:`$cfg['NavigationTreeDefaultTabTable']`.
  472. Without configuring the storage, you can still access the recently used tables,
  473. but it will disappear after you logout.
  474. To allow the usage of this functionality persistently:
  475. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  476. * put the table name in :config:option:`$cfg['Servers'][$i]['recent']` (e.g.
  477. ``pma__recent``)
  478. .. _table_uiprefs:
  479. .. config:option:: $cfg['Servers'][$i]['table_uiprefs']
  480. :type: string
  481. :default: ``''``
  482. Since release 3.5.0 phpMyAdmin can be configured to remember several
  483. things (sorted column :config:option:`$cfg['RememberSorting']`, column order,
  484. and column visibility from a database table) for browsing tables. Without
  485. configuring the storage, these features still can be used, but the values will
  486. disappear after you logout.
  487. To allow the usage of these functionality persistently:
  488. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  489. * put the table name in :config:option:`$cfg['Servers'][$i]['table\_uiprefs']` (e.g.
  490. ``pma__table_uiprefs``)
  491. .. _configurablemenus:
  492. .. config:option:: $cfg['Servers'][$i]['users']
  493. :type: string
  494. :default: ``''``
  495. .. config:option:: $cfg['Servers'][$i]['usergroups']
  496. :type: string
  497. :default: ``''``
  498. Since release 4.1.0 you can create different user groups with menu items
  499. attached to them. Users can be assigned to these groups and the logged in
  500. user would only see menu items configured to the usergroup he is assigned to.
  501. To do this it needs two tables "usergroups" (storing allowed menu items for each
  502. user group) and "users" (storing users and their assignments to user groups).
  503. To allow the usage of this functionality:
  504. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  505. * put the correct table names in
  506. :config:option:`$cfg['Servers'][$i]['users']` (e.g. ``pma__users``) and
  507. :config:option:`$cfg['Servers'][$i]['usergroups']` (e.g. ``pma__usergroups``)
  508. .. _navigationhiding:
  509. .. config:option:: $cfg['Servers'][$i]['navigationhiding']
  510. :type: string
  511. :default: ``''``
  512. Since release 4.1.0 you can hide/show items in the navigation tree.
  513. To allow the usage of this functionality:
  514. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  515. * put the table name in :config:option:`$cfg['Servers'][$i]['navigationhiding']` (e.g.
  516. ``pma__navigationhiding``)
  517. .. _savedsearches:
  518. .. config:option:: $cfg['Servers'][$i]['savedsearches']
  519. :type: string
  520. :default: ``''``
  521. Since release 4.2.0 you can save and load query-by-example searches from the Database > Query panel.
  522. To allow the usage of this functionality:
  523. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  524. * put the table name in :config:option:`$cfg['Servers'][$i]['savedsearches']` (e.g.
  525. ``pma__savedsearches``)
  526. .. _tracking:
  527. .. config:option:: $cfg['Servers'][$i]['tracking']
  528. :type: string
  529. :default: ``''``
  530. Since release 3.3.x a tracking mechanism is available. It helps you to
  531. track every :term:`SQL` command which is
  532. executed by phpMyAdmin. The mechanism supports logging of data
  533. manipulation and data definition statements. After enabling it you can
  534. create versions of tables.
  535. The creation of a version has two effects:
  536. * phpMyAdmin saves a snapshot of the table, including structure and
  537. indexes.
  538. * phpMyAdmin logs all commands which change the structure and/or data of
  539. the table and links these commands with the version number.
  540. Of course you can view the tracked changes. On the :guilabel:`Tracking`
  541. page a complete report is available for every version. For the report you
  542. can use filters, for example you can get a list of statements within a date
  543. range. When you want to filter usernames you can enter \* for all names or
  544. you enter a list of names separated by ','. In addition you can export the
  545. (filtered) report to a file or to a temporary database.
  546. To allow the usage of this functionality:
  547. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  548. * put the table name in :config:option:`$cfg['Servers'][$i]['tracking']` (e.g.
  549. ``pma__tracking``)
  550. .. _tracking2:
  551. .. config:option:: $cfg['Servers'][$i]['tracking_version_auto_create']
  552. :type: boolean
  553. :default: false
  554. Whether the tracking mechanism creates versions for tables and views
  555. automatically.
  556. If this is set to true and you create a table or view with
  557. * CREATE TABLE ...
  558. * CREATE VIEW ...
  559. and no version exists for it, the mechanism will create a version for
  560. you automatically.
  561. .. _tracking3:
  562. .. config:option:: $cfg['Servers'][$i]['tracking_default_statements']
  563. :type: string
  564. :default: ``'CREATE TABLE,ALTER TABLE,DROP TABLE,RENAME TABLE,CREATE INDEX,DROP INDEX,INSERT,UPDATE,DELETE,TRUNCATE,REPLACE,CREATE VIEW,ALTER VIEW,DROP VIEW,CREATE DATABASE,ALTER DATABASE,DROP DATABASE'``
  565. Defines the list of statements the auto-creation uses for new
  566. versions.
  567. .. _tracking4:
  568. .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_view']
  569. :type: boolean
  570. :default: true
  571. Whether a DROP VIEW IF EXISTS statement will be added as first line to
  572. the log when creating a view.
  573. .. _tracking5:
  574. .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_table']
  575. :type: boolean
  576. :default: true
  577. Whether a DROP TABLE IF EXISTS statement will be added as first line
  578. to the log when creating a table.
  579. .. _tracking6:
  580. .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_database']
  581. :type: boolean
  582. :default: true
  583. Whether a DROP DATABASE IF EXISTS statement will be added as first
  584. line to the log when creating a database.
  585. .. _userconfig:
  586. .. config:option:: $cfg['Servers'][$i]['userconfig']
  587. :type: string
  588. :default: ``''``
  589. Since release 3.4.x phpMyAdmin allows users to set most preferences by
  590. themselves and store them in the database.
  591. If you don't allow for storing preferences in
  592. :config:option:`$cfg['Servers'][$i]['pmadb']`, users can still personalize
  593. phpMyAdmin, but settings will be saved in browser's local storage, or, it
  594. is is unavailable, until the end of session.
  595. To allow the usage of this functionality:
  596. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  597. * put the table name in :config:option:`$cfg['Servers'][$i]['userconfig']`
  598. .. _designer_coords:
  599. .. config:option:: $cfg['Servers'][$i]['designer_coords']
  600. :type: string
  601. :default: ``''``
  602. Since release 2.10.0 a Designer interface is available; it permits to
  603. visually manage the relations.
  604. To allow the usage of this functionality:
  605. * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  606. * put the table name in :config:option:`$cfg['Servers'][$i]['designer\_coords']`
  607. (e.g. ``pma__designer_coords``)
  608. .. config:option:: $cfg['Servers'][$i]['MaxTableUiprefs']
  609. :type: integer
  610. :default: 100
  611. Maximum number of rows saved in
  612. :config:option:`$cfg['Servers'][$i]['table_uiprefs']` table.
  613. When tables are dropped or renamed,
  614. :config:option:`$cfg['Servers'][$i]['table_uiprefs']` may contain invalid data
  615. (referring to tables which no longer exist). We only keep this number of newest
  616. rows in :config:option:`$cfg['Servers'][$i]['table_uiprefs']` and automatically
  617. delete older rows.
  618. .. config:option:: $cfg['Servers'][$i]['AllowRoot']
  619. :type: boolean
  620. :default: true
  621. Whether to allow root access. This is just a shortcut for the
  622. :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` below.
  623. .. config:option:: $cfg['Servers'][$i]['AllowNoPassword']
  624. :type: boolean
  625. :default: false
  626. Whether to allow logins without a password. The default value of
  627. ``false`` for this parameter prevents unintended access to a MySQL
  628. server with was left with an empty password for root or on which an
  629. anonymous (blank) user is defined.
  630. .. _servers_allowdeny_order:
  631. .. config:option:: $cfg['Servers'][$i]['AllowDeny']['order']
  632. :type: string
  633. :default: ``''``
  634. If your rule order is empty, then :term:`IP`
  635. authorization is disabled.
  636. If your rule order is set to
  637. ``'deny,allow'`` then the system applies all deny rules followed by
  638. allow rules. Access is allowed by default. Any client which does not
  639. match a Deny command or does match an Allow command will be allowed
  640. access to the server.
  641. If your rule order is set to ``'allow,deny'``
  642. then the system applies all allow rules followed by deny rules. Access
  643. is denied by default. Any client which does not match an Allow
  644. directive or does match a Deny directive will be denied access to the
  645. server.
  646. If your rule order is set to ``'explicit'``, authorization is
  647. performed in a similar fashion to rule order 'deny,allow', with the
  648. added restriction that your host/username combination **must** be
  649. listed in the *allow* rules, and not listed in the *deny* rules. This
  650. is the **most** secure means of using Allow/Deny rules, and was
  651. available in Apache by specifying allow and deny rules without setting
  652. any order.
  653. Please also see :config:option:`$cfg['TrustedProxies']` for
  654. detecting IP address behind proxies.
  655. .. _servers_allowdeny_rules:
  656. .. config:option:: $cfg['Servers'][$i]['AllowDeny']['rules']
  657. :type: array of strings
  658. :default: array()
  659. The general format for the rules is as such:
  660. .. code-block:: none
  661. <'allow' | 'deny'> <username> [from] <ipmask>
  662. If you wish to match all users, it is possible to use a ``'%'`` as a
  663. wildcard in the *username* field.
  664. There are a few shortcuts you can
  665. use in the *ipmask* field as well (please note that those containing
  666. SERVER\_ADDRESS might not be available on all webservers):
  667. .. code-block:: none
  668. 'all' -> 0.0.0.0/0
  669. 'localhost' -> 127.0.0.1/8
  670. 'localnetA' -> SERVER_ADDRESS/8
  671. 'localnetB' -> SERVER_ADDRESS/16
  672. 'localnetC' -> SERVER_ADDRESS/24
  673. Having an empty rule list is equivalent to either using ``'allow %
  674. from all'`` if your rule order is set to ``'deny,allow'`` or ``'deny %
  675. from all'`` if your rule order is set to ``'allow,deny'`` or
  676. ``'explicit'``.
  677. For the :term:`IP address` matching
  678. system, the following work:
  679. * ``xxx.xxx.xxx.xxx`` (an exact :term:`IP address`)
  680. * ``xxx.xxx.xxx.[yyy-zzz]`` (an :term:`IP address` range)
  681. * ``xxx.xxx.xxx.xxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IP` addresses)
  682. But the following does not work:
  683. * ``xxx.xxx.xxx.xx[yyy-zzz]`` (partial :term:`IP` address range)
  684. For :term:`IPv6` addresses, the following work:
  685. * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx`` (an exact :term:`IPv6` address)
  686. * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:[yyyy-zzzz]`` (an :term:`IPv6` address range)
  687. * ``xxxx:xxxx:xxxx:xxxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IPv6` addresses)
  688. But the following does not work:
  689. * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xx[yyy-zzz]`` (partial :term:`IPv6` address range)
  690. .. config:option:: $cfg['Servers'][$i]['SignonScript']
  691. :type: string
  692. :default: ``''``
  693. Name of PHP script to be sourced and executed to obtain login
  694. credentials. This is alternative approach to session based single
  695. signon. The script needs to provide function
  696. ``get_login_credentials`` which returns list of username and
  697. password, accepting single parameter of existing username (can be
  698. empty). See :file:`examples/signon-script.php` for an example.
  699. .. config:option:: $cfg['Servers'][$i]['SignonSession']
  700. :type: string
  701. :default: ``''``
  702. Name of session which will be used for signon authentication method.
  703. You should use something different than ``phpMyAdmin``, because this
  704. is session which phpMyAdmin uses internally. Takes effect only if
  705. :config:option:`$cfg['Servers'][$i]['SignonScript']` is not configured.
  706. .. config:option:: $cfg['Servers'][$i]['SignonURL']
  707. :type: string
  708. :default: ``''``
  709. :term:`URL` where user will be redirected
  710. to log in for signon authentication method. Should be absolute
  711. including protocol.
  712. .. config:option:: $cfg['Servers'][$i]['LogoutURL']
  713. :type: string
  714. :default: ``''``
  715. :term:`URL` where user will be redirected
  716. after logout (doesn't affect config authentication method). Should be
  717. absolute including protocol.
  718. .. config:option:: $cfg['Servers'][$i]['StatusCacheDatabases']
  719. :type: array of strings
  720. :default: array()
  721. Enables caching of ``TABLE STATUS`` outputs for specific databases on
  722. this server (in some cases ``TABLE STATUS`` can be very slow, so you
  723. may want to cache it). APC is used (if the PHP extension is available,
  724. if not, this setting is ignored silently). You have to provide
  725. :config:option:`$cfg['Servers'][$i]['StatusCacheLifetime']`.
  726. .. config:option:: $cfg['Servers'][$i]['StatusCacheLifetime']
  727. :type: integer
  728. :default: 0
  729. Lifetime in seconds of the ``TABLE STATUS`` cache if
  730. :config:option:`$cfg['Servers'][$i]['StatusCacheDatabases']` is used.
  731. Generic settings
  732. ----------------
  733. .. config:option:: $cfg['ServerDefault']
  734. :type: integer
  735. :default: 1
  736. If you have more than one server configured, you can set
  737. :config:option:`$cfg['ServerDefault']` to any one of them to autoconnect to that
  738. server when phpMyAdmin is started, or set it to 0 to be given a list
  739. of servers without logging in.
  740. If you have only one server configured,
  741. :config:option:`$cfg['ServerDefault']` MUST be set to that server.
  742. .. config:option:: $cfg['VersionCheck']
  743. :type: boolean
  744. :default: true
  745. Enables check for latest versions using javascript on main phpMyAdmin
  746. page.
  747. .. note::
  748. This setting can be adjusted by your vendor.
  749. .. config:option:: $cfg['ProxyUrl']
  750. :type: string
  751. :default: ""
  752. The url of the proxy to be used when phpmyadmin needs to access the outside
  753. intenet such as when retrieving the latest version info or submitting error
  754. reports. You need this if the server where phpMyAdmin is installed does not
  755. have direct access to the internet.
  756. The format is: "hostname:portnumber"
  757. .. config:option:: $cfg['ProxyUser']
  758. :type: string
  759. :default: ""
  760. The username for authenticating with the proxy. By default, no
  761. authentication is performed. If a username is supplied, Basic
  762. Authentication will be performed. No other types of authentication
  763. are currently supported.
  764. .. config:option:: $cfg['ProxyPass']
  765. :type: string
  766. :default: ""
  767. The password for authenticating with the proxy.
  768. .. config:option:: $cfg['MaxDbList']
  769. :type: integer
  770. :default: 100
  771. The maximum number of database names to be displayed in the main panel's
  772. database list.
  773. .. config:option:: $cfg['MaxTableList']
  774. :type: integer
  775. :default: 250
  776. The maximum number of table names to be displayed in the main panel's
  777. list (except on the Export page). This limit is also enforced in the
  778. navigation panel when in Light mode.
  779. .. config:option:: $cfg['ShowHint']
  780. :type: boolean
  781. :default: true
  782. Whether or not to show hints (for example, hints when hovering over
  783. table headers).
  784. .. config:option:: $cfg['MaxCharactersInDisplayedSQL']
  785. :type: integer
  786. :default: 1000
  787. The maximum number of characters when a :term:`SQL` query is displayed. The
  788. default limit of 1000 should be correct to avoid the display of tons of
  789. hexadecimal codes that represent BLOBs, but some users have real
  790. :term:`SQL` queries that are longer than 1000 characters. Also, if a
  791. query's length exceeds this limit, this query is not saved in the history.
  792. .. config:option:: $cfg['PersistentConnections']
  793. :type: boolean
  794. :default: false
  795. Whether `persistent connections <http://php.net/manual/en/features
  796. .persistent-connections.php>`_ should be used or not. Works with
  797. following extensions:
  798. * mysql (`mysql\_pconnect <http://php.net/manual/en/function.mysql-
  799. pconnect.php>`_),
  800. * mysqli (requires PHP 5.3.0 or newer, `more information
  801. <http://php.net/manual/en/mysqli.persistconns.php>`_).
  802. .. config:option:: $cfg['ForceSSL']
  803. :type: boolean
  804. :default: false
  805. Whether to force using https while accessing phpMyAdmin.
  806. .. note::
  807. In some setups (like separate SSL proxy or load balancer) you might
  808. have to set :config:option:`$cfg['PmaAbsoluteUri']` for correct
  809. redirection.
  810. .. config:option:: $cfg['ExecTimeLimit']
  811. :type: integer [number of seconds]
  812. :default: 300
  813. Set the number of seconds a script is allowed to run. If seconds is
  814. set to zero, no time limit is imposed. This setting is used while
  815. importing/exporting dump files but has
  816. no effect when PHP is running in safe mode.
  817. .. config:option:: $cfg['SessionSavePath']
  818. :type: string
  819. :default: ``''``
  820. Path for storing session data (`session\_save\_path PHP parameter
  821. <http://php.net/session_save_path>`_).
  822. .. config:option:: $cfg['MemoryLimit']
  823. :type: string [number of bytes]
  824. :default: ``'-1'``
  825. Set the number of bytes a script is allowed to allocate. If set to
  826. ``'-1'``, no limit is imposed.
  827. This setting is used while importing/exporting dump files and at some other
  828. places in phpMyAdmin so you definitely don't want to put here a too low
  829. value. It has no effect when PHP is running in safe mode.
  830. You can also use any string as in :file:`php.ini`, eg. '16M'. Ensure you
  831. don't omit the suffix (16 means 16 bytes!)
  832. .. config:option:: $cfg['SkipLockedTables']
  833. :type: boolean
  834. :default: false
  835. Mark used tables and make it possible to show databases with locked
  836. tables (since MySQL 3.23.30).
  837. .. config:option:: $cfg['ShowSQL']
  838. :type: boolean
  839. :default: true
  840. Defines whether :term:`SQL` queries
  841. generated by phpMyAdmin should be displayed or not.
  842. .. config:option:: $cfg['RetainQueryBox']
  843. :type: boolean
  844. :default: false
  845. Defines whether the :term:`SQL` query box
  846. should be kept displayed after its submission.
  847. .. config:option:: $cfg['CodemirrorEnable']
  848. :type: boolean
  849. :default: true
  850. Defines whether to use a Javascript code editor for SQL query boxes.
  851. CodeMirror provides syntax highlighting and line numbers. However,
  852. middle-clicking for pasting the clipboard contents in some Linux
  853. distributions (such as Ubuntu) is not supported by all browsers.
  854. .. config:option:: $cfg['AllowUserDropDatabase']
  855. :type: boolean
  856. :default: false
  857. Defines whether normal users (non-administrator) are allowed to delete
  858. their own database or not. If set as false, the link :guilabel:`Drop
  859. Database` will not be shown, and even a ``DROP DATABASE mydatabase`` will
  860. be rejected. Quite practical for :term:`ISP` 's with many customers.
  861. .. note::
  862. This limitation of :term:`SQL` queries is not
  863. as strict as when using MySQL privileges. This is due to nature of
  864. :term:`SQL` queries which might be quite
  865. complicated. So this choice should be viewed as help to avoid accidental
  866. dropping rather than strict privilege limitation.
  867. .. config:option:: $cfg['Confirm']
  868. :type: boolean
  869. :default: true
  870. Whether a warning ("Are your really sure...") should be displayed when
  871. you're about to lose data.
  872. .. config:option:: $cfg['UseDbSearch']
  873. :type: boolean
  874. :default: true
  875. Define whether the "search string inside database" is enabled or not.
  876. .. config:option:: $cfg['IgnoreMultiSubmitErrors']
  877. :type: boolean
  878. :default: false
  879. Define whether phpMyAdmin will continue executing a multi-query
  880. statement if one of the queries fails. Default is to abort execution.
  881. Cookie authentication options
  882. -----------------------------
  883. .. config:option:: $cfg['blowfish_secret']
  884. :type: string
  885. :default: ``''``
  886. The "cookie" auth\_type uses blowfish algorithm to encrypt the
  887. password. If you are using the "cookie" auth\_type, enter here a
  888. random passphrase of your choice. It will be used internally by the
  889. blowfish algorithm: you won’t be prompted for this passphrase. There
  890. is no maximum length for this secret.
  891. .. versionchanged:: 3.1.0
  892. Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
  893. makes a bit weaker security as this generated secret is stored in
  894. session and furthermore it makes impossible to recall user name from
  895. cookie.
  896. .. config:option:: $cfg['LoginCookieRecall']
  897. :type: boolean
  898. :default: true
  899. Define whether the previous login should be recalled or not in cookie
  900. authentication mode.
  901. This is automatically disabled if you do not have
  902. configured :config:option:`$cfg['blowfish_secret']`.
  903. .. config:option:: $cfg['LoginCookieValidity']
  904. :type: integer [number of seconds]
  905. :default: 1440
  906. Define how long a login cookie is valid. Please note that php
  907. configuration option `session.gc\_maxlifetime
  908. <http://php.net/manual/en/session.configuration.php#ini.session.gc-
  909. maxlifetime>`_ might limit session validity and if the session is lost,
  910. the login cookie is also invalidated. So it is a good idea to set
  911. ``session.gc_maxlifetime`` at least to the same value of
  912. :config:option:`$cfg['LoginCookieValidity']`.
  913. .. config:option:: $cfg['LoginCookieStore']
  914. :type: integer [number of seconds]
  915. :default: 0
  916. Define how long login cookie should be stored in browser. Default 0
  917. means that it will be kept for existing session. This is recommended
  918. for not trusted environments.
  919. .. config:option:: $cfg['LoginCookieDeleteAll']
  920. :type: boolean
  921. :default: true
  922. If enabled (default), logout deletes cookies for all servers,
  923. otherwise only for current one. Setting this to false makes it easy to
  924. forget to log out from other server, when you are using more of them.
  925. .. _AllowArbitraryServer:
  926. .. config:option:: $cfg['AllowArbitraryServer']
  927. :type: boolean
  928. :default: false
  929. If enabled, allows you to log in to arbitrary servers using cookie
  930. authentication.
  931. .. note::
  932. Please use this carefully, as this may allow users access to MySQL servers
  933. behind the firewall where your :term:`HTTP`
  934. server is placed.
  935. .. config:option:: $cfg['CaptchaLoginPublicKey']
  936. :type: string
  937. :default: ``''``
  938. The public key for the reCaptcha service that can be obtain from
  939. http://www.google.com/recaptcha.
  940. reCaptcha will be then used in :ref:`cookie`.
  941. .. config:option:: $cfg['CaptchaLoginPrivateKey']
  942. :type: string
  943. :default: ``''``
  944. The private key for the reCaptcha service that can be obtain from
  945. http://www.google.com/recaptcha.
  946. reCaptcha will be then used in :ref:`cookie`.
  947. Navigation panel setup
  948. ----------------------
  949. .. config:option:: $cfg['FirstLevelNavigationItems']
  950. :type: integer
  951. :default: 250
  952. The number of first level databases that can be displayed on each page
  953. of navigation tree.
  954. .. config:option:: $cfg['MaxNavigationItems']
  955. :type: integer
  956. :default: 50
  957. The number of items (tables, columns, indexes) that can be displayed on each
  958. page of the navigation tree.
  959. .. config:option:: $cfg['NavigationTreeEnableGrouping']
  960. :type: boolean
  961. :default: true
  962. Defines whether to group the databases based on a common prefix
  963. in their name :config:option:`$cfg['NavigationTreeDbSeparator']`.
  964. .. config:option:: $cfg['NavigationTreeDbSeparator']
  965. :type: string or array
  966. :default: ``'_'``
  967. The string used to separate the parts of the database name when
  968. showing them in a tree. Alternatively you can specify more strings in
  969. an array and all of them will be used as a separator.
  970. .. config:option:: $cfg['NavigationTreeTableSeparator']
  971. :type: string or array
  972. :default: ``'__'``
  973. Defines a string to be used to nest table spaces. This means if you have
  974. tables like ``first__second__third`` this will be shown as a three-level
  975. hierarchy like: first > second > third. If set to false or empty, the
  976. feature is disabled. NOTE: You should not use this separator at the
  977. beginning or end of a table name or multiple times after another without
  978. any other characters in between.
  979. .. config:option:: $cfg['NavigationTreeTableLevel']
  980. :type: integer
  981. :default: 1
  982. Defines how many sublevels should be displayed when splitting up
  983. tables by the above separator.
  984. .. config:option:: $cfg['NumRecentTables']
  985. :type: integer
  986. :default: 10
  987. The maximum number of recently used tables shown in the navigation
  988. panel. Set this to 0 (zero) to disable the listing of recent tables.
  989. .. config:option:: $cfg['NavigationDisplayLogo']
  990. :type: boolean
  991. :default: true
  992. Defines whether or not to display the phpMyAdmin logo at the top of
  993. the navigation panel.
  994. .. config:option:: $cfg['NavigationLogoLink']
  995. :type: string
  996. :default: ``'index.php'``
  997. Enter :term:`URL` where logo in the
  998. navigation panel will point to. For use especially with self made
  999. theme which changes this.
  1000. .. config:option:: $cfg['NavigationLogoLinkWindow']
  1001. :type: string
  1002. :default: ``'main'``
  1003. Whether to open the linked page in the main window (``main``) or in a
  1004. new one (``new``). Note: use ``new`` if you are linking to
  1005. ``phpmyadmin.net``.
  1006. .. config:option:: $cfg['NavigationTreeDisplayItemFilterMinimum']
  1007. :type: integer
  1008. :default: 30
  1009. Defines the minimum number of items (tables, views, routines and
  1010. events) to display a JavaScript filter box above the list of items in
  1011. the navigation tree.
  1012. To disable the filter completely some high number can be used (e.g. 9999)
  1013. .. config:option:: $cfg['NavigationTreeDisplayDbFilterMinimum']
  1014. :type: integer
  1015. :default: 30
  1016. Defines the minimum number of databases to display a JavaScript filter
  1017. box above the list of databases in the navigation tree.
  1018. To disable the filter completely some high number can be used
  1019. (e.g. 9999)
  1020. .. config:option:: $cfg['NavigationDisplayServers']
  1021. :type: boolean
  1022. :default: true
  1023. Defines whether or not to display a server choice at the top of the
  1024. navigation panel.
  1025. .. config:option:: $cfg['DisplayServersList']
  1026. :type: boolean
  1027. :default: false
  1028. Defines whether to display this server choice as links instead of in a
  1029. drop-down.
  1030. .. config:option:: $cfg['NavigationTreeDefaultTabTable']
  1031. :type: string
  1032. :default: ``'tbl_structure.php'``
  1033. Defines the tab displayed by default when clicking the small icon next
  1034. to each table name in the navigation panel. Possible values:
  1035. * ``tbl_structure.php``
  1036. * ``tbl_sql.php``
  1037. * ``tbl_select.php``
  1038. * ``tbl_change.php``
  1039. * ``sql.php``
  1040. .. config:option:: $cfg['NavigationTreeDisableDatabaseExpansion']
  1041. :type: boolean
  1042. :default: false
  1043. Whether or not to disable the possibility of databases expansion in the navigation panel
  1044. Main panel
  1045. ----------
  1046. .. config:option:: $cfg['ShowStats']
  1047. :type: boolean
  1048. :default: true
  1049. Defines whether or not to display space usage and statistics about
  1050. databases and tables. Note that statistics requires at least MySQL
  1051. 3.23.3 and that, at this date, MySQL doesn't return such information
  1052. for Berkeley DB tables.
  1053. .. config:option:: $cfg['ShowServerInfo']
  1054. :type: boolean
  1055. :default: true
  1056. Defines whether to display detailed server information on main page.
  1057. You can additionally hide more information by using
  1058. :config:option:`$cfg['Servers'][$i]['verbose']`.
  1059. .. config:option:: $cfg['ShowPhpInfo']
  1060. :type: boolean
  1061. :default: false
  1062. .. config:option:: $cfg['ShowChgPassword']
  1063. :type: boolean
  1064. :default: true
  1065. .. config:option:: $cfg['ShowCreateDb']
  1066. :type: boolean
  1067. :default: true
  1068. Defines whether to display the :guilabel:`PHP information` and
  1069. :guilabel:`Change password` links and form for creating database or not at
  1070. the starting main (right) frame. This setting does not check MySQL commands
  1071. entered directly.
  1072. Please note that to block the usage of ``phpinfo()`` in scripts, you have to
  1073. put this in your :file:`php.ini`:
  1074. .. code-block:: ini
  1075. disable_functions = phpinfo()
  1076. Also note that enabling the :guilabel:`Change password` link has no effect
  1077. with config authentication mode: because of the hard coded password value
  1078. in the configuration file, end users can't be allowed to change their
  1079. passwords.
  1080. Database structure
  1081. ------------------
  1082. .. config:option:: $cfg['ShowDbStructureCreation']
  1083. :type: boolean
  1084. :default: false
  1085. Defines whether the database structure page (tables list) has a
  1086. "Creation" column that displays when each table was created.
  1087. .. config:option:: $cfg['ShowDbStructureLastUpdate']
  1088. :type: boolean
  1089. :default: false
  1090. Defines whether the database structure page (tables list) has a "Last
  1091. update" column that displays when each table was last updated.
  1092. .. config:option:: $cfg['ShowDbStructureLastCheck']
  1093. :type: boolean
  1094. :default: false
  1095. Defines whether the database structure page (tables list) has a "Last
  1096. check" column that displays when each table was last checked.
  1097. .. config:option:: $cfg['HideStructureActions']
  1098. :type: boolean
  1099. :default: true
  1100. Defines whether the table structure actions are hidden under a "More"
  1101. drop-down.
  1102. Browse mode
  1103. -----------
  1104. .. config:option:: $cfg['TableNavigationLinksMode']
  1105. :type: string
  1106. :default: ``'icons'``
  1107. Defines whether the table navigation links contain ``'icons'``, ``'text'``
  1108. or ``'both'``.
  1109. .. config:option:: $cfg['ShowAll']
  1110. :type: boolean
  1111. :default: false
  1112. Defines whether a user should be displayed a "Show all" button in browse
  1113. mode or not in all cases. By default it is shown only on small tables (less
  1114. than 500 rows) to avoid performance issues while getting too many rows.
  1115. .. config:option:: $cfg['MaxRows']
  1116. :type: integer
  1117. :default: 25
  1118. Number of rows displayed when browsing a result set and no LIMIT
  1119. clause is used. If the result set contains more rows, "Previous" and
  1120. "Next" links will be shown. Possible values: 25,50,100,250,500.
  1121. .. config:option:: $cfg['Order']
  1122. :type: string
  1123. :default: ``'SMART'``
  1124. Defines whether columns are displayed in ascending (``ASC``) order, in
  1125. descending (``DESC``) order or in a "smart" (``SMART``) order - I.E.
  1126. descending order for columns of type TIME, DATE, DATETIME and
  1127. TIMESTAMP, ascending order else- by default.
  1128. .. config:option:: $cfg['DisplayBinaryAsHex']
  1129. :type: boolean
  1130. :default: true
  1131. Defines whether the "Show binary contents as HEX" browse option is
  1132. ticked by default.
  1133. .. config:option:: $cfg['GridEditing']
  1134. :type: string
  1135. :default: ``'double-click'``
  1136. Defines which action (``double-click`` or ``click``) triggers grid
  1137. editing. Can be deactived with the ``disabled`` value.
  1138. .. config:option:: $cfg['SaveCellsAtOnce']
  1139. :type: boolean
  1140. :default: false
  1141. Defines whether or not to save all edited cells at once for grid
  1142. editing.
  1143. Editing mode
  1144. ------------
  1145. .. config:option:: $cfg['ProtectBinary']
  1146. :type: boolean or string
  1147. :default: ``'blob'``
  1148. Defines whether ``BLOB`` or ``BINARY`` columns are protected from
  1149. editing when browsing a table's content. Valid values are:
  1150. * ``false`` to allow editing of all columns;
  1151. * ``'blob'`` to allow editing of all columns except ``BLOBS``;
  1152. * ``'noblob'`` to disallow editing of all columns except ``BLOBS`` (the
  1153. opposite of ``'blob'``);
  1154. * ``'all'`` to disallow editing of all ``BINARY`` or ``BLOB`` columns.
  1155. .. config:option:: $cfg['ShowFunctionFields']
  1156. :type: boolean
  1157. :default: true
  1158. Defines whether or not MySQL functions fields should be initially
  1159. displayed in edit/insert mode. Since version 2.10, the user can toggle
  1160. this setting from the interface.
  1161. .. config:option:: $cfg['ShowFieldTypesInDataEditView']
  1162. :type: boolean
  1163. :default: true
  1164. Defines whether or not type fields should be initially displayed in
  1165. edit/insert mode. The user can toggle this setting from the interface.
  1166. .. config:option:: $cfg['InsertRows']
  1167. :type: integer
  1168. :default: 2
  1169. Defines the maximum number of concurrent entries for the Insert page.
  1170. .. config:option:: $cfg['ForeignKeyMaxLimit']
  1171. :type: integer
  1172. :default: 100
  1173. If there are fewer items than this in the set of foreign keys, then a
  1174. drop-down box of foreign keys is presented, in the style described by
  1175. the :config:option:`$cfg['ForeignKeyDropdownOrder']` setting.
  1176. .. config:option:: $cfg['ForeignKeyDropdownOrder']
  1177. :type: array
  1178. :default: array('content-id', 'id-content')
  1179. For the foreign key drop-down fields, there are several methods of
  1180. display, offering both the key and value data. The contents of the
  1181. array should be one or both of the following strings: ``content-id``,
  1182. ``id-content``.
  1183. Export and import settings
  1184. --------------------------
  1185. .. config:option:: $cfg['ZipDump']
  1186. :type: boolean
  1187. :default: true
  1188. .. config:option:: $cfg['GZipDump']
  1189. :type: boolean
  1190. :default: true
  1191. .. config:option:: $cfg['BZipDump']
  1192. :type: boolean
  1193. :default: true
  1194. Defines whether to allow the use of zip/GZip/BZip2 compression when
  1195. creating a dump file
  1196. .. config:option:: $cfg['CompressOnFly']
  1197. :type: boolean
  1198. :default: true
  1199. Defines whether to allow on the fly compression for GZip/BZip2
  1200. compressed exports. This doesn't affect smaller dumps and allows users
  1201. to create larger dumps that won't otherwise fit in memory due to php
  1202. memory limit. Produced files contain more GZip/BZip2 headers, but all
  1203. normal programs handle this correctly.
  1204. .. config:option:: $cfg['Export']
  1205. :type: array
  1206. :default: array(...)
  1207. In this array are defined default parameters for export, names of
  1208. items are similar to texts seen on export page, so you can easily
  1209. identify what they mean.
  1210. .. config:option:: $cfg['Export']['method']
  1211. :type: string
  1212. :default: ``'quick'``
  1213. Defines how the export form is displayed when it loads. Valid values
  1214. are:
  1215. * ``quick`` to display the minimum number of options to configure
  1216. * ``custom`` to display every available option to configure
  1217. * ``custom-no-form`` same as ``custom`` but does not display the option
  1218. of using quick export
  1219. .. config:option:: $cfg['Import']
  1220. :type: array
  1221. :default: array(...)
  1222. In this array are defined default parameters for import, names of
  1223. items are similar to texts seen on import page, so you can easily
  1224. identify what they mean.
  1225. Tabs display settings
  1226. ---------------------
  1227. .. config:option:: $cfg['TabsMode']
  1228. :type: string
  1229. :default: ``'both'``
  1230. Defines whether the menu tabs contain ``'icons'``, ``'text'`` or ``'both'``.
  1231. .. config:option:: $cfg['ActionLinksMode']
  1232. :type: string
  1233. :default: ``'both'``
  1234. If set to ``icons``, will display icons instead of text for db and table
  1235. properties links (like :guilabel:`Browse`, :guilabel:`Select`,
  1236. :guilabel:`Insert`, ...). Can be set to ``'both'``
  1237. if you want icons AND text. When set to ``text``, will only show text.
  1238. .. config:option:: $cfg['PropertiesNumColumns']
  1239. :type: integer
  1240. :default: 1
  1241. How many columns will be utilized to display the tables on the database
  1242. property view? When setting this to a value larger than 1, the type of the
  1243. database will be omitted for more display space.
  1244. .. config:option:: $cfg['DefaultTabServer']
  1245. :type: string
  1246. :default: ``'index.php'``
  1247. Defines the tab displayed by default on server view. Possible values:
  1248. * ``main.php`` (recommended for multi-user setups)
  1249. * ``server_databases.php``,
  1250. * ``server_status.php``
  1251. * ``server_variables.php``
  1252. * ``server_privileges.php``
  1253. .. config:option:: $cfg['DefaultTabDatabase']
  1254. :type: string
  1255. :default: ``'db_structure.php'``
  1256. Defines the tab displayed by default on database view. Possible
  1257. values:
  1258. * ``db_structure.php``
  1259. * ``db_sql.php``
  1260. * ``db_search.php``.
  1261. .. config:option:: $cfg['DefaultTabTable']
  1262. :type: string
  1263. :default: ``'sql.php'``
  1264. Defines the tab displayed by default on table view. Possible values:
  1265. * ``tbl_structure.php``
  1266. * ``tbl_sql.php``
  1267. * ``tbl_select.php``
  1268. * ``tbl_change.php``
  1269. * ``sql.php``
  1270. PDF Options
  1271. -----------
  1272. .. config:option:: $cfg['PDFPageSizes']
  1273. :type: array
  1274. :default: ``array('A3', 'A4', 'A5', 'letter', 'legal')``
  1275. Array of possible paper sizes for creating PDF pages.
  1276. You should never need to change this.
  1277. .. config:option:: $cfg['PDFDefaultPageSize']
  1278. :type: string
  1279. :default: ``'A4'``
  1280. Default page size to use when creating PDF pages. Valid values are any
  1281. listed in :config:option:`$cfg['PDFPageSizes']`.
  1282. Languages
  1283. ---------
  1284. .. config:option:: $cfg['DefaultLang']
  1285. :type: string
  1286. :default: ``'en'``
  1287. Defines the default language to use, if not browser-defined or user-
  1288. defined. The corresponding language file needs to be in
  1289. locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
  1290. .. config:option:: $cfg['DefaultConnectionCollation']
  1291. :type: string
  1292. :default: ``'utf8_general_ci'``
  1293. Defines the default connection collation to use, if not user-defined.
  1294. See the `MySQL documentation <http://dev.mysql.com/doc/mysql/en
  1295. /charset-charsets.html>`_ for list of possible values. This setting is
  1296. ignored when connected to Drizzle server.
  1297. .. config:option:: $cfg['Lang']
  1298. :type: string
  1299. :default: not set
  1300. Force language to use. The corresponding language file needs to be in
  1301. locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
  1302. .. config:option:: $cfg['FilterLanguages']
  1303. :type: string
  1304. :default: ``''``
  1305. Limit list of available languages to those matching the given regular
  1306. expression. For example if you want only Czech and English, you should
  1307. set filter to ``'^(cs|en)'``.
  1308. .. config:option:: $cfg['RecodingEngine']
  1309. :type: string
  1310. :default: ``'auto'``
  1311. You can select here which functions will be used for character set
  1312. conversion. Possible values are:
  1313. * auto - automatically use available one (first is tested iconv, then
  1314. recode)
  1315. * iconv - use iconv or libiconv functions
  1316. * recode - use recode\_string function
  1317. * mb - use mbstring extension
  1318. * none - disable encoding conversion
  1319. Enabled charset conversion activates a pull-down menu in the Export
  1320. and Import pages, to choose the character set when exporting a file.
  1321. The default value in this menu comes from
  1322. :config:option:`$cfg['Export']['charset']` and :config:option:`$cfg['Import']['charset']`.
  1323. .. config:option:: $cfg['IconvExtraParams']
  1324. :type: string
  1325. :default: ``'//TRANSLIT'``
  1326. Specify some parameters for iconv used in charset conversion. See
  1327. `iconv documentation <http://www.gnu.org/software/libiconv/documentati
  1328. on/libiconv/iconv_open.3.html>`_ for details. By default
  1329. ``//TRANSLIT`` is used, so that invalid characters will be
  1330. transliterated.
  1331. .. config:option:: $cfg['AvailableCharsets']
  1332. :type: array
  1333. :default: array(..._
  1334. Available character sets for MySQL conversion. You can add your own
  1335. (any of supported by recode/iconv) or remove these which you don't
  1336. use. Character sets will be shown in same order as here listed, so if
  1337. you frequently use some of these move them to the top.
  1338. Web server settings
  1339. -------------------
  1340. .. config:option:: $cfg['OBGzip']
  1341. :type: string/boolean
  1342. :default: ``'auto'``
  1343. Defines whether to use GZip output buffering for increased speed in
  1344. :term:`HTTP` transfers. Set to
  1345. true/false for enabling/disabling. When set to 'auto' (string),
  1346. phpMyAdmin tries to enable output buffering and will automatically
  1347. disable it if your browser has some problems with buffering. IE6 with
  1348. a certain patch is known to cause data corruption when having enabled
  1349. buffering.
  1350. .. config:option:: $cfg['TrustedProxies']
  1351. :type: array
  1352. :default: array()
  1353. Lists proxies and HTTP headers which are trusted for
  1354. :config:option:`$cfg['Servers'][$i]['AllowDeny']['order']`. This list is by
  1355. default empty, you need to fill in some trusted proxy servers if you
  1356. want to use rules for IP addresses behind proxy.
  1357. The following example specifies that phpMyAdmin should trust a
  1358. HTTP\_X\_FORWARDED\_FOR (``X -Forwarded-For``) header coming from the proxy
  1359. 1.2.3.4:
  1360. .. code-block:: php
  1361. $cfg['TrustedProxies'] = array('1.2.3.4' => 'HTTP_X_FORWARDED_FOR');
  1362. The :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` directive uses the
  1363. client's IP address as usual.
  1364. .. config:option:: $cfg['GD2Available']
  1365. :type: string
  1366. :default: ``'auto'``
  1367. Specifies whether GD >= 2 is available. If yes it can be used for MIME
  1368. transformations. Possible values are:
  1369. * auto - automatically detect
  1370. * yes - GD 2 functions can be used
  1371. * no - GD 2 function cannot be used
  1372. .. config:option:: $cfg['CheckConfigurationPermissions']
  1373. :type: boolean
  1374. :default: true
  1375. We normally check the permissions on the configuration file to ensure
  1376. it's not world writable. However, phpMyAdmin could be installed on a
  1377. NTFS filesystem mounted on a non-Windows server, in which case the
  1378. permissions seems wrong but in fact cannot be detected. In this case a
  1379. sysadmin would set this parameter to ``false``.
  1380. .. config:option:: $cfg['LinkLengthLimit']
  1381. :type: integer
  1382. :default: 1000
  1383. Limit for length of :term:`URL` in links. When length would be above this
  1384. limit, it is replaced by form with button. This is required as some web
  1385. servers (:term:`IIS`) have problems with long :term:`URL` .
  1386. .. config:option:: $cfg['CSPAllow']
  1387. :type: string
  1388. :default: ``''``
  1389. Additional string to include in allowed script and image sources in Content
  1390. Security Policy header.
  1391. This can be useful when you want to include some external javascript files
  1392. in :file:`config.footer.inc.php` or :file:`config.header.inc.php`, which
  1393. would be normally not allowed by Content Security Policy.
  1394. To allow some sites, just list them within the string:
  1395. .. code-block:: php
  1396. $cfg['CSPAllow'] = 'example.com example.net';
  1397. .. versionadded:: 4.0.4
  1398. .. config:option:: $cfg['DisableMultiTableMaintenance']
  1399. :type: boolean
  1400. :default: false
  1401. In the database Structure page, it's possible to mark some tables then
  1402. choose an operation like optimizing for many tables. This can slow
  1403. down a server; therefore, setting this to ``true`` prevents this kind
  1404. of multiple maintenance operation.
  1405. Theme settings
  1406. --------------
  1407. .. config:option:: $cfg['NaviWidth']
  1408. :type: integer
  1409. :default:
  1410. Navigation panel width in pixels. See
  1411. :file:`themes/themename/layout.inc.php`.
  1412. .. config:option:: $cfg['NaviBackground']
  1413. :type: string [CSS color for background]
  1414. :default:
  1415. .. config:option:: $cfg['MainBackground']
  1416. :type: string [CSS color for background]
  1417. :default:
  1418. The background styles used for both the frames. See
  1419. :file:`themes/themename/layout.inc.php`.
  1420. .. config:option:: $cfg['NaviPointerBackground']
  1421. :type: string [CSS color for background]
  1422. :default:
  1423. .. config:option:: $cfg['NaviPointerColor']
  1424. :type: string [CSS color]
  1425. :default:
  1426. The style used for the pointer in the navigation panel. See
  1427. :file:`themes/themename/layout.inc.php`.
  1428. .. config:option:: $cfg['Border']
  1429. :type: integer
  1430. :default:
  1431. The size of a table's border. See :file:`themes/themename/layout.inc.php`.
  1432. .. config:option:: $cfg['ThBackground']
  1433. :type: string [CSS color for background]
  1434. :default:
  1435. .. config:option:: $cfg['ThColor']
  1436. :type: string [CSS color]
  1437. :default:
  1438. The style used for table headers. See
  1439. :file:`themes/themename/layout.inc.php`.
  1440. .. _cfg_BgcolorOne:
  1441. .. config:option:: $cfg['BgOne']
  1442. :type: string [CSS color]
  1443. :default:
  1444. The color (HTML) #1 for table rows. See
  1445. :file:`themes/themename/layout.inc.php`.
  1446. .. _cfg_BgcolorTwo:
  1447. .. config:option:: $cfg['BgTwo']
  1448. :type: string [CSS color]
  1449. :default:
  1450. The color (HTML) #2 for table rows. See
  1451. :file:`themes/themename/layout.inc.php`.
  1452. .. config:option:: $cfg['BrowsePointerBackground']
  1453. :type: string [CSS color]
  1454. :default:
  1455. .. config:option:: $cfg['BrowsePointerColor']
  1456. :type: string [CSS color]
  1457. :default:
  1458. .. config:option:: $cfg['BrowseMarkerBackground']
  1459. :type: string [CSS color]
  1460. :default:
  1461. .. config:option:: $cfg['BrowseMarkerColor']
  1462. :type: string [CSS color]
  1463. :default:
  1464. The colors (HTML) uses for the pointer and the marker in browse mode.
  1465. The former feature highlights the row over which your mouse is passing
  1466. and the latter lets you visually mark/unmark rows by clicking on the
  1467. corresponding checkbox. Highlighting / marking a column is done by
  1468. hovering over / clicking the column's header (outside of the text).
  1469. See :file:`themes/themename/layout.inc.php`.
  1470. .. config:option:: $cfg['FontFamily']
  1471. :type: string
  1472. :default:
  1473. You put here a valid CSS font family value, for example ``arial, sans-
  1474. serif``. See :file:`themes/themename/layout.inc.php`.
  1475. .. config:option:: $cfg['FontFamilyFixed']
  1476. :type: string
  1477. :default:
  1478. You put here a valid CSS font family value, for example ``monospace``.
  1479. This one is used in textarea. See :file:`themes/themename/layout.inc.php`.
  1480. Design customization
  1481. --------------------
  1482. .. config:option:: $cfg['NavigationTreePointerEnable']
  1483. :type: boolean
  1484. :default: true
  1485. A value of ``true`` activates the navi pointer.
  1486. .. config:option:: $cfg['BrowsePointerEnable']
  1487. :type: boolean
  1488. :default: true
  1489. Whether to activate the browse pointer or not.
  1490. .. config:option:: $cfg['BrowseMarkerEnable']
  1491. :type: boolean
  1492. :default: true
  1493. Whether to activate the browse marker or not.
  1494. .. config:option:: $cfg['LimitChars']
  1495. :type: integer
  1496. :default: 50
  1497. Maximum number of characters shown in any non-numeric field on browse
  1498. view. Can be turned off by a toggle button on the browse page.
  1499. .. config:option:: $cfg['RowActionLinks']
  1500. :type: string
  1501. :default: ``'left'``
  1502. Defines the place where table row links (Edit, Copy, Delete) would be
  1503. put when tables contents are displayed (you may have them displayed at
  1504. the left side, right side, both sides or nowhere). "left" and "right"
  1505. are parsed as "top" and "bottom" with vertical display mode.
  1506. .. config:option:: $cfg['DefaultDisplay']
  1507. :type: string
  1508. :default: ``'horizonta'``
  1509. There are 3 display modes: horizontal, horizontalflipped and vertical.
  1510. Define which one is displayed by default. The first mode displays each
  1511. row on a horizontal line, the second rotates the headers by 90
  1512. degrees, so you can use descriptive headers even though columns only
  1513. contain small values and still print them out. The vertical mode sorts
  1514. each row on a vertical lineup.
  1515. .. config:option:: $cfg['RememberSorting']
  1516. :type: boolean
  1517. :default: true
  1518. If enabled, remember the sorting of each table when browsing them.
  1519. .. config:option:: $cfg['HeaderFlipType']
  1520. :type: string
  1521. :default: ``'auto'``
  1522. The HeaderFlipType can be set to 'auto', 'css' or 'fake'. When using
  1523. 'css' the rotation of the header for horizontalflipped is done via
  1524. CSS. The CSS transformation currently works only in Internet
  1525. Explorer.If set to 'fake' PHP does the transformation for you, but of
  1526. course this does not look as good as CSS. The 'auto' option enables
  1527. CSS transformation when browser supports it and use PHP based one
  1528. otherwise.
  1529. .. config:option:: $cfg['ShowBrowseComments']
  1530. :type: boolean
  1531. :default: true
  1532. .. config:option:: $cfg['ShowPropertyComments']
  1533. :type: boolean
  1534. :default: true
  1535. By setting the corresponding variable to ``true`` you can enable the
  1536. display of column comments in Browse or Property display. In browse
  1537. mode, the comments are shown inside the header. In property mode,
  1538. comments are displayed using a CSS-formatted dashed-line below the
  1539. name of the column. The comment is shown as a tool-tip for that
  1540. column.
  1541. Text fields
  1542. -----------
  1543. .. config:option:: $cfg['CharEditing']
  1544. :type: string
  1545. :default: ``'input'``
  1546. Defines which type of editing controls should be used for CHAR and
  1547. VARCHAR columns. Applies to data editing and also to the default values
  1548. in structure editing. Possible values are:
  1549. * input - this allows to limit size of text to size of columns in MySQL,
  1550. but has problems with newlines in columns
  1551. * textarea - no problems with newlines in columns, but also no length
  1552. limitations
  1553. .. config:option:: $cfg['MinSizeForInputField']
  1554. :type: integer
  1555. :default: 4
  1556. Defines the minimum size for input fields generated for CHAR and
  1557. VARCHAR columns.
  1558. .. config:option:: $cfg['MaxSizeForInputField']
  1559. :type: integer
  1560. :default: 60
  1561. Defines the maximum size for input fields generated for CHAR and
  1562. VARCHAR columns.
  1563. .. config:option:: $cfg['TextareaCols']
  1564. :type: integer
  1565. :default: 40
  1566. .. config:option:: $cfg['TextareaRows']
  1567. :type: integer
  1568. :default: 15
  1569. .. config:option:: $cfg['CharTextareaCols']
  1570. :type: integer
  1571. :default: 40
  1572. .. config:option:: $cfg['CharTextareaRows']
  1573. :type: integer
  1574. :default: 2
  1575. Number of columns and rows for the textareas. This value will be
  1576. emphasized (\*2) for :term:`SQL` query
  1577. textareas and (\*1.25) for :term:`SQL`
  1578. textareas inside the query window.
  1579. The Char\* values are used for CHAR
  1580. and VARCHAR editing (if configured via :config:option:`$cfg['CharEditing']`).
  1581. .. config:option:: $cfg['LongtextDoubleTextarea']
  1582. :type: boolean
  1583. :default: true
  1584. Defines whether textarea for LONGTEXT columns should have double size.
  1585. .. config:option:: $cfg['TextareaAutoSelect']
  1586. :type: boolean
  1587. :default: false
  1588. Defines if the whole textarea of the query box will be selected on
  1589. click.
  1590. SQL query box settings
  1591. ----------------------
  1592. .. config:option:: $cfg['SQLQuery']['Edit']
  1593. :type: boolean
  1594. :default: true
  1595. Whether to display an edit link to change a query in any SQL Query
  1596. box.
  1597. .. config:option:: $cfg['SQLQuery']['Explain']
  1598. :type: boolean
  1599. :default: true
  1600. Whether to display a link to explain a SELECT query in any SQL Query
  1601. box.
  1602. .. config:option:: $cfg['SQLQuery']['ShowAsPHP']
  1603. :type: boolean
  1604. :default: true
  1605. Whether to display a link to wrap a query in PHP code in any SQL Query
  1606. box.
  1607. .. config:option:: $cfg['SQLQuery']['Refresh']
  1608. :type: boolean
  1609. :default: true
  1610. Whether to display a link to refresh a query in any SQL Query box.
  1611. Web server upload/save/import directories
  1612. -----------------------------------------
  1613. .. config:option:: $cfg['UploadDir']
  1614. :type: string
  1615. :default: ``''``
  1616. The name of the directory where :term:`SQL` files have been uploaded by
  1617. other means than phpMyAdmin (for example, ftp). Those files are available
  1618. under a drop-down box when you click the database or table name, then the
  1619. Import tab.
  1620. If
  1621. you want different directory for each user, %u will be replaced with
  1622. username.
  1623. Please note that the file names must have the suffix ".sql"
  1624. (or ".sql.bz2" or ".sql.gz" if support for compressed formats is
  1625. enabled).
  1626. This feature is useful when your file is too big to be
  1627. uploaded via :term:`HTTP`, or when file
  1628. uploads are disabled in PHP.
  1629. .. note::
  1630. If PHP is running in safe mode, this directory must be owned by the same
  1631. user as the owner of the phpMyAdmin scripts. See also :ref:`faq1_16` for
  1632. alternatives.
  1633. .. config:option:: $cfg['SaveDir']
  1634. :type: string
  1635. :default: ``''``
  1636. The name of the directory where dumps can be saved.
  1637. If you want different directory for each user, %u will be replaced with
  1638. username.
  1639. Please note that the directory must exist and has to be writable for
  1640. the user running webserver.
  1641. .. note::
  1642. If PHP is running in safe mode, this directory must be owned by the same
  1643. user as the owner of the phpMyAdmin scripts.
  1644. .. config:option:: $cfg['TempDir']
  1645. :type: string
  1646. :default: ``''``
  1647. The name of the directory where temporary files can be stored.
  1648. This is needed for importing ESRI Shapefiles, see :ref:`faq6_30` and to
  1649. work around limitations of ``open_basedir`` for uploaded files, see
  1650. :ref:`faq1_11`.
  1651. If the directory where phpMyAdmin is installed is
  1652. subject to an ``open_basedir`` restriction, you need to create a
  1653. temporary directory in some directory accessible by the web server.
  1654. However for security reasons, this directory should be outside the
  1655. tree published by webserver. If you cannot avoid having this directory
  1656. published by webserver, place at least an empty :file:`index.html` file
  1657. there, so that directory listing is not possible.
  1658. This directory should have as strict permissions as possible as the only
  1659. user required to access this directory is the one who runs the webserver.
  1660. If you have root privileges, simply make this user owner of this directory
  1661. and make it accessible only by it:
  1662. .. code-block:: sh
  1663. chown www-data:www-data tmp
  1664. chmod 700 tmp
  1665. If you cannot change owner of the directory, you can achieve a similar
  1666. setup using :term:`ACL`:
  1667. .. code-block:: sh
  1668. chmod 700 tmp
  1669. setfacl -m "g:www-data:rwx" tmp
  1670. setfacl -d -m "g:www-data:rwx" tmp
  1671. If neither of above works for you, you can still make the directory
  1672. :command:`chmod 777`, but it might impose risk of other users on system
  1673. reading and writing data in this directory.
  1674. Various display setting
  1675. -----------------------
  1676. .. config:option:: $cfg['ShowDisplayDirection']
  1677. :type: boolean
  1678. :default: false
  1679. Defines whether or not type display direction option is shown when
  1680. browsing a table.
  1681. .. config:option:: $cfg['RepeatCells']
  1682. :type: integer
  1683. :default: 100
  1684. Repeat the headers every X cells, or 0 to deactivate.
  1685. .. config:option:: $cfg['EditInWindow']
  1686. :type: boolean
  1687. :default: true
  1688. .. config:option:: $cfg['QueryWindowWidth']
  1689. :type: integer
  1690. :default: 550
  1691. .. config:option:: $cfg['QueryWindowHeight']
  1692. :type: integer
  1693. :default: 310
  1694. .. config:option:: $cfg['QueryHistoryDB']
  1695. :type: boolean
  1696. :default: false
  1697. .. config:option:: $cfg['QueryWindowDefTab']
  1698. :type: string
  1699. :default: ``'sql'``
  1700. .. config:option:: $cfg['QueryHistoryMax']
  1701. :type: integer
  1702. :default: 25
  1703. All those variables affect the query window feature. A :term:`SQL` link or
  1704. icon is always displayed in the navigation panel. If JavaScript is enabled
  1705. in your browser, a click on this opens a distinct query window, which is a
  1706. direct interface to enter :term:`SQL` queries. Otherwise, the right panel
  1707. changes to display a query box.
  1708. The size of this query window can be customized with
  1709. :config:option:`$cfg['QueryWindowWidth']` and
  1710. :config:option:`$cfg['QueryWindowHeight']` - both integers for the size in
  1711. pixels. Note that normally, those parameters will be modified in
  1712. :file:`layout.inc.php`` for the theme you are using.
  1713. If :config:option:`$cfg['EditInWindow']` is set to true, a click on [Edit]
  1714. from the results page (in the :guilabel:`Showing Rows` section) opens the
  1715. query window and puts the current query inside it. If set to false,
  1716. clicking on the link puts the :term:`SQL` query
  1717. in the right panel's query box.
  1718. If :config:option:`$cfg['QueryHistoryDB']` is set to ``true``, all your
  1719. Queries are logged to a table, which has to be created by you (see
  1720. :config:option:`$cfg['Servers'][$i]['history']`). If set to false, all your
  1721. queries will be appended to the form, but only as long as your window is
  1722. opened they remain saved.
  1723. When using the JavaScript based query window, it will always get updated
  1724. when you click on a new table/db to browse and will focus if you click on
  1725. :guilabel:`Edit SQL` after using a query. You can suppress updating the
  1726. query window by checking the box :guilabel:`Do not overwrite this query
  1727. from outside the window` below the query textarea. Then you can browse
  1728. tables/databases in the background without losing the contents of the
  1729. textarea, so this is especially useful when composing a query with tables
  1730. you first have to look in. The checkbox will get automatically checked
  1731. whenever you change the contents of the textarea. Please uncheck the button
  1732. whenever you definitely want the query window to get updated even though
  1733. you have made alterations.
  1734. If :config:option:`$cfg['QueryHistoryDB']` is set to ``true`` you can
  1735. specify the amount of saved history items using
  1736. :config:option:`$cfg['QueryHistoryMax']`.
  1737. The query window also has a custom tabbed look to group the features.
  1738. Using the variable :config:option:`$cfg['QueryWindowDefTab']` you can
  1739. specify the default tab to be used when opening the query window. It can be
  1740. set to either ``sql``, ``files``, ``history`` or ``full``.
  1741. .. config:option:: $cfg['BrowseMIME']
  1742. :type: boolean
  1743. :default: true
  1744. Enable :ref:`transformations`.
  1745. .. config:option:: $cfg['MaxExactCount']
  1746. :type: integer
  1747. :default: 500000
  1748. For InnoDB tables, determines for how large tables phpMyAdmin should
  1749. get the exact row count using ``SELECT COUNT``. If the approximate row
  1750. count as returned by ``SHOW TABLE STATUS`` is smaller than this value,
  1751. ``SELECT COUNT`` will be used, otherwise the approximate count will be
  1752. used.
  1753. .. config:option:: $cfg['MaxExactCountViews']
  1754. :type: integer
  1755. :default: 0
  1756. For VIEWs, since obtaining the exact count could have an impact on
  1757. performance, this value is the maximum to be displayed, using a
  1758. ``SELECT COUNT ... LIMIT``. Setting this to 0 bypasses any row
  1759. counting.
  1760. .. config:option:: $cfg['NaturalOrder']
  1761. :type: boolean
  1762. :default: true
  1763. Sorts database and table names according to natural order (for
  1764. example, t1, t2, t10). Currently implemented in the navigation panel
  1765. and in Database view, for the table list.
  1766. .. config:option:: $cfg['InitialSlidersState']
  1767. :type: string
  1768. :default: ``'closed'``
  1769. If set to ``'closed'``, the visual sliders are initially in a closed
  1770. state. A value of ``'open'`` does the reverse. To completely disable
  1771. all visual sliders, use ``'disabled'``.
  1772. .. config:option:: $cfg['UserprefsDisallow']
  1773. :type: array
  1774. :default: array()
  1775. Contains names of configuration options (keys in ``$cfg`` array) that
  1776. users can't set through user preferences. For possible values, refer
  1777. to :file:`libraries/config/user_preferences.forms.php`.
  1778. .. config:option:: $cfg['UserprefsDeveloperTab']
  1779. :type: boolean
  1780. :default: false
  1781. Activates in the user preferences a tab containing options for
  1782. developers of phpMyAdmin.
  1783. Page titles
  1784. -----------
  1785. .. config:option:: $cfg['TitleTable']
  1786. :type: string
  1787. :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ / @TABLE@ | @PHPMYADMIN@'``
  1788. .. config:option:: $cfg['TitleDatabase']
  1789. :type: string
  1790. :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ | @PHPMYADMIN@'``
  1791. .. config:option:: $cfg['TitleServer']
  1792. :type: string
  1793. :default: ``'@HTTP_HOST@ / @VSERVER@ | @PHPMYADMIN@'``
  1794. .. config:option:: $cfg['TitleDefault']
  1795. :type: string
  1796. :default: ``'@HTTP_HOST@ | @PHPMYADMIN@'``
  1797. Allows you to specify window's title bar. You can use :ref:`faq6_27`.
  1798. Theme manager settings
  1799. ----------------------
  1800. .. config:option:: $cfg['ThemePath']
  1801. :type: string
  1802. :default: ``'./themes'``
  1803. If theme manager is active, use this as the path of the subdirectory
  1804. containing all the themes.
  1805. .. config:option:: $cfg['ThemeManager']
  1806. :type: boolean
  1807. :default: true
  1808. Enables user-selectable themes. See :ref:`faqthemes`.
  1809. .. config:option:: $cfg['ThemeDefault']
  1810. :type: string
  1811. :default: ``'pmahomme'``
  1812. The default theme (a subdirectory under :config:option:`$cfg['ThemePath']`).
  1813. .. config:option:: $cfg['ThemePerServer']
  1814. :type: boolean
  1815. :default: false
  1816. Whether to allow different theme for each server.
  1817. Default queries
  1818. ---------------
  1819. .. config:option:: $cfg['DefaultQueryTable']
  1820. :type: string
  1821. :default: ``'SELECT * FROM @TABLE@ WHERE 1'``
  1822. .. config:option:: $cfg['DefaultQueryDatabase']
  1823. :type: string
  1824. :default: ``''``
  1825. Default queries that will be displayed in query boxes when user didn't
  1826. specify any. You can use standard :ref:`faq6_27`.
  1827. MySQL settings
  1828. --------------
  1829. .. config:option:: $cfg['DefaultFunctions']
  1830. :type: array
  1831. :default: array(...)
  1832. Functions selected by default when inserting/changing row, Functions
  1833. are defined for meta types as (FUNC\_NUMBER, FUNC\_DATE, FUNC\_CHAR,
  1834. FUNC\_SPATIAL, FUNC\_UUID) and for ``first_timestamp``, which is used
  1835. for first timestamp column in table.
  1836. Developer
  1837. ---------
  1838. .. warning::
  1839. These settings might have huge effect on performance or security.
  1840. .. config:option:: $cfg['DBG']
  1841. :type: array
  1842. :default: array(...)
  1843. .. config:option:: $cfg['DBG']['sql']
  1844. :type: boolean
  1845. :default: false
  1846. Enable logging queries and execution times to be
  1847. displayed in the bottom of main page (right frame).
  1848. .. config:option:: $cfg['DBG']['demo']
  1849. :type: boolean
  1850. :default: false
  1851. Enable to let server present itself as demo server.
  1852. This is used for <http://demo.phpmyadmin.net/>.
  1853. .. config:option:: $cfg['Error_Handler']['display']
  1854. :type: boolean
  1855. :default: false
  1856. Whether to display errors from PHP or not.
  1857. .. config:option:: $cfg['RowActionType']
  1858. :type: string
  1859. :default: ``'both'``
  1860. Whether to display icons or text or both icons and text in table row action
  1861. segment. Value can be either of ``'icons'``, ``'text'`` or ``'both'``.