config.html 394 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
  6. <title>Configuration &#8212; phpMyAdmin 5.2.2 documentation</title>
  7. <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  8. <link rel="stylesheet" type="text/css" href="_static/classic.css" />
  9. <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
  10. <script src="_static/jquery.js"></script>
  11. <script src="_static/underscore.js"></script>
  12. <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
  13. <script src="_static/doctools.js"></script>
  14. <script src="_static/sphinx_highlight.js"></script>
  15. <link rel="index" title="Index" href="genindex.html" />
  16. <link rel="search" title="Search" href="search.html" />
  17. <link rel="copyright" title="Copyright" href="copyright.html" />
  18. <link rel="next" title="User Guide" href="user.html" />
  19. <link rel="prev" title="Installation" href="setup.html" />
  20. </head><body>
  21. <div class="related" role="navigation" aria-label="related navigation">
  22. <h3>Navigation</h3>
  23. <ul>
  24. <li class="right" style="margin-right: 10px">
  25. <a href="genindex.html" title="General Index"
  26. accesskey="I">index</a></li>
  27. <li class="right" >
  28. <a href="user.html" title="User Guide"
  29. accesskey="N">next</a> |</li>
  30. <li class="right" >
  31. <a href="setup.html" title="Installation"
  32. accesskey="P">previous</a> |</li>
  33. <li class="nav-item nav-item-0"><a href="index.html">phpMyAdmin 5.2.2 documentation</a> &#187;</li>
  34. <li class="nav-item nav-item-this"><a href="">Configuration</a></li>
  35. </ul>
  36. </div>
  37. <div class="document">
  38. <div class="documentwrapper">
  39. <div class="bodywrapper">
  40. <div class="body" role="main">
  41. <section id="configuration">
  42. <span id="config"></span><span id="index-0"></span><h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this heading">¶</a></h1>
  43. <p>All configurable data is placed in <code class="file docutils literal notranslate"><span class="pre">config.inc.php</span></code> in phpMyAdmin’s
  44. toplevel directory. If this file does not exist, please refer to the
  45. <a class="reference internal" href="setup.html#setup"><span class="std std-ref">Installation</span></a> section to create one. This file only needs to contain the
  46. parameters you want to change from their corresponding default value in
  47. <code class="file docutils literal notranslate"><span class="pre">libraries/config.default.php</span></code> (this file is not intended for changes).</p>
  48. <div class="admonition seealso">
  49. <p class="admonition-title">See also</p>
  50. <p><a class="reference internal" href="#config-examples"><span class="std std-ref">Examples</span></a> for examples of configurations</p>
  51. </div>
  52. <p>If a directive is missing from your file, you can just add another line with
  53. the file. This file is for over-writing the defaults; if you wish to use the
  54. default value there’s no need to add a line here.</p>
  55. <p>The parameters which relate to design (like colors) are placed in
  56. <code class="file docutils literal notranslate"><span class="pre">themes/themename/scss/_variables.scss</span></code>. You might also want to create
  57. <code class="file docutils literal notranslate"><span class="pre">config.footer.inc.php</span></code> and <code class="file docutils literal notranslate"><span class="pre">config.header.inc.php</span></code> files to add
  58. your site specific code to be included on start and end of each page.</p>
  59. <div class="admonition note">
  60. <p class="admonition-title">Note</p>
  61. <p>Some distributions (eg. Debian or Ubuntu) store <code class="file docutils literal notranslate"><span class="pre">config.inc.php</span></code> in
  62. <code class="docutils literal notranslate"><span class="pre">/etc/phpmyadmin</span></code> instead of within phpMyAdmin sources.</p>
  63. </div>
  64. <section id="basic-settings">
  65. <h2>Basic settings<a class="headerlink" href="#basic-settings" title="Permalink to this heading">¶</a></h2>
  66. <dl class="config option">
  67. <dt class="sig sig-object config" id="cfg_PmaAbsoluteUri">
  68. <span class="sig-name descname"><span class="pre">$cfg['PmaAbsoluteUri']</span></span><a class="headerlink" href="#cfg_PmaAbsoluteUri" title="Permalink to this definition">¶</a></dt>
  69. <dd><dl class="field-list simple">
  70. <dt class="field-odd">Type<span class="colon">:</span></dt>
  71. <dd class="field-odd"><p>string</p>
  72. </dd>
  73. <dt class="field-even">Default value<span class="colon">:</span></dt>
  74. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  75. </dd>
  76. </dl>
  77. <div class="versionchanged">
  78. <p><span class="versionmodified changed">Changed in version 4.6.5: </span>This setting was not available in phpMyAdmin 4.6.0 - 4.6.4.</p>
  79. </div>
  80. <p>Sets here the complete <a class="reference internal" href="glossary.html#term-URL"><span class="xref std std-term">URL</span></a> (with full path) to your phpMyAdmin
  81. installation’s directory. E.g.
  82. <code class="docutils literal notranslate"><span class="pre">https://www.example.net/path_to_your_phpMyAdmin_directory/</span></code>. Note also
  83. that the <a class="reference internal" href="glossary.html#term-URL"><span class="xref std std-term">URL</span></a> on most of web servers are case sensitive (even on
  84. Windows). Don’t forget the trailing slash at the end.</p>
  85. <p>Starting with version 2.3.0, it is advisable to try leaving this blank. In
  86. most cases phpMyAdmin automatically detects the proper setting. Users of
  87. port forwarding or complex reverse proxy setup might need to set this.</p>
  88. <p>A good test is to browse a table, edit a row and save it. There should be
  89. an error message if phpMyAdmin is having trouble auto–detecting the correct
  90. value. If you get an error that this must be set or if the autodetect code
  91. fails to detect your path, please post a bug report on our bug tracker so
  92. we can improve the code.</p>
  93. <div class="admonition seealso">
  94. <p class="admonition-title">See also</p>
  95. <p><a class="reference internal" href="faq.html#faq1-40"><span class="std std-ref">1.40 When accessing phpMyAdmin via an Apache reverse proxy, cookie login does not work.</span></a>, <a class="reference internal" href="faq.html#faq2-5"><span class="std std-ref">2.5 Each time I want to insert or change a row or drop a database or a table, an error 404 (page not found) is displayed or, with HTTP or cookie authentication, I’m asked to log in again. What’s wrong?</span></a>, <a class="reference internal" href="faq.html#faq4-7"><span class="std std-ref">4.7 Authentication window is displayed more than once, why?</span></a>, <a class="reference internal" href="faq.html#faq5-16"><span class="std std-ref">5.16 With Internet Explorer, I get “Access is denied” Javascript errors. Or I cannot make phpMyAdmin work under Windows.</span></a></p>
  96. </div>
  97. </dd></dl>
  98. <dl class="config option">
  99. <dt class="sig sig-object config" id="cfg_PmaNoRelation_DisableWarning">
  100. <span class="sig-name descname"><span class="pre">$cfg['PmaNoRelation_DisableWarning']</span></span><a class="headerlink" href="#cfg_PmaNoRelation_DisableWarning" title="Permalink to this definition">¶</a></dt>
  101. <dd><dl class="field-list simple">
  102. <dt class="field-odd">Type<span class="colon">:</span></dt>
  103. <dd class="field-odd"><p>boolean</p>
  104. </dd>
  105. <dt class="field-even">Default value<span class="colon">:</span></dt>
  106. <dd class="field-even"><p>false</p>
  107. </dd>
  108. </dl>
  109. <p>Starting with version 2.3.0 phpMyAdmin offers a lot of features to
  110. work with master / foreign – tables (see <span class="target" id="index-1"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a>).</p>
  111. <p>If you tried to set this
  112. up and it does not work for you, have a look on the <span class="guilabel">Structure</span> page
  113. of one database where you would like to use it. You will find a link
  114. that will analyze why those features have been disabled.</p>
  115. <p>If you do not want to use those features set this variable to <code class="docutils literal notranslate"><span class="pre">true</span></code> to
  116. stop this message from appearing.</p>
  117. </dd></dl>
  118. <dl class="config option">
  119. <dt class="sig sig-object config" id="cfg_AuthLog">
  120. <span class="sig-name descname"><span class="pre">$cfg['AuthLog']</span></span><a class="headerlink" href="#cfg_AuthLog" title="Permalink to this definition">¶</a></dt>
  121. <dd><dl class="field-list simple">
  122. <dt class="field-odd">Type<span class="colon">:</span></dt>
  123. <dd class="field-odd"><p>string</p>
  124. </dd>
  125. <dt class="field-even">Default value<span class="colon">:</span></dt>
  126. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'auto'</span></code></p>
  127. </dd>
  128. </dl>
  129. <div class="versionadded">
  130. <p><span class="versionmodified added">New in version 4.8.0: </span>This is supported since phpMyAdmin 4.8.0.</p>
  131. </div>
  132. <p>Configure authentication logging destination. Failed (or all, depending on
  133. <span class="target" id="index-2"></span><a class="reference internal" href="#cfg_AuthLogSuccess"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['AuthLogSuccess']</span></code></a>) authentication attempts will be
  134. logged according to this directive:</p>
  135. <dl class="simple">
  136. <dt><code class="docutils literal notranslate"><span class="pre">auto</span></code></dt><dd><p>Let phpMyAdmin automatically choose between <code class="docutils literal notranslate"><span class="pre">syslog</span></code> and <code class="docutils literal notranslate"><span class="pre">php</span></code>.</p>
  137. </dd>
  138. <dt><code class="docutils literal notranslate"><span class="pre">syslog</span></code></dt><dd><p>Log using syslog, using AUTH facility, on most systems this ends up
  139. in <code class="file docutils literal notranslate"><span class="pre">/var/log/auth.log</span></code>.</p>
  140. </dd>
  141. <dt><code class="docutils literal notranslate"><span class="pre">php</span></code></dt><dd><p>Log into PHP error log.</p>
  142. </dd>
  143. <dt><code class="docutils literal notranslate"><span class="pre">sapi</span></code></dt><dd><p>Log into PHP SAPI logging.</p>
  144. </dd>
  145. <dt><code class="docutils literal notranslate"><span class="pre">/path/to/file</span></code></dt><dd><p>Any other value is treated as a filename and log entries are written there.</p>
  146. </dd>
  147. </dl>
  148. <div class="admonition note">
  149. <p class="admonition-title">Note</p>
  150. <p>When logging to a file, make sure its permissions are correctly set
  151. for a web server user, the setup should closely match instructions
  152. described in <span class="target" id="index-3"></span><a class="reference internal" href="#cfg_TempDir"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['TempDir']</span></code></a>:</p>
  153. </div>
  154. </dd></dl>
  155. <dl class="config option">
  156. <dt class="sig sig-object config" id="cfg_AuthLogSuccess">
  157. <span class="sig-name descname"><span class="pre">$cfg['AuthLogSuccess']</span></span><a class="headerlink" href="#cfg_AuthLogSuccess" title="Permalink to this definition">¶</a></dt>
  158. <dd><dl class="field-list simple">
  159. <dt class="field-odd">Type<span class="colon">:</span></dt>
  160. <dd class="field-odd"><p>boolean</p>
  161. </dd>
  162. <dt class="field-even">Default value<span class="colon">:</span></dt>
  163. <dd class="field-even"><p>false</p>
  164. </dd>
  165. </dl>
  166. <div class="versionadded">
  167. <p><span class="versionmodified added">New in version 4.8.0: </span>This is supported since phpMyAdmin 4.8.0.</p>
  168. </div>
  169. <p>Whether to log successful authentication attempts into
  170. <span class="target" id="index-4"></span><a class="reference internal" href="#cfg_AuthLog"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['AuthLog']</span></code></a>.</p>
  171. </dd></dl>
  172. <dl class="config option">
  173. <dt class="sig sig-object config" id="cfg_SuhosinDisableWarning">
  174. <span class="sig-name descname"><span class="pre">$cfg['SuhosinDisableWarning']</span></span><a class="headerlink" href="#cfg_SuhosinDisableWarning" title="Permalink to this definition">¶</a></dt>
  175. <dd><dl class="field-list simple">
  176. <dt class="field-odd">Type<span class="colon">:</span></dt>
  177. <dd class="field-odd"><p>boolean</p>
  178. </dd>
  179. <dt class="field-even">Default value<span class="colon">:</span></dt>
  180. <dd class="field-even"><p>false</p>
  181. </dd>
  182. </dl>
  183. <p>A warning is displayed on the main page if Suhosin is detected.</p>
  184. <p>You can set this parameter to <code class="docutils literal notranslate"><span class="pre">true</span></code> to stop this message from appearing.</p>
  185. </dd></dl>
  186. <dl class="config option">
  187. <dt class="sig sig-object config" id="cfg_LoginCookieValidityDisableWarning">
  188. <span class="sig-name descname"><span class="pre">$cfg['LoginCookieValidityDisableWarning']</span></span><a class="headerlink" href="#cfg_LoginCookieValidityDisableWarning" title="Permalink to this definition">¶</a></dt>
  189. <dd><dl class="field-list simple">
  190. <dt class="field-odd">Type<span class="colon">:</span></dt>
  191. <dd class="field-odd"><p>boolean</p>
  192. </dd>
  193. <dt class="field-even">Default value<span class="colon">:</span></dt>
  194. <dd class="field-even"><p>false</p>
  195. </dd>
  196. </dl>
  197. <p>A warning is displayed on the main page if the PHP parameter
  198. session.gc_maxlifetime is lower than cookie validity configured in phpMyAdmin.</p>
  199. <p>You can set this parameter to <code class="docutils literal notranslate"><span class="pre">true</span></code> to stop this message from appearing.</p>
  200. </dd></dl>
  201. <dl class="config option">
  202. <dt class="sig sig-object config" id="cfg_ServerLibraryDifference_DisableWarning">
  203. <span class="sig-name descname"><span class="pre">$cfg['ServerLibraryDifference_DisableWarning']</span></span><a class="headerlink" href="#cfg_ServerLibraryDifference_DisableWarning" title="Permalink to this definition">¶</a></dt>
  204. <dd><dl class="field-list simple">
  205. <dt class="field-odd">Type<span class="colon">:</span></dt>
  206. <dd class="field-odd"><p>boolean</p>
  207. </dd>
  208. <dt class="field-even">Default value<span class="colon">:</span></dt>
  209. <dd class="field-even"><p>false</p>
  210. </dd>
  211. </dl>
  212. <div class="deprecated">
  213. <p><span class="versionmodified deprecated">Deprecated since version 4.7.0: </span>This setting was removed as the warning has been removed as well.</p>
  214. </div>
  215. <p>A warning is displayed on the main page if there is a difference
  216. between the MySQL library and server version.</p>
  217. <p>You can set this parameter to <code class="docutils literal notranslate"><span class="pre">true</span></code> to stop this message from appearing.</p>
  218. </dd></dl>
  219. <dl class="config option">
  220. <dt class="sig sig-object config" id="cfg_ReservedWordDisableWarning">
  221. <span class="sig-name descname"><span class="pre">$cfg['ReservedWordDisableWarning']</span></span><a class="headerlink" href="#cfg_ReservedWordDisableWarning" title="Permalink to this definition">¶</a></dt>
  222. <dd><dl class="field-list simple">
  223. <dt class="field-odd">Type<span class="colon">:</span></dt>
  224. <dd class="field-odd"><p>boolean</p>
  225. </dd>
  226. <dt class="field-even">Default value<span class="colon">:</span></dt>
  227. <dd class="field-even"><p>false</p>
  228. </dd>
  229. </dl>
  230. <p>This warning is displayed on the Structure page of a table if one or more
  231. column names match with words which are MySQL reserved.</p>
  232. <p>If you want to turn off this warning, you can set it to <code class="docutils literal notranslate"><span class="pre">true</span></code> and
  233. warning will no longer be displayed.</p>
  234. </dd></dl>
  235. <dl class="config option">
  236. <dt class="sig sig-object config" id="cfg_TranslationWarningThreshold">
  237. <span class="sig-name descname"><span class="pre">$cfg['TranslationWarningThreshold']</span></span><a class="headerlink" href="#cfg_TranslationWarningThreshold" title="Permalink to this definition">¶</a></dt>
  238. <dd><dl class="field-list simple">
  239. <dt class="field-odd">Type<span class="colon">:</span></dt>
  240. <dd class="field-odd"><p>integer</p>
  241. </dd>
  242. <dt class="field-even">Default value<span class="colon">:</span></dt>
  243. <dd class="field-even"><p>80</p>
  244. </dd>
  245. </dl>
  246. <p>Show warning about incomplete translations on certain threshold.</p>
  247. </dd></dl>
  248. <dl class="config option">
  249. <dt class="sig sig-object config" id="cfg_SendErrorReports">
  250. <span class="sig-name descname"><span class="pre">$cfg['SendErrorReports']</span></span><a class="headerlink" href="#cfg_SendErrorReports" title="Permalink to this definition">¶</a></dt>
  251. <dd><dl class="field-list simple">
  252. <dt class="field-odd">Type<span class="colon">:</span></dt>
  253. <dd class="field-odd"><p>string</p>
  254. </dd>
  255. <dt class="field-even">Default value<span class="colon">:</span></dt>
  256. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'ask'</span></code></p>
  257. </dd>
  258. </dl>
  259. <p>Valid values are:</p>
  260. <ul class="simple">
  261. <li><p><code class="docutils literal notranslate"><span class="pre">ask</span></code></p></li>
  262. <li><p><code class="docutils literal notranslate"><span class="pre">always</span></code></p></li>
  263. <li><p><code class="docutils literal notranslate"><span class="pre">never</span></code></p></li>
  264. </ul>
  265. <p>Sets the default behavior for JavaScript error reporting.</p>
  266. <p>Whenever an error is detected in the JavaScript execution, an error report
  267. may be sent to the phpMyAdmin team if the user agrees.</p>
  268. <p>The default setting of <code class="docutils literal notranslate"><span class="pre">'ask'</span></code> will ask the user everytime there is a new
  269. error report. However you can set this parameter to <code class="docutils literal notranslate"><span class="pre">'always'</span></code> to send error
  270. reports without asking for confirmation or you can set it to <code class="docutils literal notranslate"><span class="pre">'never'</span></code> to
  271. never send error reports.</p>
  272. <p>This directive is available both in the configuration file and in users
  273. preferences. If the person in charge of a multi-user installation prefers
  274. to disable this feature for all users, a value of <code class="docutils literal notranslate"><span class="pre">'never'</span></code> should be
  275. set, and the <span class="target" id="index-5"></span><a class="reference internal" href="#cfg_UserprefsDisallow"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['UserprefsDisallow']</span></code></a> directive should
  276. contain <code class="docutils literal notranslate"><span class="pre">'SendErrorReports'</span></code> in one of its array values.</p>
  277. </dd></dl>
  278. <dl class="config option">
  279. <dt class="sig sig-object config" id="cfg_ConsoleEnterExecutes">
  280. <span class="sig-name descname"><span class="pre">$cfg['ConsoleEnterExecutes']</span></span><a class="headerlink" href="#cfg_ConsoleEnterExecutes" title="Permalink to this definition">¶</a></dt>
  281. <dd><dl class="field-list simple">
  282. <dt class="field-odd">Type<span class="colon">:</span></dt>
  283. <dd class="field-odd"><p>boolean</p>
  284. </dd>
  285. <dt class="field-even">Default value<span class="colon">:</span></dt>
  286. <dd class="field-even"><p>false</p>
  287. </dd>
  288. </dl>
  289. <p>Setting this to <code class="docutils literal notranslate"><span class="pre">true</span></code> allows the user to execute queries by pressing Enter
  290. instead of Ctrl+Enter. A new line can be inserted by pressing Shift+Enter.</p>
  291. <p>The behaviour of the console can be temporarily changed using console’s
  292. settings interface.</p>
  293. </dd></dl>
  294. <dl class="config option">
  295. <dt class="sig sig-object config" id="cfg_AllowThirdPartyFraming">
  296. <span class="sig-name descname"><span class="pre">$cfg['AllowThirdPartyFraming']</span></span><a class="headerlink" href="#cfg_AllowThirdPartyFraming" title="Permalink to this definition">¶</a></dt>
  297. <dd><dl class="field-list simple">
  298. <dt class="field-odd">Type<span class="colon">:</span></dt>
  299. <dd class="field-odd"><p>boolean|string</p>
  300. </dd>
  301. <dt class="field-even">Default value<span class="colon">:</span></dt>
  302. <dd class="field-even"><p>false</p>
  303. </dd>
  304. </dl>
  305. <p>Setting this to <code class="docutils literal notranslate"><span class="pre">true</span></code> allows phpMyAdmin to be included inside a frame,
  306. and is a potential security hole allowing cross-frame scripting attacks or
  307. clickjacking. Setting this to ‘sameorigin’ prevents phpMyAdmin to be
  308. included from another document in a frame, unless that document belongs
  309. to the same domain.</p>
  310. </dd></dl>
  311. </section>
  312. <section id="server-connection-settings">
  313. <h2>Server connection settings<a class="headerlink" href="#server-connection-settings" title="Permalink to this heading">¶</a></h2>
  314. <dl class="config option">
  315. <dt class="sig sig-object config" id="cfg_Servers">
  316. <span class="sig-name descname"><span class="pre">$cfg['Servers']</span></span><a class="headerlink" href="#cfg_Servers" title="Permalink to this definition">¶</a></dt>
  317. <dd><dl class="field-list simple">
  318. <dt class="field-odd">Type<span class="colon">:</span></dt>
  319. <dd class="field-odd"><p>array</p>
  320. </dd>
  321. <dt class="field-even">Default value<span class="colon">:</span></dt>
  322. <dd class="field-even"><p>one server array with settings listed below</p>
  323. </dd>
  324. </dl>
  325. <p>Since version 1.4.2, phpMyAdmin supports the administration of multiple
  326. MySQL servers. Therefore, a <span class="target" id="index-6"></span><a class="reference internal" href="#cfg_Servers"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers']</span></code></a>-array has been
  327. added which contains the login information for the different servers. The
  328. first <span class="target" id="index-7"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a> contains the hostname of
  329. the first server, the second <span class="target" id="index-8"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a>
  330. the hostname of the second server, etc. In
  331. <code class="file docutils literal notranslate"><span class="pre">libraries/config.default.php</span></code>, there is only one section for server
  332. definition, however you can put as many as you need in
  333. <code class="file docutils literal notranslate"><span class="pre">config.inc.php</span></code>, copy that block or needed parts (you don’t have to
  334. define all settings, just those you need to change).</p>
  335. <div class="admonition note">
  336. <p class="admonition-title">Note</p>
  337. <p>The <span class="target" id="index-9"></span><a class="reference internal" href="#cfg_Servers"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers']</span></code></a> array starts with
  338. $cfg[‘Servers’][1]. Do not use $cfg[‘Servers’][0]. If you want more
  339. than one server, just copy following section (including $i
  340. increment) several times. There is no need to define full server
  341. array, just define values you need to change.</p>
  342. </div>
  343. </dd></dl>
  344. <dl class="config option">
  345. <dt class="sig sig-object config" id="cfg_Servers_host">
  346. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['host']</span></span><a class="headerlink" href="#cfg_Servers_host" title="Permalink to this definition">¶</a></dt>
  347. <dd><dl class="field-list simple">
  348. <dt class="field-odd">Type<span class="colon">:</span></dt>
  349. <dd class="field-odd"><p>string</p>
  350. </dd>
  351. <dt class="field-even">Default value<span class="colon">:</span></dt>
  352. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'localhost'</span></code></p>
  353. </dd>
  354. </dl>
  355. <p>The hostname or <a class="reference internal" href="glossary.html#term-IP"><span class="xref std std-term">IP</span></a> address of your $i-th MySQL-server. E.g.
  356. <code class="docutils literal notranslate"><span class="pre">localhost</span></code>.</p>
  357. <p>Possible values are:</p>
  358. <ul class="simple">
  359. <li><p>hostname, e.g., <code class="docutils literal notranslate"><span class="pre">'localhost'</span></code> or <code class="docutils literal notranslate"><span class="pre">'mydb.example.org'</span></code></p></li>
  360. <li><p>IP address, e.g., <code class="docutils literal notranslate"><span class="pre">'127.0.0.1'</span></code> or <code class="docutils literal notranslate"><span class="pre">'192.168.10.1'</span></code></p></li>
  361. <li><p>IPv6 address, e.g. <code class="docutils literal notranslate"><span class="pre">2001:cdba:0000:0000:0000:0000:3257:9652</span></code></p></li>
  362. <li><p>dot - <code class="docutils literal notranslate"><span class="pre">'.'</span></code>, i.e., use named pipes on windows systems</p></li>
  363. <li><p>empty - <code class="docutils literal notranslate"><span class="pre">''</span></code>, disables this server</p></li>
  364. </ul>
  365. <div class="admonition note">
  366. <p class="admonition-title">Note</p>
  367. <p>The hostname <code class="docutils literal notranslate"><span class="pre">localhost</span></code> is handled specially by MySQL and it uses
  368. the socket based connection protocol. To use TCP/IP networking, use an
  369. IP address or hostname such as <code class="docutils literal notranslate"><span class="pre">127.0.0.1</span></code> or <code class="docutils literal notranslate"><span class="pre">db.example.com</span></code>. You
  370. can configure the path to the socket with
  371. <span class="target" id="index-10"></span><a class="reference internal" href="#cfg_Servers_socket"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['socket']</span></code></a>.</p>
  372. </div>
  373. <div class="admonition seealso">
  374. <p class="admonition-title">See also</p>
  375. <p><span class="target" id="index-11"></span><a class="reference internal" href="#cfg_Servers_port"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['port']</span></code></a>,
  376. &lt;<a class="reference external" href="https://dev.mysql.com/doc/refman/8.0/en/connecting.html">https://dev.mysql.com/doc/refman/8.0/en/connecting.html</a>&gt;</p>
  377. </div>
  378. </dd></dl>
  379. <dl class="config option">
  380. <dt class="sig sig-object config" id="cfg_Servers_port">
  381. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['port']</span></span><a class="headerlink" href="#cfg_Servers_port" title="Permalink to this definition">¶</a></dt>
  382. <dd><dl class="field-list simple">
  383. <dt class="field-odd">Type<span class="colon">:</span></dt>
  384. <dd class="field-odd"><p>string</p>
  385. </dd>
  386. <dt class="field-even">Default value<span class="colon">:</span></dt>
  387. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  388. </dd>
  389. </dl>
  390. <p>The port-number of your $i-th MySQL-server. Default is 3306 (leave
  391. blank).</p>
  392. <div class="admonition note">
  393. <p class="admonition-title">Note</p>
  394. <p>If you use <code class="docutils literal notranslate"><span class="pre">localhost</span></code> as the hostname, MySQL ignores this port number
  395. and connects with the socket, so if you want to connect to a port
  396. different from the default port, use <code class="docutils literal notranslate"><span class="pre">127.0.0.1</span></code> or the real hostname
  397. in <span class="target" id="index-12"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a>.</p>
  398. </div>
  399. <div class="admonition seealso">
  400. <p class="admonition-title">See also</p>
  401. <p><span class="target" id="index-13"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a>,
  402. &lt;<a class="reference external" href="https://dev.mysql.com/doc/refman/8.0/en/connecting.html">https://dev.mysql.com/doc/refman/8.0/en/connecting.html</a>&gt;</p>
  403. </div>
  404. </dd></dl>
  405. <dl class="config option">
  406. <dt class="sig sig-object config" id="cfg_Servers_socket">
  407. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['socket']</span></span><a class="headerlink" href="#cfg_Servers_socket" title="Permalink to this definition">¶</a></dt>
  408. <dd><dl class="field-list simple">
  409. <dt class="field-odd">Type<span class="colon">:</span></dt>
  410. <dd class="field-odd"><p>string</p>
  411. </dd>
  412. <dt class="field-even">Default value<span class="colon">:</span></dt>
  413. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  414. </dd>
  415. </dl>
  416. <p>The path to the socket to use. Leave blank for default. To determine
  417. the correct socket, check your MySQL configuration or, using the
  418. <strong class="command">mysql</strong> command–line client, issue the <code class="docutils literal notranslate"><span class="pre">status</span></code> command. Among the
  419. resulting information displayed will be the socket used.</p>
  420. <div class="admonition note">
  421. <p class="admonition-title">Note</p>
  422. <p>This takes effect only if <span class="target" id="index-14"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a> is set
  423. to <code class="docutils literal notranslate"><span class="pre">localhost</span></code>.</p>
  424. </div>
  425. <div class="admonition seealso">
  426. <p class="admonition-title">See also</p>
  427. <p><span class="target" id="index-15"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a>,
  428. &lt;<a class="reference external" href="https://dev.mysql.com/doc/refman/8.0/en/connecting.html">https://dev.mysql.com/doc/refman/8.0/en/connecting.html</a>&gt;</p>
  429. </div>
  430. </dd></dl>
  431. <dl class="config option">
  432. <dt class="sig sig-object config" id="cfg_Servers_ssl">
  433. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['ssl']</span></span><a class="headerlink" href="#cfg_Servers_ssl" title="Permalink to this definition">¶</a></dt>
  434. <dd><dl class="field-list simple">
  435. <dt class="field-odd">Type<span class="colon">:</span></dt>
  436. <dd class="field-odd"><p>boolean</p>
  437. </dd>
  438. <dt class="field-even">Default value<span class="colon">:</span></dt>
  439. <dd class="field-even"><p>false</p>
  440. </dd>
  441. </dl>
  442. <p>Whether to enable SSL for the connection between phpMyAdmin and the MySQL
  443. server to secure the connection.</p>
  444. <p>When using the <code class="docutils literal notranslate"><span class="pre">'mysql'</span></code> extension,
  445. none of the remaining <code class="docutils literal notranslate"><span class="pre">'ssl...'</span></code> configuration options apply.</p>
  446. <p>We strongly recommend the <code class="docutils literal notranslate"><span class="pre">'mysqli'</span></code> extension when using this option.</p>
  447. <div class="admonition seealso">
  448. <p class="admonition-title">See also</p>
  449. <p><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>,
  450. <a class="reference internal" href="#example-google-ssl"><span class="std std-ref">Google Cloud SQL with SSL</span></a>,
  451. <a class="reference internal" href="#example-aws-ssl"><span class="std std-ref">Amazon RDS Aurora with SSL</span></a>,
  452. <span class="target" id="index-16"></span><a class="reference internal" href="#cfg_Servers_ssl_key"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_key']</span></code></a>,
  453. <span class="target" id="index-17"></span><a class="reference internal" href="#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_cert']</span></code></a>,
  454. <span class="target" id="index-18"></span><a class="reference internal" href="#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></code></a>,
  455. <span class="target" id="index-19"></span><a class="reference internal" href="#cfg_Servers_ssl_ca_path"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca_path']</span></code></a>,
  456. <span class="target" id="index-20"></span><a class="reference internal" href="#cfg_Servers_ssl_ciphers"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ciphers']</span></code></a>,
  457. <span class="target" id="index-21"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a></p>
  458. </div>
  459. </dd></dl>
  460. <dl class="config option">
  461. <dt class="sig sig-object config" id="cfg_Servers_ssl_key">
  462. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['ssl_key']</span></span><a class="headerlink" href="#cfg_Servers_ssl_key" title="Permalink to this definition">¶</a></dt>
  463. <dd><dl class="field-list simple">
  464. <dt class="field-odd">Type<span class="colon">:</span></dt>
  465. <dd class="field-odd"><p>string</p>
  466. </dd>
  467. <dt class="field-even">Default value<span class="colon">:</span></dt>
  468. <dd class="field-even"><p>NULL</p>
  469. </dd>
  470. </dl>
  471. <p>Path to the client key file when using SSL for connecting to the MySQL
  472. server. This is used to authenticate the client to the server.</p>
  473. <p>For example:</p>
  474. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;ssl_key&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;/etc/mysql/server-key.pem&#39;</span><span class="p">;</span>
  475. </pre></div>
  476. </div>
  477. <div class="admonition seealso">
  478. <p class="admonition-title">See also</p>
  479. <p><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>,
  480. <a class="reference internal" href="#example-google-ssl"><span class="std std-ref">Google Cloud SQL with SSL</span></a>,
  481. <a class="reference internal" href="#example-aws-ssl"><span class="std std-ref">Amazon RDS Aurora with SSL</span></a>,
  482. <span class="target" id="index-22"></span><a class="reference internal" href="#cfg_Servers_ssl"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl']</span></code></a>,
  483. <span class="target" id="index-23"></span><a class="reference internal" href="#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_cert']</span></code></a>,
  484. <span class="target" id="index-24"></span><a class="reference internal" href="#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></code></a>,
  485. <span class="target" id="index-25"></span><a class="reference internal" href="#cfg_Servers_ssl_ca_path"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca_path']</span></code></a>,
  486. <span class="target" id="index-26"></span><a class="reference internal" href="#cfg_Servers_ssl_ciphers"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ciphers']</span></code></a>,
  487. <span class="target" id="index-27"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a></p>
  488. </div>
  489. </dd></dl>
  490. <dl class="config option">
  491. <dt class="sig sig-object config" id="cfg_Servers_ssl_cert">
  492. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['ssl_cert']</span></span><a class="headerlink" href="#cfg_Servers_ssl_cert" title="Permalink to this definition">¶</a></dt>
  493. <dd><dl class="field-list simple">
  494. <dt class="field-odd">Type<span class="colon">:</span></dt>
  495. <dd class="field-odd"><p>string</p>
  496. </dd>
  497. <dt class="field-even">Default value<span class="colon">:</span></dt>
  498. <dd class="field-even"><p>NULL</p>
  499. </dd>
  500. </dl>
  501. <p>Path to the client certificate file when using SSL for connecting to the
  502. MySQL server. This is used to authenticate the client to the server.</p>
  503. <div class="admonition seealso">
  504. <p class="admonition-title">See also</p>
  505. <p><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>,
  506. <a class="reference internal" href="#example-google-ssl"><span class="std std-ref">Google Cloud SQL with SSL</span></a>,
  507. <a class="reference internal" href="#example-aws-ssl"><span class="std std-ref">Amazon RDS Aurora with SSL</span></a>,
  508. <span class="target" id="index-28"></span><a class="reference internal" href="#cfg_Servers_ssl"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl']</span></code></a>,
  509. <span class="target" id="index-29"></span><a class="reference internal" href="#cfg_Servers_ssl_key"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_key']</span></code></a>,
  510. <span class="target" id="index-30"></span><a class="reference internal" href="#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></code></a>,
  511. <span class="target" id="index-31"></span><a class="reference internal" href="#cfg_Servers_ssl_ca_path"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca_path']</span></code></a>,
  512. <span class="target" id="index-32"></span><a class="reference internal" href="#cfg_Servers_ssl_ciphers"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ciphers']</span></code></a>,
  513. <span class="target" id="index-33"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a></p>
  514. </div>
  515. </dd></dl>
  516. <dl class="config option">
  517. <dt class="sig sig-object config" id="cfg_Servers_ssl_ca">
  518. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></span><a class="headerlink" href="#cfg_Servers_ssl_ca" title="Permalink to this definition">¶</a></dt>
  519. <dd><dl class="field-list simple">
  520. <dt class="field-odd">Type<span class="colon">:</span></dt>
  521. <dd class="field-odd"><p>string</p>
  522. </dd>
  523. <dt class="field-even">Default value<span class="colon">:</span></dt>
  524. <dd class="field-even"><p>NULL</p>
  525. </dd>
  526. </dl>
  527. <p>Path to the CA file when using SSL for connecting to the MySQL server.</p>
  528. <div class="admonition seealso">
  529. <p class="admonition-title">See also</p>
  530. <p><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>,
  531. <a class="reference internal" href="#example-google-ssl"><span class="std std-ref">Google Cloud SQL with SSL</span></a>,
  532. <a class="reference internal" href="#example-aws-ssl"><span class="std std-ref">Amazon RDS Aurora with SSL</span></a>,
  533. <span class="target" id="index-34"></span><a class="reference internal" href="#cfg_Servers_ssl"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl']</span></code></a>,
  534. <span class="target" id="index-35"></span><a class="reference internal" href="#cfg_Servers_ssl_key"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_key']</span></code></a>,
  535. <span class="target" id="index-36"></span><a class="reference internal" href="#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_cert']</span></code></a>,
  536. <span class="target" id="index-37"></span><a class="reference internal" href="#cfg_Servers_ssl_ca_path"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca_path']</span></code></a>,
  537. <span class="target" id="index-38"></span><a class="reference internal" href="#cfg_Servers_ssl_ciphers"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ciphers']</span></code></a>,
  538. <span class="target" id="index-39"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a></p>
  539. </div>
  540. </dd></dl>
  541. <dl class="config option">
  542. <dt class="sig sig-object config" id="cfg_Servers_ssl_ca_path">
  543. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['ssl_ca_path']</span></span><a class="headerlink" href="#cfg_Servers_ssl_ca_path" title="Permalink to this definition">¶</a></dt>
  544. <dd><dl class="field-list simple">
  545. <dt class="field-odd">Type<span class="colon">:</span></dt>
  546. <dd class="field-odd"><p>string</p>
  547. </dd>
  548. <dt class="field-even">Default value<span class="colon">:</span></dt>
  549. <dd class="field-even"><p>NULL</p>
  550. </dd>
  551. </dl>
  552. <p>Directory containing trusted SSL CA certificates in PEM format.</p>
  553. <div class="admonition seealso">
  554. <p class="admonition-title">See also</p>
  555. <p><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>,
  556. <a class="reference internal" href="#example-google-ssl"><span class="std std-ref">Google Cloud SQL with SSL</span></a>,
  557. <a class="reference internal" href="#example-aws-ssl"><span class="std std-ref">Amazon RDS Aurora with SSL</span></a>,
  558. <span class="target" id="index-40"></span><a class="reference internal" href="#cfg_Servers_ssl"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl']</span></code></a>,
  559. <span class="target" id="index-41"></span><a class="reference internal" href="#cfg_Servers_ssl_key"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_key']</span></code></a>,
  560. <span class="target" id="index-42"></span><a class="reference internal" href="#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_cert']</span></code></a>,
  561. <span class="target" id="index-43"></span><a class="reference internal" href="#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></code></a>,
  562. <span class="target" id="index-44"></span><a class="reference internal" href="#cfg_Servers_ssl_ciphers"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ciphers']</span></code></a>,
  563. <span class="target" id="index-45"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a></p>
  564. </div>
  565. </dd></dl>
  566. <dl class="config option">
  567. <dt class="sig sig-object config" id="cfg_Servers_ssl_ciphers">
  568. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['ssl_ciphers']</span></span><a class="headerlink" href="#cfg_Servers_ssl_ciphers" title="Permalink to this definition">¶</a></dt>
  569. <dd><dl class="field-list simple">
  570. <dt class="field-odd">Type<span class="colon">:</span></dt>
  571. <dd class="field-odd"><p>string</p>
  572. </dd>
  573. <dt class="field-even">Default value<span class="colon">:</span></dt>
  574. <dd class="field-even"><p>NULL</p>
  575. </dd>
  576. </dl>
  577. <p>List of allowable ciphers for SSL connections to the MySQL server.</p>
  578. <div class="admonition seealso">
  579. <p class="admonition-title">See also</p>
  580. <p><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>,
  581. <a class="reference internal" href="#example-google-ssl"><span class="std std-ref">Google Cloud SQL with SSL</span></a>,
  582. <a class="reference internal" href="#example-aws-ssl"><span class="std std-ref">Amazon RDS Aurora with SSL</span></a>,
  583. <span class="target" id="index-46"></span><a class="reference internal" href="#cfg_Servers_ssl"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl']</span></code></a>,
  584. <span class="target" id="index-47"></span><a class="reference internal" href="#cfg_Servers_ssl_key"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_key']</span></code></a>,
  585. <span class="target" id="index-48"></span><a class="reference internal" href="#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_cert']</span></code></a>,
  586. <span class="target" id="index-49"></span><a class="reference internal" href="#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></code></a>,
  587. <span class="target" id="index-50"></span><a class="reference internal" href="#cfg_Servers_ssl_ca_path"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca_path']</span></code></a>,
  588. <span class="target" id="index-51"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a></p>
  589. </div>
  590. </dd></dl>
  591. <dl class="config option">
  592. <dt class="sig sig-object config" id="cfg_Servers_ssl_verify">
  593. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></span><a class="headerlink" href="#cfg_Servers_ssl_verify" title="Permalink to this definition">¶</a></dt>
  594. <dd><dl class="field-list simple">
  595. <dt class="field-odd">Type<span class="colon">:</span></dt>
  596. <dd class="field-odd"><p>boolean</p>
  597. </dd>
  598. <dt class="field-even">Default value<span class="colon">:</span></dt>
  599. <dd class="field-even"><p>true</p>
  600. </dd>
  601. </dl>
  602. <div class="versionadded">
  603. <p><span class="versionmodified added">New in version 4.6.0: </span>This is supported since phpMyAdmin 4.6.0.</p>
  604. </div>
  605. <p>If your PHP install uses the MySQL Native Driver (mysqlnd), your
  606. MySQL server is 5.6 or later, and your SSL certificate is self-signed,
  607. there is a chance your SSL connection will fail due to validation.
  608. Setting this to <code class="docutils literal notranslate"><span class="pre">false</span></code> will disable the validation check.</p>
  609. <p>Since PHP 5.6.0 it also verifies whether server name matches CN of its
  610. certificate. There is currently no way to disable just this check without
  611. disabling complete SSL verification.</p>
  612. <div class="admonition warning">
  613. <p class="admonition-title">Warning</p>
  614. <p>Disabling the certificate verification defeats purpose of using SSL.
  615. This will make the connection vulnerable to man in the middle attacks.</p>
  616. </div>
  617. <div class="admonition note">
  618. <p class="admonition-title">Note</p>
  619. <p>This flag only works with PHP 5.6.16 or later.</p>
  620. </div>
  621. <div class="admonition seealso">
  622. <p class="admonition-title">See also</p>
  623. <p><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>,
  624. <a class="reference internal" href="#example-google-ssl"><span class="std std-ref">Google Cloud SQL with SSL</span></a>,
  625. <a class="reference internal" href="#example-aws-ssl"><span class="std std-ref">Amazon RDS Aurora with SSL</span></a>,
  626. <span class="target" id="index-52"></span><a class="reference internal" href="#cfg_Servers_ssl"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl']</span></code></a>,
  627. <span class="target" id="index-53"></span><a class="reference internal" href="#cfg_Servers_ssl_key"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_key']</span></code></a>,
  628. <span class="target" id="index-54"></span><a class="reference internal" href="#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_cert']</span></code></a>,
  629. <span class="target" id="index-55"></span><a class="reference internal" href="#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></code></a>,
  630. <span class="target" id="index-56"></span><a class="reference internal" href="#cfg_Servers_ssl_ca_path"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca_path']</span></code></a>,
  631. <span class="target" id="index-57"></span><a class="reference internal" href="#cfg_Servers_ssl_ciphers"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ciphers']</span></code></a>,
  632. <span class="target" id="index-58"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a></p>
  633. </div>
  634. </dd></dl>
  635. <dl class="config option">
  636. <dt class="sig sig-object config" id="cfg_Servers_connect_type">
  637. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['connect_type']</span></span><a class="headerlink" href="#cfg_Servers_connect_type" title="Permalink to this definition">¶</a></dt>
  638. <dd><dl class="field-list simple">
  639. <dt class="field-odd">Type<span class="colon">:</span></dt>
  640. <dd class="field-odd"><p>string</p>
  641. </dd>
  642. <dt class="field-even">Default value<span class="colon">:</span></dt>
  643. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'tcp'</span></code></p>
  644. </dd>
  645. </dl>
  646. <div class="deprecated">
  647. <p><span class="versionmodified deprecated">Deprecated since version 4.7.0: </span>This setting is no longer used as of 4.7.0, since MySQL decides the
  648. connection type based on host, so it could lead to unexpected results.
  649. Please set <span class="target" id="index-59"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a> accordingly
  650. instead.</p>
  651. </div>
  652. <p>What type connection to use with the MySQL server. Your options are
  653. <code class="docutils literal notranslate"><span class="pre">'socket'</span></code> and <code class="docutils literal notranslate"><span class="pre">'tcp'</span></code>. It defaults to tcp as that is nearly guaranteed
  654. to be available on all MySQL servers, while sockets are not supported on
  655. some platforms. To use the socket mode, your MySQL server must be on the
  656. same machine as the Web server.</p>
  657. </dd></dl>
  658. <dl class="config option">
  659. <dt class="sig sig-object config" id="cfg_Servers_compress">
  660. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['compress']</span></span><a class="headerlink" href="#cfg_Servers_compress" title="Permalink to this definition">¶</a></dt>
  661. <dd><dl class="field-list simple">
  662. <dt class="field-odd">Type<span class="colon">:</span></dt>
  663. <dd class="field-odd"><p>boolean</p>
  664. </dd>
  665. <dt class="field-even">Default value<span class="colon">:</span></dt>
  666. <dd class="field-even"><p>false</p>
  667. </dd>
  668. </dl>
  669. <p>Whether to use a compressed protocol for the MySQL server connection
  670. or not (experimental).</p>
  671. </dd></dl>
  672. <span class="target" id="controlhost"></span><dl class="config option">
  673. <dt class="sig sig-object config" id="cfg_Servers_controlhost">
  674. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['controlhost']</span></span><a class="headerlink" href="#cfg_Servers_controlhost" title="Permalink to this definition">¶</a></dt>
  675. <dd><dl class="field-list simple">
  676. <dt class="field-odd">Type<span class="colon">:</span></dt>
  677. <dd class="field-odd"><p>string</p>
  678. </dd>
  679. <dt class="field-even">Default value<span class="colon">:</span></dt>
  680. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  681. </dd>
  682. </dl>
  683. <p>Permits to use an alternate host to hold the configuration storage
  684. data.</p>
  685. <div class="admonition seealso">
  686. <p class="admonition-title">See also</p>
  687. <p><span class="target" id="index-60"></span><a class="reference internal" href="#cfg_Servers_control_*"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['control_*']</span></code></a></p>
  688. </div>
  689. </dd></dl>
  690. <span class="target" id="controlport"></span><dl class="config option">
  691. <dt class="sig sig-object config" id="cfg_Servers_controlport">
  692. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['controlport']</span></span><a class="headerlink" href="#cfg_Servers_controlport" title="Permalink to this definition">¶</a></dt>
  693. <dd><dl class="field-list simple">
  694. <dt class="field-odd">Type<span class="colon">:</span></dt>
  695. <dd class="field-odd"><p>string</p>
  696. </dd>
  697. <dt class="field-even">Default value<span class="colon">:</span></dt>
  698. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  699. </dd>
  700. </dl>
  701. <p>Permits to use an alternate port to connect to the host that
  702. holds the configuration storage.</p>
  703. <div class="admonition seealso">
  704. <p class="admonition-title">See also</p>
  705. <p><span class="target" id="index-61"></span><a class="reference internal" href="#cfg_Servers_control_*"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['control_*']</span></code></a></p>
  706. </div>
  707. </dd></dl>
  708. <span class="target" id="controluser"></span><dl class="config option">
  709. <dt class="sig sig-object config" id="cfg_Servers_controluser">
  710. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['controluser']</span></span><a class="headerlink" href="#cfg_Servers_controluser" title="Permalink to this definition">¶</a></dt>
  711. <dd><dl class="field-list simple">
  712. <dt class="field-odd">Type<span class="colon">:</span></dt>
  713. <dd class="field-odd"><p>string</p>
  714. </dd>
  715. <dt class="field-even">Default value<span class="colon">:</span></dt>
  716. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  717. </dd>
  718. </dl>
  719. </dd></dl>
  720. <dl class="config option">
  721. <dt class="sig sig-object config" id="cfg_Servers_controlpass">
  722. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['controlpass']</span></span><a class="headerlink" href="#cfg_Servers_controlpass" title="Permalink to this definition">¶</a></dt>
  723. <dd><dl class="field-list simple">
  724. <dt class="field-odd">Type<span class="colon">:</span></dt>
  725. <dd class="field-odd"><p>string</p>
  726. </dd>
  727. <dt class="field-even">Default value<span class="colon">:</span></dt>
  728. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  729. </dd>
  730. </dl>
  731. <p>This special account is used to access <a class="reference internal" href="setup.html#linked-tables"><span class="std std-ref">phpMyAdmin configuration storage</span></a>.
  732. You don’t need it in single user case, but if phpMyAdmin is shared it
  733. is recommended to give access to <a class="reference internal" href="setup.html#linked-tables"><span class="std std-ref">phpMyAdmin configuration storage</span></a> only to this user
  734. and configure phpMyAdmin to use it. All users will then be able to use
  735. the features without need to have direct access to <a class="reference internal" href="setup.html#linked-tables"><span class="std std-ref">phpMyAdmin configuration storage</span></a>.</p>
  736. <div class="versionchanged">
  737. <p><span class="versionmodified changed">Changed in version 2.2.5: </span>those were called <code class="docutils literal notranslate"><span class="pre">stduser</span></code> and <code class="docutils literal notranslate"><span class="pre">stdpass</span></code></p>
  738. </div>
  739. <div class="admonition seealso">
  740. <p class="admonition-title">See also</p>
  741. <p><a class="reference internal" href="setup.html#setup"><span class="std std-ref">Installation</span></a>,
  742. <a class="reference internal" href="setup.html#authentication-modes"><span class="std std-ref">Using authentication modes</span></a>,
  743. <a class="reference internal" href="setup.html#linked-tables"><span class="std std-ref">phpMyAdmin configuration storage</span></a>,
  744. <span class="target" id="index-62"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a>,
  745. <span class="target" id="index-63"></span><a class="reference internal" href="#cfg_Servers_controlhost"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['controlhost']</span></code></a>,
  746. <span class="target" id="index-64"></span><a class="reference internal" href="#cfg_Servers_controlport"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['controlport']</span></code></a>,
  747. <span class="target" id="index-65"></span><a class="reference internal" href="#cfg_Servers_control_*"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['control_*']</span></code></a></p>
  748. </div>
  749. </dd></dl>
  750. <dl class="config option">
  751. <dt class="sig sig-object config" id="cfg_Servers_control_*">
  752. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['control_*']</span></span><a class="headerlink" href="#cfg_Servers_control_*" title="Permalink to this definition">¶</a></dt>
  753. <dd><dl class="field-list simple">
  754. <dt class="field-odd">Type<span class="colon">:</span></dt>
  755. <dd class="field-odd"><p>mixed</p>
  756. </dd>
  757. </dl>
  758. <div class="versionadded">
  759. <p><span class="versionmodified added">New in version 4.7.0.</span></p>
  760. </div>
  761. <p>You can change any MySQL connection setting for control link (used to
  762. access <a class="reference internal" href="setup.html#linked-tables"><span class="std std-ref">phpMyAdmin configuration storage</span></a>) using configuration prefixed with <code class="docutils literal notranslate"><span class="pre">control_</span></code>.</p>
  763. <p>This can be used to change any aspect of the control connection, which by
  764. default uses same parameters as the user one.</p>
  765. <p>For example you can configure SSL for the control connection:</p>
  766. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Enable SSL</span>
  767. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;control_ssl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
  768. <span class="c1">// Client secret key</span>
  769. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;control_ssl_key&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;../client-key.pem&#39;</span><span class="p">;</span>
  770. <span class="c1">// Client certificate</span>
  771. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;control_ssl_cert&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;../client-cert.pem&#39;</span><span class="p">;</span>
  772. <span class="c1">// Server certification authority</span>
  773. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;control_ssl_ca&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;../server-ca.pem&#39;</span><span class="p">;</span>
  774. </pre></div>
  775. </div>
  776. <div class="admonition seealso">
  777. <p class="admonition-title">See also</p>
  778. <p><span class="target" id="index-66"></span><a class="reference internal" href="#cfg_Servers_ssl"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl']</span></code></a>,
  779. <span class="target" id="index-67"></span><a class="reference internal" href="#cfg_Servers_ssl_key"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_key']</span></code></a>,
  780. <span class="target" id="index-68"></span><a class="reference internal" href="#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_cert']</span></code></a>,
  781. <span class="target" id="index-69"></span><a class="reference internal" href="#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></code></a>,
  782. <span class="target" id="index-70"></span><a class="reference internal" href="#cfg_Servers_ssl_ca_path"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca_path']</span></code></a>,
  783. <span class="target" id="index-71"></span><a class="reference internal" href="#cfg_Servers_ssl_ciphers"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ciphers']</span></code></a>,
  784. <span class="target" id="index-72"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a></p>
  785. </div>
  786. </dd></dl>
  787. <dl class="config option">
  788. <dt class="sig sig-object config" id="cfg_Servers_auth_type">
  789. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['auth_type']</span></span><a class="headerlink" href="#cfg_Servers_auth_type" title="Permalink to this definition">¶</a></dt>
  790. <dd><dl class="field-list simple">
  791. <dt class="field-odd">Type<span class="colon">:</span></dt>
  792. <dd class="field-odd"><p>string</p>
  793. </dd>
  794. <dt class="field-even">Default value<span class="colon">:</span></dt>
  795. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'cookie'</span></code></p>
  796. </dd>
  797. </dl>
  798. <p>Whether config or cookie or <a class="reference internal" href="glossary.html#term-HTTP"><span class="xref std std-term">HTTP</span></a> or signon authentication should be
  799. used for this server.</p>
  800. <ul class="simple">
  801. <li><p>‘config’ authentication (<code class="docutils literal notranslate"><span class="pre">$auth_type</span> <span class="pre">=</span> <span class="pre">'config'</span></code>) is the plain old
  802. way: username and password are stored in <code class="file docutils literal notranslate"><span class="pre">config.inc.php</span></code>.</p></li>
  803. <li><p>‘cookie’ authentication mode (<code class="docutils literal notranslate"><span class="pre">$auth_type</span> <span class="pre">=</span> <span class="pre">'cookie'</span></code>) allows you to
  804. log in as any valid MySQL user with the help of cookies.</p></li>
  805. <li><p>‘http’ authentication allows you to log in as any
  806. valid MySQL user via HTTP-Auth.</p></li>
  807. <li><p>‘signon’ authentication mode (<code class="docutils literal notranslate"><span class="pre">$auth_type</span> <span class="pre">=</span> <span class="pre">'signon'</span></code>) allows you to
  808. log in from prepared PHP session data or using supplied PHP script.</p></li>
  809. </ul>
  810. <div class="admonition seealso">
  811. <p class="admonition-title">See also</p>
  812. <p><a class="reference internal" href="setup.html#authentication-modes"><span class="std std-ref">Using authentication modes</span></a></p>
  813. </div>
  814. </dd></dl>
  815. <span class="target" id="servers-auth-http-realm"></span><dl class="config option">
  816. <dt class="sig sig-object config" id="cfg_Servers_auth_http_realm">
  817. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['auth_http_realm']</span></span><a class="headerlink" href="#cfg_Servers_auth_http_realm" title="Permalink to this definition">¶</a></dt>
  818. <dd><dl class="field-list simple">
  819. <dt class="field-odd">Type<span class="colon">:</span></dt>
  820. <dd class="field-odd"><p>string</p>
  821. </dd>
  822. <dt class="field-even">Default value<span class="colon">:</span></dt>
  823. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  824. </dd>
  825. </dl>
  826. <p>When using auth_type = <code class="docutils literal notranslate"><span class="pre">http</span></code>, this field allows to define a custom
  827. <a class="reference internal" href="glossary.html#term-HTTP"><span class="xref std std-term">HTTP</span></a> Basic Auth Realm which will be displayed to the user. If not
  828. explicitly specified in your configuration, a string combined of
  829. “phpMyAdmin “ and either <span class="target" id="index-73"></span><a class="reference internal" href="#cfg_Servers_verbose"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['verbose']</span></code></a> or
  830. <span class="target" id="index-74"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a> will be used.</p>
  831. </dd></dl>
  832. <span class="target" id="servers-auth-swekey-config"></span><dl class="config option">
  833. <dt class="sig sig-object config" id="cfg_Servers_auth_swekey_config">
  834. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['auth_swekey_config']</span></span><a class="headerlink" href="#cfg_Servers_auth_swekey_config" title="Permalink to this definition">¶</a></dt>
  835. <dd><dl class="field-list simple">
  836. <dt class="field-odd">Type<span class="colon">:</span></dt>
  837. <dd class="field-odd"><p>string</p>
  838. </dd>
  839. <dt class="field-even">Default value<span class="colon">:</span></dt>
  840. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  841. </dd>
  842. </dl>
  843. <div class="versionadded">
  844. <p><span class="versionmodified added">New in version 3.0.0.0: </span>This setting was named <cite>$cfg[‘Servers’][$i][‘auth_feebee_config’]</cite> and was renamed before the <cite>3.0.0.0</cite> release.</p>
  845. </div>
  846. <div class="deprecated">
  847. <p><span class="versionmodified deprecated">Deprecated since version 4.6.4: </span>This setting was removed because their servers are no longer working and it was not working correctly.</p>
  848. </div>
  849. <div class="deprecated">
  850. <p><span class="versionmodified deprecated">Deprecated since version 4.0.10.17: </span>This setting was removed in a maintenance release because their servers are no longer working and it was not working correctly.</p>
  851. </div>
  852. <p>The name of the file containing swekey ids and login names for hardware
  853. authentication. Leave empty to deactivate this feature.</p>
  854. </dd></dl>
  855. <span class="target" id="servers-user"></span><dl class="config option">
  856. <dt class="sig sig-object config" id="cfg_Servers_user">
  857. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['user']</span></span><a class="headerlink" href="#cfg_Servers_user" title="Permalink to this definition">¶</a></dt>
  858. <dd><dl class="field-list simple">
  859. <dt class="field-odd">Type<span class="colon">:</span></dt>
  860. <dd class="field-odd"><p>string</p>
  861. </dd>
  862. <dt class="field-even">Default value<span class="colon">:</span></dt>
  863. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'root'</span></code></p>
  864. </dd>
  865. </dl>
  866. </dd></dl>
  867. <dl class="config option">
  868. <dt class="sig sig-object config" id="cfg_Servers_password">
  869. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['password']</span></span><a class="headerlink" href="#cfg_Servers_password" title="Permalink to this definition">¶</a></dt>
  870. <dd><dl class="field-list simple">
  871. <dt class="field-odd">Type<span class="colon">:</span></dt>
  872. <dd class="field-odd"><p>string</p>
  873. </dd>
  874. <dt class="field-even">Default value<span class="colon">:</span></dt>
  875. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  876. </dd>
  877. </dl>
  878. <p>When using <span class="target" id="index-75"></span><a class="reference internal" href="#cfg_Servers_auth_type"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['auth_type']</span></code></a> set to
  879. ‘config’, this is the user/password-pair which phpMyAdmin will use to
  880. connect to the MySQL server. This user/password pair is not needed when
  881. <a class="reference internal" href="glossary.html#term-HTTP"><span class="xref std std-term">HTTP</span></a> or cookie authentication is used
  882. and should be empty.</p>
  883. </dd></dl>
  884. <span class="target" id="servers-nopassword"></span><dl class="config option">
  885. <dt class="sig sig-object config" id="cfg_Servers_nopassword">
  886. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['nopassword']</span></span><a class="headerlink" href="#cfg_Servers_nopassword" title="Permalink to this definition">¶</a></dt>
  887. <dd><dl class="field-list simple">
  888. <dt class="field-odd">Type<span class="colon">:</span></dt>
  889. <dd class="field-odd"><p>boolean</p>
  890. </dd>
  891. <dt class="field-even">Default value<span class="colon">:</span></dt>
  892. <dd class="field-even"><p>false</p>
  893. </dd>
  894. </dl>
  895. <div class="deprecated">
  896. <p><span class="versionmodified deprecated">Deprecated since version 4.7.0: </span>This setting was removed as it can produce unexpected results.</p>
  897. </div>
  898. <p>Allow attempt to log in without password when a login with password
  899. fails. This can be used together with http authentication, when
  900. authentication is done some other way and phpMyAdmin gets user name
  901. from auth and uses empty password for connecting to MySQL. Password
  902. login is still tried first, but as fallback, no password method is
  903. tried.</p>
  904. <div class="admonition note">
  905. <p class="admonition-title">Note</p>
  906. <p>It is possible to allow logging in with no password with
  907. the <span class="target" id="index-76"></span><a class="reference internal" href="#cfg_Servers_AllowNoPassword"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['AllowNoPassword']</span></code></a> directive.</p>
  908. </div>
  909. </dd></dl>
  910. <span class="target" id="servers-only-db"></span><dl class="config option">
  911. <dt class="sig sig-object config" id="cfg_Servers_only_db">
  912. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['only_db']</span></span><a class="headerlink" href="#cfg_Servers_only_db" title="Permalink to this definition">¶</a></dt>
  913. <dd><dl class="field-list simple">
  914. <dt class="field-odd">Type<span class="colon">:</span></dt>
  915. <dd class="field-odd"><p>string or array</p>
  916. </dd>
  917. <dt class="field-even">Default value<span class="colon">:</span></dt>
  918. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  919. </dd>
  920. </dl>
  921. <p>If set to a (an array of) database name(s), only this (these)
  922. database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
  923. this/these database(s) name(s) may contain MySQL wildcards characters
  924. (”_” and “%”): if you want to use literal instances of these
  925. characters, escape them (I.E. use <code class="docutils literal notranslate"><span class="pre">'my\_db'</span></code> and not <code class="docutils literal notranslate"><span class="pre">'my_db'</span></code>).</p>
  926. <p>This setting is an efficient way to lower the server load since the
  927. latter does not need to send MySQL requests to build the available
  928. database list. But <strong>it does not replace the privileges rules of the
  929. MySQL database server</strong>. If set, it just means only these databases
  930. will be displayed but <strong>not that all other databases can’t be used.</strong></p>
  931. <p>An example of using more that one database:</p>
  932. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;only_db&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;db1&#39;</span><span class="p">,</span> <span class="s1">&#39;db2&#39;</span><span class="p">];</span>
  933. </pre></div>
  934. </div>
  935. <div class="versionchanged">
  936. <p><span class="versionmodified changed">Changed in version 4.0.0: </span>Previous versions permitted to specify the display order of
  937. the database names via this directive.</p>
  938. </div>
  939. </dd></dl>
  940. <dl class="config option">
  941. <dt class="sig sig-object config" id="cfg_Servers_hide_db">
  942. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['hide_db']</span></span><a class="headerlink" href="#cfg_Servers_hide_db" title="Permalink to this definition">¶</a></dt>
  943. <dd><dl class="field-list simple">
  944. <dt class="field-odd">Type<span class="colon">:</span></dt>
  945. <dd class="field-odd"><p>string</p>
  946. </dd>
  947. <dt class="field-even">Default value<span class="colon">:</span></dt>
  948. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  949. </dd>
  950. </dl>
  951. <p>Regular expression for hiding some databases from unprivileged users.
  952. This only hides them from listing, but a user is still able to access
  953. them (using, for example, the SQL query area). To limit access, use
  954. the MySQL privilege system. For example, to hide all databases
  955. starting with the letter “a”, use</p>
  956. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;hide_db&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;^a&#39;</span><span class="p">;</span>
  957. </pre></div>
  958. </div>
  959. <p>and to hide both “db1” and “db2” use</p>
  960. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;hide_db&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;^(db1|db2)$&#39;</span><span class="p">;</span>
  961. </pre></div>
  962. </div>
  963. <p>More information on regular expressions can be found in the <a class="reference external" href="https://www.php.net/manual/en/reference.pcre.pattern.syntax.php">PCRE
  964. pattern syntax</a> portion
  965. of the PHP reference manual.</p>
  966. </dd></dl>
  967. <dl class="config option">
  968. <dt class="sig sig-object config" id="cfg_Servers_verbose">
  969. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['verbose']</span></span><a class="headerlink" href="#cfg_Servers_verbose" title="Permalink to this definition">¶</a></dt>
  970. <dd><dl class="field-list simple">
  971. <dt class="field-odd">Type<span class="colon">:</span></dt>
  972. <dd class="field-odd"><p>string</p>
  973. </dd>
  974. <dt class="field-even">Default value<span class="colon">:</span></dt>
  975. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  976. </dd>
  977. </dl>
  978. <p>Only useful when using phpMyAdmin with multiple server entries. If
  979. set, this string will be displayed instead of the hostname in the
  980. pull-down menu on the main page. This can be useful if you want to
  981. show only certain databases on your system, for example. For HTTP
  982. auth, all non-US-ASCII characters will be stripped.</p>
  983. </dd></dl>
  984. <dl class="config option">
  985. <dt class="sig sig-object config" id="cfg_Servers_extension">
  986. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['extension']</span></span><a class="headerlink" href="#cfg_Servers_extension" title="Permalink to this definition">¶</a></dt>
  987. <dd><dl class="field-list simple">
  988. <dt class="field-odd">Type<span class="colon">:</span></dt>
  989. <dd class="field-odd"><p>string</p>
  990. </dd>
  991. <dt class="field-even">Default value<span class="colon">:</span></dt>
  992. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'mysqli'</span></code></p>
  993. </dd>
  994. </dl>
  995. <div class="deprecated">
  996. <p><span class="versionmodified deprecated">Deprecated since version 4.2.0: </span>This setting was removed. The <code class="docutils literal notranslate"><span class="pre">mysql</span></code> extension will only be used when
  997. the <code class="docutils literal notranslate"><span class="pre">mysqli</span></code> extension is not available. As of 5.0.0, only the
  998. <code class="docutils literal notranslate"><span class="pre">mysqli</span></code> extension can be used.</p>
  999. </div>
  1000. <p>The PHP MySQL extension to use (<code class="docutils literal notranslate"><span class="pre">mysql</span></code> or <code class="docutils literal notranslate"><span class="pre">mysqli</span></code>).</p>
  1001. <p>It is recommended to use <code class="docutils literal notranslate"><span class="pre">mysqli</span></code> in all installations.</p>
  1002. </dd></dl>
  1003. <dl class="config option">
  1004. <dt class="sig sig-object config" id="cfg_Servers_pmadb">
  1005. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></span><a class="headerlink" href="#cfg_Servers_pmadb" title="Permalink to this definition">¶</a></dt>
  1006. <dd><dl class="field-list simple">
  1007. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1008. <dd class="field-odd"><p>string</p>
  1009. </dd>
  1010. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1011. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1012. </dd>
  1013. </dl>
  1014. <p>The name of the database containing the phpMyAdmin configuration
  1015. storage.</p>
  1016. <p>See the <a class="reference internal" href="setup.html#linked-tables"><span class="std std-ref">phpMyAdmin configuration storage</span></a> section in this document to see the benefits of
  1017. this feature, and for a quick way of creating this database and the needed
  1018. tables.</p>
  1019. <p>If you are the only user of this phpMyAdmin installation, you can use your
  1020. current database to store those special tables; in this case, just put your
  1021. current database name in <span class="target" id="index-77"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a>. For a
  1022. multi-user installation, set this parameter to the name of your central
  1023. database containing the phpMyAdmin configuration storage.</p>
  1024. </dd></dl>
  1025. <span class="target" id="bookmark"></span><dl class="config option">
  1026. <dt class="sig sig-object config" id="cfg_Servers_bookmarktable">
  1027. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['bookmarktable']</span></span><a class="headerlink" href="#cfg_Servers_bookmarktable" title="Permalink to this definition">¶</a></dt>
  1028. <dd><dl class="field-list simple">
  1029. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1030. <dd class="field-odd"><p>string or false</p>
  1031. </dd>
  1032. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1033. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1034. </dd>
  1035. </dl>
  1036. <div class="versionadded">
  1037. <p><span class="versionmodified added">New in version 2.2.0.</span></p>
  1038. </div>
  1039. <p>Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This
  1040. can be useful for queries you often run. To allow the usage of this
  1041. functionality:</p>
  1042. <ul class="simple">
  1043. <li><p>set up <span class="target" id="index-78"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1044. <li><p>enter the table name in <span class="target" id="index-79"></span><a class="reference internal" href="#cfg_Servers_bookmarktable"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['bookmarktable']</span></code></a></p></li>
  1045. </ul>
  1046. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1047. </dd></dl>
  1048. <span class="target" id="relation"></span><dl class="config option">
  1049. <dt class="sig sig-object config" id="cfg_Servers_relation">
  1050. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['relation']</span></span><a class="headerlink" href="#cfg_Servers_relation" title="Permalink to this definition">¶</a></dt>
  1051. <dd><dl class="field-list simple">
  1052. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1053. <dd class="field-odd"><p>string or false</p>
  1054. </dd>
  1055. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1056. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1057. </dd>
  1058. </dl>
  1059. <div class="versionadded">
  1060. <p><span class="versionmodified added">New in version 2.2.4.</span></p>
  1061. </div>
  1062. <p>Since release 2.2.4 you can describe, in a special ‘relation’ table,
  1063. which column is a key in another table (a foreign key). phpMyAdmin
  1064. currently uses this to:</p>
  1065. <ul class="simple">
  1066. <li><p>make clickable, when you browse the master table, the data values that
  1067. point to the foreign table;</p></li>
  1068. <li><p>display in an optional tool-tip the “display column” when browsing the
  1069. master table, if you move the mouse to a column containing a foreign
  1070. key (use also the ‘table_info’ table); (see <a class="reference internal" href="faq.html#faqdisplay"><span class="std std-ref">6.7 How can I use the “display column” feature?</span></a>)</p></li>
  1071. <li><p>in edit/insert mode, display a drop-down list of possible foreign keys
  1072. (key value and “display column” are shown) (see <a class="reference internal" href="faq.html#faq6-21"><span class="std std-ref">6.21 In edit/insert mode, how can I see a list of possible values for a column, based on some foreign table?</span></a>)</p></li>
  1073. <li><p>display links on the table properties page, to check referential
  1074. integrity (display missing foreign keys) for each described key;</p></li>
  1075. <li><p>in query-by-example, create automatic joins (see <a class="reference internal" href="faq.html#faq6-6"><span class="std std-ref">6.6 How can I use the relation table in Query-by-example?</span></a>)</p></li>
  1076. <li><p>enable you to get a <a class="reference internal" href="glossary.html#term-PDF"><span class="xref std std-term">PDF</span></a> schema of
  1077. your database (also uses the table_coords table).</p></li>
  1078. </ul>
  1079. <p>The keys can be numeric or character.</p>
  1080. <p>To allow the usage of this functionality:</p>
  1081. <ul class="simple">
  1082. <li><p>set up <span class="target" id="index-80"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1083. <li><p>put the relation table name in <span class="target" id="index-81"></span><a class="reference internal" href="#cfg_Servers_relation"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['relation']</span></code></a></p></li>
  1084. <li><p>now as normal user open phpMyAdmin and for each one of your tables
  1085. where you want to use this feature, click <span class="guilabel">Structure/Relation view/</span>
  1086. and choose foreign columns.</p></li>
  1087. </ul>
  1088. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1089. <div class="admonition note">
  1090. <p class="admonition-title">Note</p>
  1091. <p>In the current version, <code class="docutils literal notranslate"><span class="pre">master_db</span></code> must be the same as <code class="docutils literal notranslate"><span class="pre">foreign_db</span></code>.
  1092. Those columns have been put in future development of the cross-db
  1093. relations.</p>
  1094. </div>
  1095. </dd></dl>
  1096. <span class="target" id="table-info"></span><dl class="config option">
  1097. <dt class="sig sig-object config" id="cfg_Servers_table_info">
  1098. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['table_info']</span></span><a class="headerlink" href="#cfg_Servers_table_info" title="Permalink to this definition">¶</a></dt>
  1099. <dd><dl class="field-list simple">
  1100. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1101. <dd class="field-odd"><p>string or false</p>
  1102. </dd>
  1103. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1104. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1105. </dd>
  1106. </dl>
  1107. <div class="versionadded">
  1108. <p><span class="versionmodified added">New in version 2.3.0.</span></p>
  1109. </div>
  1110. <p>Since release 2.3.0 you can describe, in a special ‘table_info’
  1111. table, which column is to be displayed as a tool-tip when moving the
  1112. cursor over the corresponding key. This configuration variable will
  1113. hold the name of this special table. To allow the usage of this
  1114. functionality:</p>
  1115. <ul class="simple">
  1116. <li><p>set up <span class="target" id="index-82"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1117. <li><p>put the table name in <span class="target" id="index-83"></span><a class="reference internal" href="#cfg_Servers_table_info"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['table_info']</span></code></a> (e.g.
  1118. <code class="docutils literal notranslate"><span class="pre">pma__table_info</span></code>)</p></li>
  1119. <li><p>then for each table where you want to use this feature, click
  1120. “Structure/Relation view/Choose column to display” to choose the
  1121. column.</p></li>
  1122. </ul>
  1123. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1124. <div class="admonition seealso">
  1125. <p class="admonition-title">See also</p>
  1126. <p><a class="reference internal" href="faq.html#faqdisplay"><span class="std std-ref">6.7 How can I use the “display column” feature?</span></a></p>
  1127. </div>
  1128. </dd></dl>
  1129. <span class="target" id="table-coords"></span><dl class="config option">
  1130. <dt class="sig sig-object config" id="cfg_Servers_table_coords">
  1131. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['table_coords']</span></span><a class="headerlink" href="#cfg_Servers_table_coords" title="Permalink to this definition">¶</a></dt>
  1132. <dd><dl class="field-list simple">
  1133. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1134. <dd class="field-odd"><p>string or false</p>
  1135. </dd>
  1136. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1137. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1138. </dd>
  1139. </dl>
  1140. <p>The designer feature can save your page layout; by pressing the “Save page” or “Save page as”
  1141. button in the expanding designer menu, you can customize the layout and have it loaded the next
  1142. time you use the designer. That layout is stored in this table. Furthermore, this table is also
  1143. required for using the PDF relation export feature, see
  1144. <span class="target" id="index-84"></span><a class="reference internal" href="#cfg_Servers_pdf_pages"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pdf_pages']</span></code></a> for additional details.</p>
  1145. </dd></dl>
  1146. <dl class="config option">
  1147. <dt class="sig sig-object config" id="cfg_Servers_pdf_pages">
  1148. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['pdf_pages']</span></span><a class="headerlink" href="#cfg_Servers_pdf_pages" title="Permalink to this definition">¶</a></dt>
  1149. <dd><dl class="field-list simple">
  1150. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1151. <dd class="field-odd"><p>string or false</p>
  1152. </dd>
  1153. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1154. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1155. </dd>
  1156. </dl>
  1157. <div class="versionadded">
  1158. <p><span class="versionmodified added">New in version 2.3.0.</span></p>
  1159. </div>
  1160. <p>Since release 2.3.0 you can have phpMyAdmin create <a class="reference internal" href="glossary.html#term-PDF"><span class="xref std std-term">PDF</span></a> pages
  1161. showing the relations between your tables. Further, the designer interface
  1162. permits visually managing the relations. To do this it needs two tables
  1163. “pdf_pages” (storing information about the available <a class="reference internal" href="glossary.html#term-PDF"><span class="xref std std-term">PDF</span></a> pages)
  1164. and “table_coords” (storing coordinates where each table will be placed on
  1165. a <a class="reference internal" href="glossary.html#term-PDF"><span class="xref std std-term">PDF</span></a> schema output). You must be using the “relation” feature.</p>
  1166. <p>To allow the usage of this functionality:</p>
  1167. <ul class="simple">
  1168. <li><p>set up <span class="target" id="index-85"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1169. <li><p>put the correct table names in
  1170. <span class="target" id="index-86"></span><a class="reference internal" href="#cfg_Servers_table_coords"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['table_coords']</span></code></a> and
  1171. <span class="target" id="index-87"></span><a class="reference internal" href="#cfg_Servers_pdf_pages"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pdf_pages']</span></code></a></p></li>
  1172. </ul>
  1173. <p>This feature can be disabled by setting either of the configurations to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1174. <div class="admonition seealso">
  1175. <p class="admonition-title">See also</p>
  1176. <p><a class="reference internal" href="faq.html#faqpdf"><span class="std std-ref">6.8 How can I produce a PDF schema of my database?</span></a>.</p>
  1177. </div>
  1178. </dd></dl>
  1179. <span class="target" id="designer-coords"></span><dl class="config option">
  1180. <dt class="sig sig-object config" id="cfg_Servers_designer_coords">
  1181. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['designer_coords']</span></span><a class="headerlink" href="#cfg_Servers_designer_coords" title="Permalink to this definition">¶</a></dt>
  1182. <dd><dl class="field-list simple">
  1183. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1184. <dd class="field-odd"><p>string</p>
  1185. </dd>
  1186. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1187. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1188. </dd>
  1189. </dl>
  1190. <div class="versionadded">
  1191. <p><span class="versionmodified added">New in version 2.10.0: </span>Since release 2.10.0 a Designer interface is available; it permits to
  1192. visually manage the relations.</p>
  1193. </div>
  1194. <div class="deprecated">
  1195. <p><span class="versionmodified deprecated">Deprecated since version 4.3.0: </span>This setting was removed and the Designer table positioning data is now stored into <span class="target" id="index-88"></span><a class="reference internal" href="#cfg_Servers_table_coords"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['table_coords']</span></code></a>.</p>
  1196. </div>
  1197. <div class="admonition note">
  1198. <p class="admonition-title">Note</p>
  1199. <p>You can now delete the table <cite>pma__designer_coords</cite> from your phpMyAdmin configuration storage database and remove <span class="target" id="index-89"></span><a class="reference internal" href="#cfg_Servers_designer_coords"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['designer_coords']</span></code></a> from your configuration file.</p>
  1200. </div>
  1201. </dd></dl>
  1202. <span class="target" id="col-com"></span><dl class="config option">
  1203. <dt class="sig sig-object config" id="cfg_Servers_column_info">
  1204. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['column_info']</span></span><a class="headerlink" href="#cfg_Servers_column_info" title="Permalink to this definition">¶</a></dt>
  1205. <dd><dl class="field-list simple">
  1206. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1207. <dd class="field-odd"><p>string or false</p>
  1208. </dd>
  1209. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1210. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1211. </dd>
  1212. </dl>
  1213. <div class="versionadded">
  1214. <p><span class="versionmodified added">New in version 2.3.0.</span></p>
  1215. </div>
  1216. <p>This part requires a content update! Since release 2.3.0 you can
  1217. store comments to describe each column for each table. These will then
  1218. be shown on the “printview”.</p>
  1219. <p>Starting with release 2.5.0, comments are consequently used on the table
  1220. property pages and table browse view, showing up as tool-tips above the
  1221. column name (properties page) or embedded within the header of table in
  1222. browse view. They can also be shown in a table dump. Please see the
  1223. relevant configuration directives later on.</p>
  1224. <p>Also new in release 2.5.0 is a MIME- transformation system which is also
  1225. based on the following table structure. See <a class="reference internal" href="transformations.html#transformations"><span class="std std-ref">Transformations</span></a> for
  1226. further information. To use the MIME- transformation system, your
  1227. column_info table has to have the three new columns ‘mimetype’,
  1228. ‘transformation’, ‘transformation_options’.</p>
  1229. <p>Starting with release 4.3.0, a new input-oriented transformation system
  1230. has been introduced. Also, backward compatibility code used in the old
  1231. transformations system was removed. As a result, an update to column_info
  1232. table is necessary for previous transformations and the new input-oriented
  1233. transformation system to work. phpMyAdmin will upgrade it automatically
  1234. for you by analyzing your current column_info table structure.
  1235. However, if something goes wrong with the auto-upgrade then you can
  1236. use the SQL script found in <code class="docutils literal notranslate"><span class="pre">./sql/upgrade_column_info_4_3_0+.sql</span></code>
  1237. to upgrade it manually.</p>
  1238. <p>To allow the usage of this functionality:</p>
  1239. <ul>
  1240. <li><p>set up <span class="target" id="index-90"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1241. <li><p>put the table name in <span class="target" id="index-91"></span><a class="reference internal" href="#cfg_Servers_column_info"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['column_info']</span></code></a> (e.g.
  1242. <code class="docutils literal notranslate"><span class="pre">pma__column_info</span></code>)</p></li>
  1243. <li><p>to update your PRE-2.5.0 Column_comments table use this: and
  1244. remember that the Variable in <code class="file docutils literal notranslate"><span class="pre">config.inc.php</span></code> has been renamed from
  1245. <code class="samp docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['column_comments']</span></code> to
  1246. <span class="target" id="index-92"></span><a class="reference internal" href="#cfg_Servers_column_info"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['column_info']</span></code></a></p>
  1247. <div class="highlight-mysql notranslate"><div class="highlight"><pre><span></span><span class="k">ALTER</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="n n-Quoted">`pma__column_comments`</span>
  1248. <span class="k">ADD</span><span class="w"> </span><span class="n n-Quoted">`mimetype`</span><span class="w"> </span><span class="kt">VARCHAR</span><span class="p">(</span><span class="w"> </span><span class="mi">255</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="no">NULL</span><span class="p">,</span>
  1249. <span class="k">ADD</span><span class="w"> </span><span class="n n-Quoted">`transformation`</span><span class="w"> </span><span class="kt">VARCHAR</span><span class="p">(</span><span class="w"> </span><span class="mi">255</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="no">NULL</span><span class="p">,</span>
  1250. <span class="k">ADD</span><span class="w"> </span><span class="n n-Quoted">`transformation_options`</span><span class="w"> </span><span class="kt">VARCHAR</span><span class="p">(</span><span class="w"> </span><span class="mi">255</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="no">NULL</span><span class="p">;</span>
  1251. </pre></div>
  1252. </div>
  1253. </li>
  1254. <li><p>to update your PRE-4.3.0 Column_info table manually use this
  1255. <code class="docutils literal notranslate"><span class="pre">./sql/upgrade_column_info_4_3_0+.sql</span></code> SQL script.</p></li>
  1256. </ul>
  1257. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1258. <div class="admonition note">
  1259. <p class="admonition-title">Note</p>
  1260. <p>For auto-upgrade functionality to work, your
  1261. <span class="target" id="index-93"></span><a class="reference internal" href="#cfg_Servers_controluser"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['controluser']</span></code></a> must have ALTER privilege on
  1262. <code class="docutils literal notranslate"><span class="pre">phpmyadmin</span></code> database. See the <a class="reference external" href="https://dev.mysql.com/doc/refman/8.0/en/grant.html">MySQL documentation for GRANT</a> on how to
  1263. <code class="docutils literal notranslate"><span class="pre">GRANT</span></code> privileges to a user.</p>
  1264. </div>
  1265. </dd></dl>
  1266. <span class="target" id="history"></span><dl class="config option">
  1267. <dt class="sig sig-object config" id="cfg_Servers_history">
  1268. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['history']</span></span><a class="headerlink" href="#cfg_Servers_history" title="Permalink to this definition">¶</a></dt>
  1269. <dd><dl class="field-list simple">
  1270. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1271. <dd class="field-odd"><p>string or false</p>
  1272. </dd>
  1273. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1274. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1275. </dd>
  1276. </dl>
  1277. <div class="versionadded">
  1278. <p><span class="versionmodified added">New in version 2.5.0.</span></p>
  1279. </div>
  1280. <p>Since release 2.5.0 you can store your <a class="reference internal" href="glossary.html#term-SQL"><span class="xref std std-term">SQL</span></a> history, which means all
  1281. queries you entered manually into the phpMyAdmin interface. If you don’t
  1282. want to use a table-based history, you can use the JavaScript-based
  1283. history.</p>
  1284. <p>Using that, all your history items are deleted when closing the window.
  1285. Using <span class="target" id="index-94"></span><a class="reference internal" href="#cfg_QueryHistoryMax"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['QueryHistoryMax']</span></code></a> you can specify an amount of
  1286. history items you want to have on hold. On every login, this list gets cut
  1287. to the maximum amount.</p>
  1288. <p>The query history is only available if JavaScript is enabled in
  1289. your browser.</p>
  1290. <p>To allow the usage of this functionality:</p>
  1291. <ul class="simple">
  1292. <li><p>set up <span class="target" id="index-95"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1293. <li><p>put the table name in <span class="target" id="index-96"></span><a class="reference internal" href="#cfg_Servers_history"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['history']</span></code></a> (e.g.
  1294. <code class="docutils literal notranslate"><span class="pre">pma__history</span></code>)</p></li>
  1295. </ul>
  1296. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1297. </dd></dl>
  1298. <span class="target" id="recent"></span><dl class="config option">
  1299. <dt class="sig sig-object config" id="cfg_Servers_recent">
  1300. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['recent']</span></span><a class="headerlink" href="#cfg_Servers_recent" title="Permalink to this definition">¶</a></dt>
  1301. <dd><dl class="field-list simple">
  1302. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1303. <dd class="field-odd"><p>string or false</p>
  1304. </dd>
  1305. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1306. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1307. </dd>
  1308. </dl>
  1309. <div class="versionadded">
  1310. <p><span class="versionmodified added">New in version 3.5.0.</span></p>
  1311. </div>
  1312. <p>Since release 3.5.0 you can show recently used tables in the
  1313. navigation panel. It helps you to jump across table directly, without
  1314. the need to select the database, and then select the table. Using
  1315. <span class="target" id="index-97"></span><a class="reference internal" href="#cfg_NumRecentTables"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['NumRecentTables']</span></code></a> you can configure the maximum number
  1316. of recent tables shown. When you select a table from the list, it will jump to
  1317. the page specified in <span class="target" id="index-98"></span><a class="reference internal" href="#cfg_NavigationTreeDefaultTabTable"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['NavigationTreeDefaultTabTable']</span></code></a>.</p>
  1318. <p>Without configuring the storage, you can still access the recently used tables,
  1319. but it will disappear after you logout.</p>
  1320. <p>To allow the usage of this functionality persistently:</p>
  1321. <ul class="simple">
  1322. <li><p>set up <span class="target" id="index-99"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1323. <li><p>put the table name in <span class="target" id="index-100"></span><a class="reference internal" href="#cfg_Servers_recent"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['recent']</span></code></a> (e.g.
  1324. <code class="docutils literal notranslate"><span class="pre">pma__recent</span></code>)</p></li>
  1325. </ul>
  1326. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1327. </dd></dl>
  1328. <span class="target" id="favorite"></span><dl class="config option">
  1329. <dt class="sig sig-object config" id="cfg_Servers_favorite">
  1330. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['favorite']</span></span><a class="headerlink" href="#cfg_Servers_favorite" title="Permalink to this definition">¶</a></dt>
  1331. <dd><dl class="field-list simple">
  1332. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1333. <dd class="field-odd"><p>string or false</p>
  1334. </dd>
  1335. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1336. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1337. </dd>
  1338. </dl>
  1339. <div class="versionadded">
  1340. <p><span class="versionmodified added">New in version 4.2.0.</span></p>
  1341. </div>
  1342. <p>Since release 4.2.0 you can show a list of selected tables in the
  1343. navigation panel. It helps you to jump to the table directly, without
  1344. the need to select the database, and then select the table. When you
  1345. select a table from the list, it will jump to the page specified in
  1346. <span class="target" id="index-101"></span><a class="reference internal" href="#cfg_NavigationTreeDefaultTabTable"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['NavigationTreeDefaultTabTable']</span></code></a>.</p>
  1347. <p>You can add tables to this list or remove tables from it in database
  1348. structure page by clicking on the star icons next to table names. Using
  1349. <span class="target" id="index-102"></span><a class="reference internal" href="#cfg_NumFavoriteTables"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['NumFavoriteTables']</span></code></a> you can configure the maximum
  1350. number of favorite tables shown.</p>
  1351. <p>Without configuring the storage, you can still access the favorite tables,
  1352. but it will disappear after you logout.</p>
  1353. <p>To allow the usage of this functionality persistently:</p>
  1354. <ul class="simple">
  1355. <li><p>set up <span class="target" id="index-103"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1356. <li><p>put the table name in <span class="target" id="index-104"></span><a class="reference internal" href="#cfg_Servers_favorite"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['favorite']</span></code></a> (e.g.
  1357. <code class="docutils literal notranslate"><span class="pre">pma__favorite</span></code>)</p></li>
  1358. </ul>
  1359. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1360. </dd></dl>
  1361. <span class="target" id="table-uiprefs"></span><dl class="config option">
  1362. <dt class="sig sig-object config" id="cfg_Servers_table_uiprefs">
  1363. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['table_uiprefs']</span></span><a class="headerlink" href="#cfg_Servers_table_uiprefs" title="Permalink to this definition">¶</a></dt>
  1364. <dd><dl class="field-list simple">
  1365. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1366. <dd class="field-odd"><p>string or false</p>
  1367. </dd>
  1368. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1369. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1370. </dd>
  1371. </dl>
  1372. <div class="versionadded">
  1373. <p><span class="versionmodified added">New in version 3.5.0.</span></p>
  1374. </div>
  1375. <p>Since release 3.5.0 phpMyAdmin can be configured to remember several
  1376. things (sorted column <span class="target" id="index-105"></span><a class="reference internal" href="#cfg_RememberSorting"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['RememberSorting']</span></code></a>, column order,
  1377. and column visibility from a database table) for browsing tables. Without
  1378. configuring the storage, these features still can be used, but the values will
  1379. disappear after you logout.</p>
  1380. <p>To allow the usage of these functionality persistently:</p>
  1381. <ul class="simple">
  1382. <li><p>set up <span class="target" id="index-106"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1383. <li><p>put the table name in <span class="target" id="index-107"></span><a class="reference internal" href="#cfg_Servers_table_uiprefs"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['table_uiprefs']</span></code></a> (e.g.
  1384. <code class="docutils literal notranslate"><span class="pre">pma__table_uiprefs</span></code>)</p></li>
  1385. </ul>
  1386. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1387. </dd></dl>
  1388. <dl class="config option">
  1389. <dt class="sig sig-object config" id="cfg_Servers_users">
  1390. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['users']</span></span><a class="headerlink" href="#cfg_Servers_users" title="Permalink to this definition">¶</a></dt>
  1391. <dd><dl class="field-list simple">
  1392. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1393. <dd class="field-odd"><p>string or false</p>
  1394. </dd>
  1395. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1396. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1397. </dd>
  1398. </dl>
  1399. <p>The table used by phpMyAdmin to store user name information for associating with user groups.
  1400. See the next entry on <span class="target" id="index-108"></span><a class="reference internal" href="#cfg_Servers_usergroups"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['usergroups']</span></code></a> for more details
  1401. and the suggested settings.</p>
  1402. </dd></dl>
  1403. <dl class="config option">
  1404. <dt class="sig sig-object config" id="cfg_Servers_usergroups">
  1405. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['usergroups']</span></span><a class="headerlink" href="#cfg_Servers_usergroups" title="Permalink to this definition">¶</a></dt>
  1406. <dd><dl class="field-list simple">
  1407. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1408. <dd class="field-odd"><p>string or false</p>
  1409. </dd>
  1410. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1411. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1412. </dd>
  1413. </dl>
  1414. <div class="versionadded">
  1415. <p><span class="versionmodified added">New in version 4.1.0.</span></p>
  1416. </div>
  1417. <p>Since release 4.1.0 you can create different user groups with menu items
  1418. attached to them. Users can be assigned to these groups and the logged in
  1419. user would only see menu items configured to the usergroup they are assigned to.
  1420. To do this it needs two tables “usergroups” (storing allowed menu items for each
  1421. user group) and “users” (storing users and their assignments to user groups).</p>
  1422. <p>To allow the usage of this functionality:</p>
  1423. <ul class="simple">
  1424. <li><p>set up <span class="target" id="index-109"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1425. <li><p>put the correct table names in
  1426. <span class="target" id="index-110"></span><a class="reference internal" href="#cfg_Servers_users"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['users']</span></code></a> (e.g. <code class="docutils literal notranslate"><span class="pre">pma__users</span></code>) and
  1427. <span class="target" id="index-111"></span><a class="reference internal" href="#cfg_Servers_usergroups"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['usergroups']</span></code></a> (e.g. <code class="docutils literal notranslate"><span class="pre">pma__usergroups</span></code>)</p></li>
  1428. </ul>
  1429. <p>This feature can be disabled by setting either of the configurations to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1430. <div class="admonition seealso">
  1431. <p class="admonition-title">See also</p>
  1432. <p><a class="reference internal" href="privileges.html#configurablemenus"><span class="std std-ref">Configurable menus and user groups</span></a></p>
  1433. </div>
  1434. </dd></dl>
  1435. <span class="target" id="navigationhiding"></span><dl class="config option">
  1436. <dt class="sig sig-object config" id="cfg_Servers_navigationhiding">
  1437. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['navigationhiding']</span></span><a class="headerlink" href="#cfg_Servers_navigationhiding" title="Permalink to this definition">¶</a></dt>
  1438. <dd><dl class="field-list simple">
  1439. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1440. <dd class="field-odd"><p>string or false</p>
  1441. </dd>
  1442. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1443. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1444. </dd>
  1445. </dl>
  1446. <div class="versionadded">
  1447. <p><span class="versionmodified added">New in version 4.1.0.</span></p>
  1448. </div>
  1449. <p>Since release 4.1.0 you can hide/show items in the navigation tree.</p>
  1450. <p>To allow the usage of this functionality:</p>
  1451. <ul class="simple">
  1452. <li><p>set up <span class="target" id="index-112"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1453. <li><p>put the table name in <span class="target" id="index-113"></span><a class="reference internal" href="#cfg_Servers_navigationhiding"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['navigationhiding']</span></code></a> (e.g.
  1454. <code class="docutils literal notranslate"><span class="pre">pma__navigationhiding</span></code>)</p></li>
  1455. </ul>
  1456. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1457. </dd></dl>
  1458. <span class="target" id="central-columns"></span><dl class="config option">
  1459. <dt class="sig sig-object config" id="cfg_Servers_central_columns">
  1460. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['central_columns']</span></span><a class="headerlink" href="#cfg_Servers_central_columns" title="Permalink to this definition">¶</a></dt>
  1461. <dd><dl class="field-list simple">
  1462. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1463. <dd class="field-odd"><p>string or false</p>
  1464. </dd>
  1465. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1466. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1467. </dd>
  1468. </dl>
  1469. <div class="versionadded">
  1470. <p><span class="versionmodified added">New in version 4.3.0.</span></p>
  1471. </div>
  1472. <p>Since release 4.3.0 you can have a central list of columns per database.
  1473. You can add/remove columns to the list as per your requirement. These columns
  1474. in the central list will be available to use while you create a new column for
  1475. a table or create a table itself. You can select a column from central list
  1476. while creating a new column, it will save you from writing the same column definition
  1477. over again or from writing different names for similar column.</p>
  1478. <p>To allow the usage of this functionality:</p>
  1479. <ul class="simple">
  1480. <li><p>set up <span class="target" id="index-114"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1481. <li><p>put the table name in <span class="target" id="index-115"></span><a class="reference internal" href="#cfg_Servers_central_columns"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['central_columns']</span></code></a> (e.g.
  1482. <code class="docutils literal notranslate"><span class="pre">pma__central_columns</span></code>)</p></li>
  1483. </ul>
  1484. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1485. </dd></dl>
  1486. <span class="target" id="designer-settings"></span><dl class="config option">
  1487. <dt class="sig sig-object config" id="cfg_Servers_designer_settings">
  1488. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['designer_settings']</span></span><a class="headerlink" href="#cfg_Servers_designer_settings" title="Permalink to this definition">¶</a></dt>
  1489. <dd><dl class="field-list simple">
  1490. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1491. <dd class="field-odd"><p>string or false</p>
  1492. </dd>
  1493. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1494. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1495. </dd>
  1496. </dl>
  1497. <div class="versionadded">
  1498. <p><span class="versionmodified added">New in version 4.5.0.</span></p>
  1499. </div>
  1500. <p>Since release 4.5.0 your designer settings can be remembered.
  1501. Your choice regarding ‘Angular/Direct Links’, ‘Snap to Grid’, ‘Toggle Relation Lines’,
  1502. ‘Small/Big All’, ‘Move Menu’ and ‘Pin Text’ can be remembered persistently.</p>
  1503. <p>To allow the usage of this functionality:</p>
  1504. <ul class="simple">
  1505. <li><p>set up <span class="target" id="index-116"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1506. <li><p>put the table name in <span class="target" id="index-117"></span><a class="reference internal" href="#cfg_Servers_designer_settings"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['designer_settings']</span></code></a> (e.g.
  1507. <code class="docutils literal notranslate"><span class="pre">pma__designer_settings</span></code>)</p></li>
  1508. </ul>
  1509. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1510. </dd></dl>
  1511. <span class="target" id="savedsearches"></span><dl class="config option">
  1512. <dt class="sig sig-object config" id="cfg_Servers_savedsearches">
  1513. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['savedsearches']</span></span><a class="headerlink" href="#cfg_Servers_savedsearches" title="Permalink to this definition">¶</a></dt>
  1514. <dd><dl class="field-list simple">
  1515. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1516. <dd class="field-odd"><p>string or false</p>
  1517. </dd>
  1518. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1519. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1520. </dd>
  1521. </dl>
  1522. <div class="versionadded">
  1523. <p><span class="versionmodified added">New in version 4.2.0.</span></p>
  1524. </div>
  1525. <p>Since release 4.2.0 you can save and load query-by-example searches from the Database &gt; Query panel.</p>
  1526. <p>To allow the usage of this functionality:</p>
  1527. <ul class="simple">
  1528. <li><p>set up <span class="target" id="index-118"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1529. <li><p>put the table name in <span class="target" id="index-119"></span><a class="reference internal" href="#cfg_Servers_savedsearches"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['savedsearches']</span></code></a> (e.g.
  1530. <code class="docutils literal notranslate"><span class="pre">pma__savedsearches</span></code>)</p></li>
  1531. </ul>
  1532. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1533. </dd></dl>
  1534. <span class="target" id="export-templates"></span><dl class="config option">
  1535. <dt class="sig sig-object config" id="cfg_Servers_export_templates">
  1536. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['export_templates']</span></span><a class="headerlink" href="#cfg_Servers_export_templates" title="Permalink to this definition">¶</a></dt>
  1537. <dd><dl class="field-list simple">
  1538. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1539. <dd class="field-odd"><p>string or false</p>
  1540. </dd>
  1541. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1542. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1543. </dd>
  1544. </dl>
  1545. <div class="versionadded">
  1546. <p><span class="versionmodified added">New in version 4.5.0.</span></p>
  1547. </div>
  1548. <p>Since release 4.5.0 you can save and load export templates.</p>
  1549. <p>To allow the usage of this functionality:</p>
  1550. <ul class="simple">
  1551. <li><p>set up <span class="target" id="index-120"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1552. <li><p>put the table name in <span class="target" id="index-121"></span><a class="reference internal" href="#cfg_Servers_export_templates"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['export_templates']</span></code></a> (e.g.
  1553. <code class="docutils literal notranslate"><span class="pre">pma__export_templates</span></code>)</p></li>
  1554. </ul>
  1555. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1556. </dd></dl>
  1557. <span class="target" id="tracking"></span><dl class="config option">
  1558. <dt class="sig sig-object config" id="cfg_Servers_tracking">
  1559. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['tracking']</span></span><a class="headerlink" href="#cfg_Servers_tracking" title="Permalink to this definition">¶</a></dt>
  1560. <dd><dl class="field-list simple">
  1561. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1562. <dd class="field-odd"><p>string or false</p>
  1563. </dd>
  1564. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1565. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1566. </dd>
  1567. </dl>
  1568. <div class="versionadded">
  1569. <p><span class="versionmodified added">New in version 3.3.x.</span></p>
  1570. </div>
  1571. <p>Since release 3.3.x a tracking mechanism is available. It helps you to
  1572. track every <a class="reference internal" href="glossary.html#term-SQL"><span class="xref std std-term">SQL</span></a> command which is
  1573. executed by phpMyAdmin. The mechanism supports logging of data
  1574. manipulation and data definition statements. After enabling it you can
  1575. create versions of tables.</p>
  1576. <p>The creation of a version has two effects:</p>
  1577. <ul class="simple">
  1578. <li><p>phpMyAdmin saves a snapshot of the table, including structure and
  1579. indexes.</p></li>
  1580. <li><p>phpMyAdmin logs all commands which change the structure and/or data of
  1581. the table and links these commands with the version number.</p></li>
  1582. </ul>
  1583. <p>Of course you can view the tracked changes. On the <span class="guilabel">Tracking</span>
  1584. page a complete report is available for every version. For the report you
  1585. can use filters, for example you can get a list of statements within a date
  1586. range. When you want to filter usernames you can enter * for all names or
  1587. you enter a list of names separated by ‘,’. In addition you can export the
  1588. (filtered) report to a file or to a temporary database.</p>
  1589. <p>To allow the usage of this functionality:</p>
  1590. <ul class="simple">
  1591. <li><p>set up <span class="target" id="index-122"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1592. <li><p>put the table name in <span class="target" id="index-123"></span><a class="reference internal" href="#cfg_Servers_tracking"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['tracking']</span></code></a> (e.g.
  1593. <code class="docutils literal notranslate"><span class="pre">pma__tracking</span></code>)</p></li>
  1594. </ul>
  1595. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1596. </dd></dl>
  1597. <span class="target" id="tracking2"></span><dl class="config option">
  1598. <dt class="sig sig-object config" id="cfg_Servers_tracking_version_auto_create">
  1599. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['tracking_version_auto_create']</span></span><a class="headerlink" href="#cfg_Servers_tracking_version_auto_create" title="Permalink to this definition">¶</a></dt>
  1600. <dd><dl class="field-list simple">
  1601. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1602. <dd class="field-odd"><p>boolean</p>
  1603. </dd>
  1604. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1605. <dd class="field-even"><p>false</p>
  1606. </dd>
  1607. </dl>
  1608. <p>Whether the tracking mechanism creates versions for tables and views
  1609. automatically.</p>
  1610. <p>If this is set to true and you create a table or view with</p>
  1611. <ul class="simple">
  1612. <li><p>CREATE TABLE …</p></li>
  1613. <li><p>CREATE VIEW …</p></li>
  1614. </ul>
  1615. <p>and no version exists for it, the mechanism will create a version for
  1616. you automatically.</p>
  1617. </dd></dl>
  1618. <span class="target" id="tracking3"></span><dl class="config option">
  1619. <dt class="sig sig-object config" id="cfg_Servers_tracking_default_statements">
  1620. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['tracking_default_statements']</span></span><a class="headerlink" href="#cfg_Servers_tracking_default_statements" title="Permalink to this definition">¶</a></dt>
  1621. <dd><dl class="field-list simple">
  1622. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1623. <dd class="field-odd"><p>string</p>
  1624. </dd>
  1625. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1626. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'CREATE</span> <span class="pre">TABLE,ALTER</span> <span class="pre">TABLE,DROP</span> <span class="pre">TABLE,RENAME</span> <span class="pre">TABLE,CREATE</span> <span class="pre">INDEX,DROP</span> <span class="pre">INDEX,INSERT,UPDATE,DELETE,TRUNCATE,REPLACE,CREATE</span> <span class="pre">VIEW,ALTER</span> <span class="pre">VIEW,DROP</span> <span class="pre">VIEW,CREATE</span> <span class="pre">DATABASE,ALTER</span> <span class="pre">DATABASE,DROP</span> <span class="pre">DATABASE'</span></code></p>
  1627. </dd>
  1628. </dl>
  1629. <p>Defines the list of statements the auto-creation uses for new
  1630. versions.</p>
  1631. </dd></dl>
  1632. <span class="target" id="tracking4"></span><dl class="config option">
  1633. <dt class="sig sig-object config" id="cfg_Servers_tracking_add_drop_view">
  1634. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['tracking_add_drop_view']</span></span><a class="headerlink" href="#cfg_Servers_tracking_add_drop_view" title="Permalink to this definition">¶</a></dt>
  1635. <dd><dl class="field-list simple">
  1636. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1637. <dd class="field-odd"><p>boolean</p>
  1638. </dd>
  1639. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1640. <dd class="field-even"><p>true</p>
  1641. </dd>
  1642. </dl>
  1643. <p>Whether a <cite>DROP VIEW IF EXISTS</cite> statement will be added as first line to
  1644. the log when creating a view.</p>
  1645. </dd></dl>
  1646. <span class="target" id="tracking5"></span><dl class="config option">
  1647. <dt class="sig sig-object config" id="cfg_Servers_tracking_add_drop_table">
  1648. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['tracking_add_drop_table']</span></span><a class="headerlink" href="#cfg_Servers_tracking_add_drop_table" title="Permalink to this definition">¶</a></dt>
  1649. <dd><dl class="field-list simple">
  1650. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1651. <dd class="field-odd"><p>boolean</p>
  1652. </dd>
  1653. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1654. <dd class="field-even"><p>true</p>
  1655. </dd>
  1656. </dl>
  1657. <p>Whether a <cite>DROP TABLE IF EXISTS</cite> statement will be added as first line
  1658. to the log when creating a table.</p>
  1659. </dd></dl>
  1660. <span class="target" id="tracking6"></span><dl class="config option">
  1661. <dt class="sig sig-object config" id="cfg_Servers_tracking_add_drop_database">
  1662. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['tracking_add_drop_database']</span></span><a class="headerlink" href="#cfg_Servers_tracking_add_drop_database" title="Permalink to this definition">¶</a></dt>
  1663. <dd><dl class="field-list simple">
  1664. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1665. <dd class="field-odd"><p>boolean</p>
  1666. </dd>
  1667. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1668. <dd class="field-even"><p>true</p>
  1669. </dd>
  1670. </dl>
  1671. <p>Whether a <cite>DROP DATABASE IF EXISTS</cite> statement will be added as first
  1672. line to the log when creating a database.</p>
  1673. </dd></dl>
  1674. <span class="target" id="userconfig"></span><dl class="config option">
  1675. <dt class="sig sig-object config" id="cfg_Servers_userconfig">
  1676. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['userconfig']</span></span><a class="headerlink" href="#cfg_Servers_userconfig" title="Permalink to this definition">¶</a></dt>
  1677. <dd><dl class="field-list simple">
  1678. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1679. <dd class="field-odd"><p>string or false</p>
  1680. </dd>
  1681. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1682. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1683. </dd>
  1684. </dl>
  1685. <div class="versionadded">
  1686. <p><span class="versionmodified added">New in version 3.4.x.</span></p>
  1687. </div>
  1688. <p>Since release 3.4.x phpMyAdmin allows users to set most preferences by
  1689. themselves and store them in the database.</p>
  1690. <p>If you don’t allow for storing preferences in
  1691. <span class="target" id="index-124"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a>, users can still personalize
  1692. phpMyAdmin, but settings will be saved in browser’s local storage, or, it
  1693. is is unavailable, until the end of session.</p>
  1694. <p>To allow the usage of this functionality:</p>
  1695. <ul class="simple">
  1696. <li><p>set up <span class="target" id="index-125"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and the phpMyAdmin configuration storage</p></li>
  1697. <li><p>put the table name in <span class="target" id="index-126"></span><a class="reference internal" href="#cfg_Servers_userconfig"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['userconfig']</span></code></a></p></li>
  1698. </ul>
  1699. <p>This feature can be disabled by setting the configuration to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  1700. </dd></dl>
  1701. <dl class="config option">
  1702. <dt class="sig sig-object config" id="cfg_Servers_MaxTableUiprefs">
  1703. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['MaxTableUiprefs']</span></span><a class="headerlink" href="#cfg_Servers_MaxTableUiprefs" title="Permalink to this definition">¶</a></dt>
  1704. <dd><dl class="field-list simple">
  1705. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1706. <dd class="field-odd"><p>integer</p>
  1707. </dd>
  1708. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1709. <dd class="field-even"><p>100</p>
  1710. </dd>
  1711. </dl>
  1712. <p>Maximum number of rows saved in
  1713. <span class="target" id="index-127"></span><a class="reference internal" href="#cfg_Servers_table_uiprefs"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['table_uiprefs']</span></code></a> table.</p>
  1714. <p>When tables are dropped or renamed,
  1715. <span class="target" id="index-128"></span><a class="reference internal" href="#cfg_Servers_table_uiprefs"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['table_uiprefs']</span></code></a> may contain invalid data
  1716. (referring to tables which no longer exist). We only keep this number of newest
  1717. rows in <span class="target" id="index-129"></span><a class="reference internal" href="#cfg_Servers_table_uiprefs"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['table_uiprefs']</span></code></a> and automatically
  1718. delete older rows.</p>
  1719. </dd></dl>
  1720. <dl class="config option">
  1721. <dt class="sig sig-object config" id="cfg_Servers_SessionTimeZone">
  1722. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['SessionTimeZone']</span></span><a class="headerlink" href="#cfg_Servers_SessionTimeZone" title="Permalink to this definition">¶</a></dt>
  1723. <dd><dl class="field-list simple">
  1724. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1725. <dd class="field-odd"><p>string</p>
  1726. </dd>
  1727. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1728. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1729. </dd>
  1730. </dl>
  1731. <p>Sets the time zone used by phpMyAdmin. Leave blank to use the time zone of your
  1732. database server. Possible values are explained at
  1733. <a class="reference external" href="https://dev.mysql.com/doc/refman/8.0/en/time-zone-support.html">https://dev.mysql.com/doc/refman/8.0/en/time-zone-support.html</a></p>
  1734. <p>This is useful when your database server uses a time zone which is different from the
  1735. time zone you want to use in phpMyAdmin.</p>
  1736. </dd></dl>
  1737. <dl class="config option">
  1738. <dt class="sig sig-object config" id="cfg_Servers_AllowRoot">
  1739. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['AllowRoot']</span></span><a class="headerlink" href="#cfg_Servers_AllowRoot" title="Permalink to this definition">¶</a></dt>
  1740. <dd><dl class="field-list simple">
  1741. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1742. <dd class="field-odd"><p>boolean</p>
  1743. </dd>
  1744. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1745. <dd class="field-even"><p>true</p>
  1746. </dd>
  1747. </dl>
  1748. <p>Whether to allow root access. This is just a shortcut for the
  1749. <span class="target" id="index-130"></span><a class="reference internal" href="#cfg_Servers_AllowDeny_rules"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['AllowDeny']['rules']</span></code></a> below.</p>
  1750. </dd></dl>
  1751. <dl class="config option">
  1752. <dt class="sig sig-object config" id="cfg_Servers_AllowNoPassword">
  1753. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['AllowNoPassword']</span></span><a class="headerlink" href="#cfg_Servers_AllowNoPassword" title="Permalink to this definition">¶</a></dt>
  1754. <dd><dl class="field-list simple">
  1755. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1756. <dd class="field-odd"><p>boolean</p>
  1757. </dd>
  1758. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1759. <dd class="field-even"><p>false</p>
  1760. </dd>
  1761. </dl>
  1762. <p>Whether to allow logins without a password. The default value of
  1763. <code class="docutils literal notranslate"><span class="pre">false</span></code> for this parameter prevents unintended access to a MySQL
  1764. server with was left with an empty password for root or on which an
  1765. anonymous (blank) user is defined.</p>
  1766. </dd></dl>
  1767. <span class="target" id="servers-allowdeny-order"></span><dl class="config option">
  1768. <dt class="sig sig-object config" id="cfg_Servers_AllowDeny_order">
  1769. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['AllowDeny']['order']</span></span><a class="headerlink" href="#cfg_Servers_AllowDeny_order" title="Permalink to this definition">¶</a></dt>
  1770. <dd><dl class="field-list simple">
  1771. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1772. <dd class="field-odd"><p>string</p>
  1773. </dd>
  1774. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1775. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1776. </dd>
  1777. </dl>
  1778. <p>If your rule order is empty, then <a class="reference internal" href="glossary.html#term-IP"><span class="xref std std-term">IP</span></a>
  1779. authorization is disabled.</p>
  1780. <p>If your rule order is set to
  1781. <code class="docutils literal notranslate"><span class="pre">'deny,allow'</span></code> then the system applies all deny rules followed by
  1782. allow rules. Access is allowed by default. Any client which does not
  1783. match a Deny command or does match an Allow command will be allowed
  1784. access to the server.</p>
  1785. <p>If your rule order is set to <code class="docutils literal notranslate"><span class="pre">'allow,deny'</span></code>
  1786. then the system applies all allow rules followed by deny rules. Access
  1787. is denied by default. Any client which does not match an Allow
  1788. directive or does match a Deny directive will be denied access to the
  1789. server.</p>
  1790. <p>If your rule order is set to <code class="docutils literal notranslate"><span class="pre">'explicit'</span></code>, authorization is
  1791. performed in a similar fashion to rule order ‘deny,allow’, with the
  1792. added restriction that your host/username combination <strong>must</strong> be
  1793. listed in the <em>allow</em> rules, and not listed in the <em>deny</em> rules. This
  1794. is the <strong>most</strong> secure means of using Allow/Deny rules, and was
  1795. available in Apache by specifying allow and deny rules without setting
  1796. any order.</p>
  1797. <p>Please also see <span class="target" id="index-131"></span><a class="reference internal" href="#cfg_TrustedProxies"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['TrustedProxies']</span></code></a> for
  1798. detecting IP address behind proxies.</p>
  1799. </dd></dl>
  1800. <span class="target" id="servers-allowdeny-rules"></span><dl class="config option">
  1801. <dt class="sig sig-object config" id="cfg_Servers_AllowDeny_rules">
  1802. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['AllowDeny']['rules']</span></span><a class="headerlink" href="#cfg_Servers_AllowDeny_rules" title="Permalink to this definition">¶</a></dt>
  1803. <dd><dl class="field-list simple">
  1804. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1805. <dd class="field-odd"><p>array of strings</p>
  1806. </dd>
  1807. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1808. <dd class="field-even"><p>array()</p>
  1809. </dd>
  1810. </dl>
  1811. <p>The general format for the rules is as such:</p>
  1812. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>&lt;&#39;allow&#39; | &#39;deny&#39;&gt; &lt;username&gt; [from] &lt;ipmask&gt;
  1813. </pre></div>
  1814. </div>
  1815. <p>If you wish to match all users, it is possible to use a <code class="docutils literal notranslate"><span class="pre">'%'</span></code> as a
  1816. wildcard in the <em>username</em> field.</p>
  1817. <p>There are a few shortcuts you can
  1818. use in the <em>ipmask</em> field as well (please note that those containing
  1819. SERVER_ADDRESS might not be available on all webservers):</p>
  1820. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>&#39;all&#39; -&gt; 0.0.0.0/0
  1821. &#39;localhost&#39; -&gt; 127.0.0.1/8
  1822. &#39;localnetA&#39; -&gt; SERVER_ADDRESS/8
  1823. &#39;localnetB&#39; -&gt; SERVER_ADDRESS/16
  1824. &#39;localnetC&#39; -&gt; SERVER_ADDRESS/24
  1825. </pre></div>
  1826. </div>
  1827. <p>Having an empty rule list is equivalent to either using <code class="docutils literal notranslate"><span class="pre">'allow</span> <span class="pre">%</span>
  1828. <span class="pre">from</span> <span class="pre">all'</span></code> if your rule order is set to <code class="docutils literal notranslate"><span class="pre">'deny,allow'</span></code> or <code class="docutils literal notranslate"><span class="pre">'deny</span> <span class="pre">%</span>
  1829. <span class="pre">from</span> <span class="pre">all'</span></code> if your rule order is set to <code class="docutils literal notranslate"><span class="pre">'allow,deny'</span></code> or
  1830. <code class="docutils literal notranslate"><span class="pre">'explicit'</span></code>.</p>
  1831. <p>For the <a class="reference internal" href="glossary.html#term-IP-Address"><span class="xref std std-term">IP Address</span></a> matching
  1832. system, the following work:</p>
  1833. <ul class="simple">
  1834. <li><p><code class="docutils literal notranslate"><span class="pre">xxx.xxx.xxx.xxx</span></code> (an exact <a class="reference internal" href="glossary.html#term-IP-Address"><span class="xref std std-term">IP Address</span></a>)</p></li>
  1835. <li><p><code class="docutils literal notranslate"><span class="pre">xxx.xxx.xxx.[yyy-zzz]</span></code> (an <a class="reference internal" href="glossary.html#term-IP-Address"><span class="xref std std-term">IP Address</span></a> range)</p></li>
  1836. <li><p><code class="docutils literal notranslate"><span class="pre">xxx.xxx.xxx.xxx/nn</span></code> (CIDR, Classless Inter-Domain Routing type <a class="reference internal" href="glossary.html#term-IP"><span class="xref std std-term">IP</span></a> addresses)</p></li>
  1837. </ul>
  1838. <p>But the following does not work:</p>
  1839. <ul class="simple">
  1840. <li><p><code class="docutils literal notranslate"><span class="pre">xxx.xxx.xxx.xx[yyy-zzz]</span></code> (partial <a class="reference internal" href="glossary.html#term-IP"><span class="xref std std-term">IP</span></a> address range)</p></li>
  1841. </ul>
  1842. <p>For <a class="reference internal" href="glossary.html#term-IPv6"><span class="xref std std-term">IPv6</span></a> addresses, the following work:</p>
  1843. <ul class="simple">
  1844. <li><p><code class="docutils literal notranslate"><span class="pre">xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx</span></code> (an exact <a class="reference internal" href="glossary.html#term-IPv6"><span class="xref std std-term">IPv6</span></a> address)</p></li>
  1845. <li><p><code class="docutils literal notranslate"><span class="pre">xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:[yyyy-zzzz]</span></code> (an <a class="reference internal" href="glossary.html#term-IPv6"><span class="xref std std-term">IPv6</span></a> address range)</p></li>
  1846. <li><p><code class="docutils literal notranslate"><span class="pre">xxxx:xxxx:xxxx:xxxx/nn</span></code> (CIDR, Classless Inter-Domain Routing type <a class="reference internal" href="glossary.html#term-IPv6"><span class="xref std std-term">IPv6</span></a> addresses)</p></li>
  1847. </ul>
  1848. <p>But the following does not work:</p>
  1849. <ul class="simple">
  1850. <li><p><code class="docutils literal notranslate"><span class="pre">xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xx[yyy-zzz]</span></code> (partial <a class="reference internal" href="glossary.html#term-IPv6"><span class="xref std std-term">IPv6</span></a> address range)</p></li>
  1851. </ul>
  1852. <p>Examples:</p>
  1853. <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>$cfg[&#39;Servers&#39;][$i][&#39;AllowDeny&#39;][&#39;order&#39;] = &#39;allow,deny&#39;;
  1854. $cfg[&#39;Servers&#39;][$i][&#39;AllowDeny&#39;][&#39;rules&#39;] = [&#39;allow bob from all&#39;];
  1855. // Allow only &#39;bob&#39; to connect from any host
  1856. $cfg[&#39;Servers&#39;][$i][&#39;AllowDeny&#39;][&#39;order&#39;] = &#39;allow,deny&#39;;
  1857. $cfg[&#39;Servers&#39;][$i][&#39;AllowDeny&#39;][&#39;rules&#39;] = [&#39;allow mary from 192.168.100.[50-100]&#39;];
  1858. // Allow only &#39;mary&#39; to connect from host 192.168.100.50 through 192.168.100.100
  1859. $cfg[&#39;Servers&#39;][$i][&#39;AllowDeny&#39;][&#39;order&#39;] = &#39;allow,deny&#39;;
  1860. $cfg[&#39;Servers&#39;][$i][&#39;AllowDeny&#39;][&#39;rules&#39;] = [&#39;allow % from 192.168.[5-6].10&#39;];
  1861. // Allow any user to connect from host 192.168.5.10 or 192.168.6.10
  1862. $cfg[&#39;Servers&#39;][$i][&#39;AllowDeny&#39;][&#39;order&#39;] = &#39;allow,deny&#39;;
  1863. $cfg[&#39;Servers&#39;][$i][&#39;AllowDeny&#39;][&#39;rules&#39;] = [&#39;allow root from 192.168.5.50&#39;,&#39;allow % from 192.168.6.10&#39;];
  1864. // Allow any user to connect from 192.168.6.10, and additionally allow root to connect from 192.168.5.50
  1865. </pre></div>
  1866. </div>
  1867. </dd></dl>
  1868. <dl class="config option">
  1869. <dt class="sig sig-object config" id="cfg_Servers_DisableIS">
  1870. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['DisableIS']</span></span><a class="headerlink" href="#cfg_Servers_DisableIS" title="Permalink to this definition">¶</a></dt>
  1871. <dd><dl class="field-list simple">
  1872. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1873. <dd class="field-odd"><p>boolean</p>
  1874. </dd>
  1875. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1876. <dd class="field-even"><p>false</p>
  1877. </dd>
  1878. </dl>
  1879. <p>Disable using <code class="docutils literal notranslate"><span class="pre">INFORMATION_SCHEMA</span></code> to retrieve information (use
  1880. <code class="docutils literal notranslate"><span class="pre">SHOW</span></code> commands instead), because of speed issues when many
  1881. databases are present.</p>
  1882. <div class="admonition note">
  1883. <p class="admonition-title">Note</p>
  1884. <p>Enabling this option might give you a big performance boost on older
  1885. MySQL servers.</p>
  1886. </div>
  1887. </dd></dl>
  1888. <dl class="config option">
  1889. <dt class="sig sig-object config" id="cfg_Servers_SignonScript">
  1890. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['SignonScript']</span></span><a class="headerlink" href="#cfg_Servers_SignonScript" title="Permalink to this definition">¶</a></dt>
  1891. <dd><dl class="field-list simple">
  1892. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1893. <dd class="field-odd"><p>string</p>
  1894. </dd>
  1895. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1896. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1897. </dd>
  1898. </dl>
  1899. <div class="versionadded">
  1900. <p><span class="versionmodified added">New in version 3.5.0.</span></p>
  1901. </div>
  1902. <p>Name of PHP script to be sourced and executed to obtain login
  1903. credentials. This is alternative approach to session based single
  1904. signon. The script has to provide a function called
  1905. <code class="docutils literal notranslate"><span class="pre">get_login_credentials</span></code> which returns list of username and
  1906. password, accepting single parameter of existing username (can be
  1907. empty). See <code class="file docutils literal notranslate"><span class="pre">examples/signon-script.php</span></code> for an example:</p>
  1908. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;?</span><span class="nx">php</span>
  1909. <span class="sd">/**</span>
  1910. <span class="sd"> * Single signon for phpMyAdmin</span>
  1911. <span class="sd"> *</span>
  1912. <span class="sd"> * This is just example how to use script based single signon with</span>
  1913. <span class="sd"> * phpMyAdmin, it is not intended to be perfect code and look, only</span>
  1914. <span class="sd"> * shows how you can integrate this functionality in your application.</span>
  1915. <span class="sd"> */</span>
  1916. <span class="k">declare</span><span class="p">(</span><span class="nx">strict_types</span><span class="o">=</span><span class="mi">1</span><span class="p">);</span>
  1917. <span class="c1">// phpcs:disable Squiz.Functions.GlobalFunction</span>
  1918. <span class="sd">/**</span>
  1919. <span class="sd"> * This function returns username and password.</span>
  1920. <span class="sd"> *</span>
  1921. <span class="sd"> * It can optionally use configured username as parameter.</span>
  1922. <span class="sd"> *</span>
  1923. <span class="sd"> * @param string $user User name</span>
  1924. <span class="sd"> *</span>
  1925. <span class="sd"> * @return array</span>
  1926. <span class="sd"> */</span>
  1927. <span class="k">function</span> <span class="nf">get_login_credentials</span><span class="p">(</span><span class="nv">$user</span><span class="p">)</span>
  1928. <span class="p">{</span>
  1929. <span class="cm">/* Optionally we can use passed username */</span>
  1930. <span class="k">if</span> <span class="p">(</span><span class="o">!</span> <span class="k">empty</span><span class="p">(</span><span class="nv">$user</span><span class="p">))</span> <span class="p">{</span>
  1931. <span class="k">return</span> <span class="p">[</span>
  1932. <span class="nv">$user</span><span class="p">,</span>
  1933. <span class="s1">&#39;password&#39;</span><span class="p">,</span>
  1934. <span class="p">];</span>
  1935. <span class="p">}</span>
  1936. <span class="cm">/* Here we would retrieve the credentials */</span>
  1937. <span class="k">return</span> <span class="p">[</span>
  1938. <span class="s1">&#39;root&#39;</span><span class="p">,</span>
  1939. <span class="s1">&#39;&#39;</span><span class="p">,</span>
  1940. <span class="p">];</span>
  1941. <span class="p">}</span>
  1942. </pre></div>
  1943. </div>
  1944. <div class="admonition seealso">
  1945. <p class="admonition-title">See also</p>
  1946. <p><a class="reference internal" href="setup.html#auth-signon"><span class="std std-ref">Signon authentication mode</span></a></p>
  1947. </div>
  1948. </dd></dl>
  1949. <dl class="config option">
  1950. <dt class="sig sig-object config" id="cfg_Servers_SignonSession">
  1951. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['SignonSession']</span></span><a class="headerlink" href="#cfg_Servers_SignonSession" title="Permalink to this definition">¶</a></dt>
  1952. <dd><dl class="field-list simple">
  1953. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1954. <dd class="field-odd"><p>string</p>
  1955. </dd>
  1956. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1957. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  1958. </dd>
  1959. </dl>
  1960. <p>Name of session which will be used for signon authentication method.
  1961. You should use something different than <code class="docutils literal notranslate"><span class="pre">phpMyAdmin</span></code>, because this
  1962. is session which phpMyAdmin uses internally. Takes effect only if
  1963. <span class="target" id="index-132"></span><a class="reference internal" href="#cfg_Servers_SignonScript"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['SignonScript']</span></code></a> is not configured.</p>
  1964. <div class="admonition seealso">
  1965. <p class="admonition-title">See also</p>
  1966. <p><a class="reference internal" href="setup.html#auth-signon"><span class="std std-ref">Signon authentication mode</span></a></p>
  1967. </div>
  1968. </dd></dl>
  1969. <dl class="config option">
  1970. <dt class="sig sig-object config" id="cfg_Servers_SignonCookieParams">
  1971. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['SignonCookieParams']</span></span><a class="headerlink" href="#cfg_Servers_SignonCookieParams" title="Permalink to this definition">¶</a></dt>
  1972. <dd><dl class="field-list simple">
  1973. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1974. <dd class="field-odd"><p>array</p>
  1975. </dd>
  1976. <dt class="field-even">Default value<span class="colon">:</span></dt>
  1977. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">array()</span></code></p>
  1978. </dd>
  1979. </dl>
  1980. <div class="versionadded">
  1981. <p><span class="versionmodified added">New in version 4.7.0.</span></p>
  1982. </div>
  1983. <p>An associative array of session cookie parameters of other authentication system.
  1984. It is not needed if the other system doesn’t use session_set_cookie_params().
  1985. Keys should include ‘lifetime’, ‘path’, ‘domain’, ‘secure’ or ‘httponly’.
  1986. Valid values are mentioned in <a class="reference external" href="https://www.php.net/manual/en/function.session-get-cookie-params.php">session_get_cookie_params</a>, they should be set to same values as the
  1987. other application uses. Takes effect only if
  1988. <span class="target" id="index-133"></span><a class="reference internal" href="#cfg_Servers_SignonScript"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['SignonScript']</span></code></a> is not configured.</p>
  1989. <div class="admonition seealso">
  1990. <p class="admonition-title">See also</p>
  1991. <p><a class="reference internal" href="setup.html#auth-signon"><span class="std std-ref">Signon authentication mode</span></a></p>
  1992. </div>
  1993. </dd></dl>
  1994. <dl class="config option">
  1995. <dt class="sig sig-object config" id="cfg_Servers_SignonURL">
  1996. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['SignonURL']</span></span><a class="headerlink" href="#cfg_Servers_SignonURL" title="Permalink to this definition">¶</a></dt>
  1997. <dd><dl class="field-list simple">
  1998. <dt class="field-odd">Type<span class="colon">:</span></dt>
  1999. <dd class="field-odd"><p>string</p>
  2000. </dd>
  2001. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2002. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2003. </dd>
  2004. </dl>
  2005. <p><a class="reference internal" href="glossary.html#term-URL"><span class="xref std std-term">URL</span></a> where user will be redirected
  2006. to log in for signon authentication method. Should be absolute
  2007. including protocol.</p>
  2008. <div class="admonition seealso">
  2009. <p class="admonition-title">See also</p>
  2010. <p><a class="reference internal" href="setup.html#auth-signon"><span class="std std-ref">Signon authentication mode</span></a></p>
  2011. </div>
  2012. </dd></dl>
  2013. <dl class="config option">
  2014. <dt class="sig sig-object config" id="cfg_Servers_LogoutURL">
  2015. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['LogoutURL']</span></span><a class="headerlink" href="#cfg_Servers_LogoutURL" title="Permalink to this definition">¶</a></dt>
  2016. <dd><dl class="field-list simple">
  2017. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2018. <dd class="field-odd"><p>string</p>
  2019. </dd>
  2020. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2021. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2022. </dd>
  2023. </dl>
  2024. <p><a class="reference internal" href="glossary.html#term-URL"><span class="xref std std-term">URL</span></a> where user will be redirected
  2025. after logout (doesn’t affect config authentication method). Should be
  2026. absolute including protocol.</p>
  2027. </dd></dl>
  2028. <dl class="config option">
  2029. <dt class="sig sig-object config" id="cfg_Servers_hide_connection_errors">
  2030. <span class="sig-name descname"><span class="pre">$cfg['Servers'][$i]['hide_connection_errors']</span></span><a class="headerlink" href="#cfg_Servers_hide_connection_errors" title="Permalink to this definition">¶</a></dt>
  2031. <dd><dl class="field-list simple">
  2032. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2033. <dd class="field-odd"><p>boolean</p>
  2034. </dd>
  2035. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2036. <dd class="field-even"><p>false</p>
  2037. </dd>
  2038. </dl>
  2039. <div class="versionadded">
  2040. <p><span class="versionmodified added">New in version 4.9.8.</span></p>
  2041. </div>
  2042. <p>Whether to show or hide detailed MySQL/MariaDB connection errors on the login page.</p>
  2043. <div class="admonition note">
  2044. <p class="admonition-title">Note</p>
  2045. <p>This error message can contain the target database server hostname or IP address,
  2046. which may reveal information about your network to an attacker.</p>
  2047. </div>
  2048. </dd></dl>
  2049. </section>
  2050. <section id="generic-settings">
  2051. <h2>Generic settings<a class="headerlink" href="#generic-settings" title="Permalink to this heading">¶</a></h2>
  2052. <dl class="config option">
  2053. <dt class="sig sig-object config" id="cfg_DisableShortcutKeys">
  2054. <span class="sig-name descname"><span class="pre">$cfg['DisableShortcutKeys']</span></span><a class="headerlink" href="#cfg_DisableShortcutKeys" title="Permalink to this definition">¶</a></dt>
  2055. <dd><dl class="field-list simple">
  2056. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2057. <dd class="field-odd"><p>boolean</p>
  2058. </dd>
  2059. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2060. <dd class="field-even"><p>false</p>
  2061. </dd>
  2062. </dl>
  2063. <p>You can disable phpMyAdmin shortcut keys by setting <span class="target" id="index-134"></span><a class="reference internal" href="#cfg_DisableShortcutKeys"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['DisableShortcutKeys']</span></code></a> to true.</p>
  2064. </dd></dl>
  2065. <dl class="config option">
  2066. <dt class="sig sig-object config" id="cfg_ServerDefault">
  2067. <span class="sig-name descname"><span class="pre">$cfg['ServerDefault']</span></span><a class="headerlink" href="#cfg_ServerDefault" title="Permalink to this definition">¶</a></dt>
  2068. <dd><dl class="field-list simple">
  2069. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2070. <dd class="field-odd"><p>integer</p>
  2071. </dd>
  2072. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2073. <dd class="field-even"><p>1</p>
  2074. </dd>
  2075. </dl>
  2076. <p>If you have more than one server configured, you can set
  2077. <span class="target" id="index-135"></span><a class="reference internal" href="#cfg_ServerDefault"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['ServerDefault']</span></code></a> to any one of them to autoconnect to that
  2078. server when phpMyAdmin is started, or set it to 0 to be given a list
  2079. of servers without logging in.</p>
  2080. <p>If you have only one server configured,
  2081. <span class="target" id="index-136"></span><a class="reference internal" href="#cfg_ServerDefault"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['ServerDefault']</span></code></a> MUST be set to that server.</p>
  2082. </dd></dl>
  2083. <dl class="config option">
  2084. <dt class="sig sig-object config" id="cfg_VersionCheck">
  2085. <span class="sig-name descname"><span class="pre">$cfg['VersionCheck']</span></span><a class="headerlink" href="#cfg_VersionCheck" title="Permalink to this definition">¶</a></dt>
  2086. <dd><dl class="field-list simple">
  2087. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2088. <dd class="field-odd"><p>boolean</p>
  2089. </dd>
  2090. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2091. <dd class="field-even"><p>true</p>
  2092. </dd>
  2093. </dl>
  2094. <p>Enables check for latest versions using JavaScript on the main phpMyAdmin
  2095. page or by directly accessing <cite>index.php?route=/version-check</cite>.</p>
  2096. <div class="admonition note">
  2097. <p class="admonition-title">Note</p>
  2098. <p>This setting can be adjusted by your vendor.</p>
  2099. </div>
  2100. </dd></dl>
  2101. <dl class="config option">
  2102. <dt class="sig sig-object config" id="cfg_ProxyUrl">
  2103. <span class="sig-name descname"><span class="pre">$cfg['ProxyUrl']</span></span><a class="headerlink" href="#cfg_ProxyUrl" title="Permalink to this definition">¶</a></dt>
  2104. <dd><dl class="field-list simple">
  2105. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2106. <dd class="field-odd"><p>string</p>
  2107. </dd>
  2108. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2109. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2110. </dd>
  2111. </dl>
  2112. <p>The url of the proxy to be used when phpmyadmin needs to access the outside
  2113. internet such as when retrieving the latest version info or submitting error
  2114. reports. You need this if the server where phpMyAdmin is installed does not
  2115. have direct access to the internet.
  2116. The format is: “hostname:portnumber”</p>
  2117. </dd></dl>
  2118. <dl class="config option">
  2119. <dt class="sig sig-object config" id="cfg_ProxyUser">
  2120. <span class="sig-name descname"><span class="pre">$cfg['ProxyUser']</span></span><a class="headerlink" href="#cfg_ProxyUser" title="Permalink to this definition">¶</a></dt>
  2121. <dd><dl class="field-list simple">
  2122. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2123. <dd class="field-odd"><p>string</p>
  2124. </dd>
  2125. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2126. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2127. </dd>
  2128. </dl>
  2129. <p>The username for authenticating with the proxy. By default, no
  2130. authentication is performed. If a username is supplied, Basic
  2131. Authentication will be performed. No other types of authentication
  2132. are currently supported.</p>
  2133. </dd></dl>
  2134. <dl class="config option">
  2135. <dt class="sig sig-object config" id="cfg_ProxyPass">
  2136. <span class="sig-name descname"><span class="pre">$cfg['ProxyPass']</span></span><a class="headerlink" href="#cfg_ProxyPass" title="Permalink to this definition">¶</a></dt>
  2137. <dd><dl class="field-list simple">
  2138. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2139. <dd class="field-odd"><p>string</p>
  2140. </dd>
  2141. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2142. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2143. </dd>
  2144. </dl>
  2145. <p>The password for authenticating with the proxy.</p>
  2146. </dd></dl>
  2147. <dl class="config option">
  2148. <dt class="sig sig-object config" id="cfg_MaxDbList">
  2149. <span class="sig-name descname"><span class="pre">$cfg['MaxDbList']</span></span><a class="headerlink" href="#cfg_MaxDbList" title="Permalink to this definition">¶</a></dt>
  2150. <dd><dl class="field-list simple">
  2151. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2152. <dd class="field-odd"><p>integer</p>
  2153. </dd>
  2154. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2155. <dd class="field-even"><p>100</p>
  2156. </dd>
  2157. </dl>
  2158. <p>The maximum number of database names to be displayed in the main panel’s
  2159. database list.</p>
  2160. </dd></dl>
  2161. <dl class="config option">
  2162. <dt class="sig sig-object config" id="cfg_MaxTableList">
  2163. <span class="sig-name descname"><span class="pre">$cfg['MaxTableList']</span></span><a class="headerlink" href="#cfg_MaxTableList" title="Permalink to this definition">¶</a></dt>
  2164. <dd><dl class="field-list simple">
  2165. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2166. <dd class="field-odd"><p>integer</p>
  2167. </dd>
  2168. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2169. <dd class="field-even"><p>250</p>
  2170. </dd>
  2171. </dl>
  2172. <p>The maximum number of table names to be displayed in the main panel’s
  2173. list (except on the Export page).</p>
  2174. </dd></dl>
  2175. <dl class="config option">
  2176. <dt class="sig sig-object config" id="cfg_ShowHint">
  2177. <span class="sig-name descname"><span class="pre">$cfg['ShowHint']</span></span><a class="headerlink" href="#cfg_ShowHint" title="Permalink to this definition">¶</a></dt>
  2178. <dd><dl class="field-list simple">
  2179. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2180. <dd class="field-odd"><p>boolean</p>
  2181. </dd>
  2182. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2183. <dd class="field-even"><p>true</p>
  2184. </dd>
  2185. </dl>
  2186. <p>Whether or not to show hints (for example, hints when hovering over
  2187. table headers).</p>
  2188. </dd></dl>
  2189. <dl class="config option">
  2190. <dt class="sig sig-object config" id="cfg_MaxCharactersInDisplayedSQL">
  2191. <span class="sig-name descname"><span class="pre">$cfg['MaxCharactersInDisplayedSQL']</span></span><a class="headerlink" href="#cfg_MaxCharactersInDisplayedSQL" title="Permalink to this definition">¶</a></dt>
  2192. <dd><dl class="field-list simple">
  2193. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2194. <dd class="field-odd"><p>integer</p>
  2195. </dd>
  2196. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2197. <dd class="field-even"><p>1000</p>
  2198. </dd>
  2199. </dl>
  2200. <p>The maximum number of characters when a <a class="reference internal" href="glossary.html#term-SQL"><span class="xref std std-term">SQL</span></a> query is displayed. The
  2201. default limit of 1000 should be correct to avoid the display of tons of
  2202. hexadecimal codes that represent BLOBs, but some users have real
  2203. <a class="reference internal" href="glossary.html#term-SQL"><span class="xref std std-term">SQL</span></a> queries that are longer than 1000 characters. Also, if a
  2204. query’s length exceeds this limit, this query is not saved in the history.</p>
  2205. </dd></dl>
  2206. <dl class="config option">
  2207. <dt class="sig sig-object config" id="cfg_PersistentConnections">
  2208. <span class="sig-name descname"><span class="pre">$cfg['PersistentConnections']</span></span><a class="headerlink" href="#cfg_PersistentConnections" title="Permalink to this definition">¶</a></dt>
  2209. <dd><dl class="field-list simple">
  2210. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2211. <dd class="field-odd"><p>boolean</p>
  2212. </dd>
  2213. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2214. <dd class="field-even"><p>false</p>
  2215. </dd>
  2216. </dl>
  2217. <p>Whether <a class="reference external" href="https://www.php.net/manual/en/features.persistent-connections.php">persistent connections</a> should be used or not.</p>
  2218. </dd></dl>
  2219. <div class="admonition seealso">
  2220. <p class="admonition-title">See also</p>
  2221. <p><a class="reference external" href="https://www.php.net/manual/en/mysqli.persistconns.php">mysqli documentation for persistent connections</a></p>
  2222. </div>
  2223. <dl class="config option">
  2224. <dt class="sig sig-object config" id="cfg_ForceSSL">
  2225. <span class="sig-name descname"><span class="pre">$cfg['ForceSSL']</span></span><a class="headerlink" href="#cfg_ForceSSL" title="Permalink to this definition">¶</a></dt>
  2226. <dd><dl class="field-list simple">
  2227. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2228. <dd class="field-odd"><p>boolean</p>
  2229. </dd>
  2230. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2231. <dd class="field-even"><p>false</p>
  2232. </dd>
  2233. </dl>
  2234. <div class="deprecated">
  2235. <p><span class="versionmodified deprecated">Deprecated since version 4.6.0: </span>This setting is no longer available since phpMyAdmin 4.6.0. Please
  2236. adjust your webserver instead.</p>
  2237. </div>
  2238. <p>Whether to force using https while accessing phpMyAdmin. In a reverse
  2239. proxy setup, setting this to <code class="docutils literal notranslate"><span class="pre">true</span></code> is not supported.</p>
  2240. <div class="admonition note">
  2241. <p class="admonition-title">Note</p>
  2242. <p>In some setups (like separate SSL proxy or load balancer) you might
  2243. have to set <span class="target" id="index-137"></span><a class="reference internal" href="#cfg_PmaAbsoluteUri"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['PmaAbsoluteUri']</span></code></a> for correct
  2244. redirection.</p>
  2245. </div>
  2246. </dd></dl>
  2247. <dl class="config option">
  2248. <dt class="sig sig-object config" id="cfg_MysqlSslWarningSafeHosts">
  2249. <span class="sig-name descname"><span class="pre">$cfg['MysqlSslWarningSafeHosts']</span></span><a class="headerlink" href="#cfg_MysqlSslWarningSafeHosts" title="Permalink to this definition">¶</a></dt>
  2250. <dd><dl class="field-list simple">
  2251. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2252. <dd class="field-odd"><p>array</p>
  2253. </dd>
  2254. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2255. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">['127.0.0.1',</span> <span class="pre">'localhost']</span></code></p>
  2256. </dd>
  2257. </dl>
  2258. <p>This search is case-sensitive and will match the exact string only.
  2259. If your setup does not use SSL but is safe because you are using a
  2260. local connection or private network, you can add your hostname or <a class="reference internal" href="glossary.html#term-IP"><span class="xref std std-term">IP</span></a> to the list.
  2261. You can also remove the default entries to only include yours.</p>
  2262. <p>This check uses the value of <span class="target" id="index-138"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a>.</p>
  2263. <div class="versionadded">
  2264. <p><span class="versionmodified added">New in version 5.1.0.</span></p>
  2265. </div>
  2266. <p>Example configuration</p>
  2267. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;MysqlSslWarningSafeHosts&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;127.0.0.1&#39;</span><span class="p">,</span> <span class="s1">&#39;localhost&#39;</span><span class="p">,</span> <span class="s1">&#39;mariadb.local&#39;</span><span class="p">];</span>
  2268. </pre></div>
  2269. </div>
  2270. </dd></dl>
  2271. <dl class="config option">
  2272. <dt class="sig sig-object config" id="cfg_ExecTimeLimit">
  2273. <span class="sig-name descname"><span class="pre">$cfg['ExecTimeLimit']</span></span><a class="headerlink" href="#cfg_ExecTimeLimit" title="Permalink to this definition">¶</a></dt>
  2274. <dd><dl class="field-list simple">
  2275. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2276. <dd class="field-odd"><p>integer [number of seconds]</p>
  2277. </dd>
  2278. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2279. <dd class="field-even"><p>300</p>
  2280. </dd>
  2281. </dl>
  2282. <p>Set the number of seconds a script is allowed to run. If seconds is
  2283. set to zero, no time limit is imposed. This setting is used while
  2284. importing/exporting dump files but has
  2285. no effect when PHP is running in safe mode.</p>
  2286. </dd></dl>
  2287. <dl class="config option">
  2288. <dt class="sig sig-object config" id="cfg_SessionSavePath">
  2289. <span class="sig-name descname"><span class="pre">$cfg['SessionSavePath']</span></span><a class="headerlink" href="#cfg_SessionSavePath" title="Permalink to this definition">¶</a></dt>
  2290. <dd><dl class="field-list simple">
  2291. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2292. <dd class="field-odd"><p>string</p>
  2293. </dd>
  2294. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2295. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2296. </dd>
  2297. </dl>
  2298. <p>Path for storing session data (<a class="reference external" href="https://www.php.net/session_save_path">session_save_path PHP parameter</a>).</p>
  2299. <div class="admonition warning">
  2300. <p class="admonition-title">Warning</p>
  2301. <p>This folder should not be publicly accessible through the webserver,
  2302. otherwise you risk leaking private data from your session.</p>
  2303. </div>
  2304. </dd></dl>
  2305. <dl class="config option">
  2306. <dt class="sig sig-object config" id="cfg_MemoryLimit">
  2307. <span class="sig-name descname"><span class="pre">$cfg['MemoryLimit']</span></span><a class="headerlink" href="#cfg_MemoryLimit" title="Permalink to this definition">¶</a></dt>
  2308. <dd><dl class="field-list simple">
  2309. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2310. <dd class="field-odd"><p>string [number of bytes]</p>
  2311. </dd>
  2312. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2313. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'-1'</span></code></p>
  2314. </dd>
  2315. </dl>
  2316. <p>Set the number of bytes a script is allowed to allocate. If set to
  2317. <code class="docutils literal notranslate"><span class="pre">'-1'</span></code>, no limit is imposed. If set to <code class="docutils literal notranslate"><span class="pre">'0'</span></code>, no change of the
  2318. memory limit is attempted and the <code class="file docutils literal notranslate"><span class="pre">php.ini</span></code> <code class="docutils literal notranslate"><span class="pre">memory_limit</span></code> is
  2319. used.</p>
  2320. <p>This setting is used while importing/exporting dump files
  2321. so you definitely don’t want to put here a too low
  2322. value. It has no effect when PHP is running in safe mode.</p>
  2323. <p>You can also use any string as in <code class="file docutils literal notranslate"><span class="pre">php.ini</span></code>, eg. ‘16M’. Ensure you
  2324. don’t omit the suffix (16 means 16 bytes!)</p>
  2325. </dd></dl>
  2326. <dl class="config option">
  2327. <dt class="sig sig-object config" id="cfg_SkipLockedTables">
  2328. <span class="sig-name descname"><span class="pre">$cfg['SkipLockedTables']</span></span><a class="headerlink" href="#cfg_SkipLockedTables" title="Permalink to this definition">¶</a></dt>
  2329. <dd><dl class="field-list simple">
  2330. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2331. <dd class="field-odd"><p>boolean</p>
  2332. </dd>
  2333. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2334. <dd class="field-even"><p>false</p>
  2335. </dd>
  2336. </dl>
  2337. <p>Mark used tables and make it possible to show databases with locked
  2338. tables (since MySQL 3.23.30).</p>
  2339. </dd></dl>
  2340. <dl class="config option">
  2341. <dt class="sig sig-object config" id="cfg_ShowSQL">
  2342. <span class="sig-name descname"><span class="pre">$cfg['ShowSQL']</span></span><a class="headerlink" href="#cfg_ShowSQL" title="Permalink to this definition">¶</a></dt>
  2343. <dd><dl class="field-list simple">
  2344. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2345. <dd class="field-odd"><p>boolean</p>
  2346. </dd>
  2347. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2348. <dd class="field-even"><p>true</p>
  2349. </dd>
  2350. </dl>
  2351. <p>Defines whether <a class="reference internal" href="glossary.html#term-SQL"><span class="xref std std-term">SQL</span></a> queries
  2352. generated by phpMyAdmin should be displayed or not.</p>
  2353. </dd></dl>
  2354. <dl class="config option">
  2355. <dt class="sig sig-object config" id="cfg_RetainQueryBox">
  2356. <span class="sig-name descname"><span class="pre">$cfg['RetainQueryBox']</span></span><a class="headerlink" href="#cfg_RetainQueryBox" title="Permalink to this definition">¶</a></dt>
  2357. <dd><dl class="field-list simple">
  2358. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2359. <dd class="field-odd"><p>boolean</p>
  2360. </dd>
  2361. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2362. <dd class="field-even"><p>false</p>
  2363. </dd>
  2364. </dl>
  2365. <p>Defines whether the <a class="reference internal" href="glossary.html#term-SQL"><span class="xref std std-term">SQL</span></a> query box
  2366. should be kept displayed after its submission.</p>
  2367. </dd></dl>
  2368. <dl class="config option">
  2369. <dt class="sig sig-object config" id="cfg_CodemirrorEnable">
  2370. <span class="sig-name descname"><span class="pre">$cfg['CodemirrorEnable']</span></span><a class="headerlink" href="#cfg_CodemirrorEnable" title="Permalink to this definition">¶</a></dt>
  2371. <dd><dl class="field-list simple">
  2372. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2373. <dd class="field-odd"><p>boolean</p>
  2374. </dd>
  2375. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2376. <dd class="field-even"><p>true</p>
  2377. </dd>
  2378. </dl>
  2379. <p>Defines whether to use a Javascript code editor for SQL query boxes.
  2380. CodeMirror provides syntax highlighting and line numbers. However,
  2381. middle-clicking for pasting the clipboard contents in some Linux
  2382. distributions (such as Ubuntu) is not supported by all browsers.</p>
  2383. </dd></dl>
  2384. <dl class="config option">
  2385. <dt class="sig sig-object config" id="cfg_LintEnable">
  2386. <span class="sig-name descname"><span class="pre">$cfg['LintEnable']</span></span><a class="headerlink" href="#cfg_LintEnable" title="Permalink to this definition">¶</a></dt>
  2387. <dd><dl class="field-list simple">
  2388. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2389. <dd class="field-odd"><p>boolean</p>
  2390. </dd>
  2391. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2392. <dd class="field-even"><p>true</p>
  2393. </dd>
  2394. </dl>
  2395. <div class="versionadded">
  2396. <p><span class="versionmodified added">New in version 4.5.0.</span></p>
  2397. </div>
  2398. <p>Defines whether to use the parser to find any errors in the query before executing.</p>
  2399. </dd></dl>
  2400. <dl class="config option">
  2401. <dt class="sig sig-object config" id="cfg_DefaultForeignKeyChecks">
  2402. <span class="sig-name descname"><span class="pre">$cfg['DefaultForeignKeyChecks']</span></span><a class="headerlink" href="#cfg_DefaultForeignKeyChecks" title="Permalink to this definition">¶</a></dt>
  2403. <dd><dl class="field-list simple">
  2404. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2405. <dd class="field-odd"><p>string</p>
  2406. </dd>
  2407. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2408. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'default'</span></code></p>
  2409. </dd>
  2410. </dl>
  2411. <p>Default value of the checkbox for foreign key checks, to disable/enable
  2412. foreign key checks for certain queries. The possible values are <code class="docutils literal notranslate"><span class="pre">'default'</span></code>,
  2413. <code class="docutils literal notranslate"><span class="pre">'enable'</span></code> or <code class="docutils literal notranslate"><span class="pre">'disable'</span></code>. If set to <code class="docutils literal notranslate"><span class="pre">'default'</span></code>, the value of the
  2414. MySQL variable <code class="docutils literal notranslate"><span class="pre">FOREIGN_KEY_CHECKS</span></code> is used.</p>
  2415. </dd></dl>
  2416. <dl class="config option">
  2417. <dt class="sig sig-object config" id="cfg_AllowUserDropDatabase">
  2418. <span class="sig-name descname"><span class="pre">$cfg['AllowUserDropDatabase']</span></span><a class="headerlink" href="#cfg_AllowUserDropDatabase" title="Permalink to this definition">¶</a></dt>
  2419. <dd><dl class="field-list simple">
  2420. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2421. <dd class="field-odd"><p>boolean</p>
  2422. </dd>
  2423. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2424. <dd class="field-even"><p>false</p>
  2425. </dd>
  2426. </dl>
  2427. <div class="admonition warning">
  2428. <p class="admonition-title">Warning</p>
  2429. <p>This is not a security measure as there will be always ways to
  2430. circumvent this. If you want to prohibit users from dropping databases,
  2431. revoke their corresponding DROP privilege.</p>
  2432. </div>
  2433. <p>Defines whether normal users (non-administrator) are allowed to delete
  2434. their own database or not. If set as false, the link <span class="guilabel">Drop
  2435. Database</span> will not be shown, and even a <code class="docutils literal notranslate"><span class="pre">DROP</span> <span class="pre">DATABASE</span> <span class="pre">mydatabase</span></code> will
  2436. be rejected. Quite practical for <a class="reference internal" href="glossary.html#term-ISP"><span class="xref std std-term">ISP</span></a> ‘s with many customers.</p>
  2437. <p>This limitation of <a class="reference internal" href="glossary.html#term-SQL"><span class="xref std std-term">SQL</span></a> queries is not as strict as when using MySQL
  2438. privileges. This is due to nature of <a class="reference internal" href="glossary.html#term-SQL"><span class="xref std std-term">SQL</span></a> queries which might be
  2439. quite complicated. So this choice should be viewed as help to avoid
  2440. accidental dropping rather than strict privilege limitation.</p>
  2441. </dd></dl>
  2442. <dl class="config option">
  2443. <dt class="sig sig-object config" id="cfg_Confirm">
  2444. <span class="sig-name descname"><span class="pre">$cfg['Confirm']</span></span><a class="headerlink" href="#cfg_Confirm" title="Permalink to this definition">¶</a></dt>
  2445. <dd><dl class="field-list simple">
  2446. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2447. <dd class="field-odd"><p>boolean</p>
  2448. </dd>
  2449. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2450. <dd class="field-even"><p>true</p>
  2451. </dd>
  2452. </dl>
  2453. <p>Whether a warning (“Are your really sure…”) should be displayed when
  2454. you’re about to lose data.</p>
  2455. </dd></dl>
  2456. <dl class="config option">
  2457. <dt class="sig sig-object config" id="cfg_UseDbSearch">
  2458. <span class="sig-name descname"><span class="pre">$cfg['UseDbSearch']</span></span><a class="headerlink" href="#cfg_UseDbSearch" title="Permalink to this definition">¶</a></dt>
  2459. <dd><dl class="field-list simple">
  2460. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2461. <dd class="field-odd"><p>boolean</p>
  2462. </dd>
  2463. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2464. <dd class="field-even"><p>true</p>
  2465. </dd>
  2466. </dl>
  2467. <p>Define whether the “search string inside database” is enabled or not.</p>
  2468. </dd></dl>
  2469. <dl class="config option">
  2470. <dt class="sig sig-object config" id="cfg_IgnoreMultiSubmitErrors">
  2471. <span class="sig-name descname"><span class="pre">$cfg['IgnoreMultiSubmitErrors']</span></span><a class="headerlink" href="#cfg_IgnoreMultiSubmitErrors" title="Permalink to this definition">¶</a></dt>
  2472. <dd><dl class="field-list simple">
  2473. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2474. <dd class="field-odd"><p>boolean</p>
  2475. </dd>
  2476. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2477. <dd class="field-even"><p>false</p>
  2478. </dd>
  2479. </dl>
  2480. <p>Define whether phpMyAdmin will continue executing a multi-query
  2481. statement if one of the queries fails. Default is to abort execution.</p>
  2482. </dd></dl>
  2483. <dl class="config option">
  2484. <dt class="sig sig-object config" id="cfg_enable_drag_drop_import">
  2485. <span class="sig-name descname"><span class="pre">$cfg['enable_drag_drop_import']</span></span><a class="headerlink" href="#cfg_enable_drag_drop_import" title="Permalink to this definition">¶</a></dt>
  2486. <dd><dl class="field-list simple">
  2487. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2488. <dd class="field-odd"><p>boolean</p>
  2489. </dd>
  2490. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2491. <dd class="field-even"><p>true</p>
  2492. </dd>
  2493. </dl>
  2494. <p>Whether or not the drag and drop import feature is enabled.
  2495. When enabled, a user can drag a file in to their browser and phpMyAdmin will
  2496. attempt to import the file.</p>
  2497. </dd></dl>
  2498. <dl class="config option">
  2499. <dt class="sig sig-object config" id="cfg_URLQueryEncryption">
  2500. <span class="sig-name descname"><span class="pre">$cfg['URLQueryEncryption']</span></span><a class="headerlink" href="#cfg_URLQueryEncryption" title="Permalink to this definition">¶</a></dt>
  2501. <dd><dl class="field-list simple">
  2502. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2503. <dd class="field-odd"><p>boolean</p>
  2504. </dd>
  2505. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2506. <dd class="field-even"><p>false</p>
  2507. </dd>
  2508. </dl>
  2509. <div class="versionadded">
  2510. <p><span class="versionmodified added">New in version 4.9.8.</span></p>
  2511. </div>
  2512. <p>Define whether phpMyAdmin will encrypt sensitive data (like database name
  2513. and table name) from the URL query string. Default is to not encrypt the URL
  2514. query string.</p>
  2515. </dd></dl>
  2516. <dl class="config option">
  2517. <dt class="sig sig-object config" id="cfg_URLQueryEncryptionSecretKey">
  2518. <span class="sig-name descname"><span class="pre">$cfg['URLQueryEncryptionSecretKey']</span></span><a class="headerlink" href="#cfg_URLQueryEncryptionSecretKey" title="Permalink to this definition">¶</a></dt>
  2519. <dd><dl class="field-list simple">
  2520. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2521. <dd class="field-odd"><p>string</p>
  2522. </dd>
  2523. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2524. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2525. </dd>
  2526. </dl>
  2527. <div class="versionadded">
  2528. <p><span class="versionmodified added">New in version 4.9.8.</span></p>
  2529. </div>
  2530. <p>A secret key used to encrypt/decrypt the URL query string.
  2531. Should be 32 bytes long.</p>
  2532. <div class="admonition seealso">
  2533. <p class="admonition-title">See also</p>
  2534. <p><a class="reference internal" href="faq.html#faq2-10"><span class="std std-ref">2.10 How to generate a string of random bytes</span></a></p>
  2535. </div>
  2536. </dd></dl>
  2537. <dl class="config option">
  2538. <dt class="sig sig-object config" id="cfg_maxRowPlotLimit">
  2539. <span class="sig-name descname"><span class="pre">$cfg['maxRowPlotLimit']</span></span><a class="headerlink" href="#cfg_maxRowPlotLimit" title="Permalink to this definition">¶</a></dt>
  2540. <dd><dl class="field-list simple">
  2541. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2542. <dd class="field-odd"><p>integer</p>
  2543. </dd>
  2544. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2545. <dd class="field-even"><p>500</p>
  2546. </dd>
  2547. </dl>
  2548. <p>Maximum number of rows retrieved for zoom search.</p>
  2549. </dd></dl>
  2550. </section>
  2551. <section id="cookie-authentication-options">
  2552. <h2>Cookie authentication options<a class="headerlink" href="#cookie-authentication-options" title="Permalink to this heading">¶</a></h2>
  2553. <dl class="config option">
  2554. <dt class="sig sig-object config" id="cfg_blowfish_secret">
  2555. <span class="sig-name descname"><span class="pre">$cfg['blowfish_secret']</span></span><a class="headerlink" href="#cfg_blowfish_secret" title="Permalink to this definition">¶</a></dt>
  2556. <dd><dl class="field-list simple">
  2557. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2558. <dd class="field-odd"><p>string</p>
  2559. </dd>
  2560. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2561. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2562. </dd>
  2563. </dl>
  2564. <p>The “cookie” auth_type uses the <a class="reference internal" href="glossary.html#term-Sodium"><span class="xref std std-term">Sodium</span></a> extension to encrypt the cookies (see <a class="reference internal" href="glossary.html#term-Cookie"><span class="xref std std-term">Cookie</span></a>). If you are
  2565. using the “cookie” auth_type, enter here a generated string of random bytes to be used as an encryption key. It
  2566. will be used internally by the <a class="reference internal" href="glossary.html#term-Sodium"><span class="xref std std-term">Sodium</span></a> extension: you won’t be prompted for this encryption key.</p>
  2567. <p>Since a binary string is usually not printable, it can be converted into a hexadecimal representation (using a
  2568. function like <a class="reference external" href="https://www.php.net/sodium_bin2hex">sodium_bin2hex</a>) and then used in the configuration file. For
  2569. example:</p>
  2570. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// The string is a hexadecimal representation of a 32-bytes long string of random bytes.</span>
  2571. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;blowfish_secret&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">sodium_hex2bin</span><span class="p">(</span><span class="s1">&#39;f16ce59f45714194371b48fe362072dc3b019da7861558cd4ad29e4d6fb13851&#39;</span><span class="p">);</span>
  2572. </pre></div>
  2573. </div>
  2574. <p>Using a binary string is recommended. However, if all 32 bytes of the string are visible
  2575. characters, then a function like <a class="reference external" href="https://www.php.net/sodium_bin2hex">sodium_bin2hex</a> is not required. For
  2576. example:</p>
  2577. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// A string of 32 characters.</span>
  2578. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;blowfish_secret&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;JOFw435365IScA&amp;Q!cDugr!lSfuAz*OW&#39;</span><span class="p">;</span>
  2579. </pre></div>
  2580. </div>
  2581. <div class="admonition warning">
  2582. <p class="admonition-title">Warning</p>
  2583. <p>The encryption key must be 32 bytes long. If it is longer than the length of bytes, only the first 32 bytes will
  2584. be used, and if it is shorter, a new temporary key will be automatically generated for you. However, this
  2585. temporary key will only last for the duration of the session.</p>
  2586. </div>
  2587. <div class="admonition note">
  2588. <p class="admonition-title">Note</p>
  2589. <p>The configuration is called blowfish_secret for historical reasons as
  2590. Blowfish algorithm was originally used to do the encryption.</p>
  2591. </div>
  2592. <div class="versionchanged">
  2593. <p><span class="versionmodified changed">Changed in version 3.1.0: </span>Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
  2594. makes a bit weaker security as this generated secret is stored in
  2595. session and furthermore it makes impossible to recall user name from
  2596. cookie.</p>
  2597. </div>
  2598. <div class="versionchanged">
  2599. <p><span class="versionmodified changed">Changed in version 5.2.0: </span>Since version 5.2.0, phpMyAdmin uses the
  2600. <a class="reference external" href="https://www.php.net/sodium_crypto_secretbox">sodium_crypto_secretbox</a> and
  2601. <a class="reference external" href="https://www.php.net/sodium_crypto_secretbox_open">sodium_crypto_secretbox_open</a> PHP functions to encrypt
  2602. and decrypt cookies, respectively.</p>
  2603. </div>
  2604. <div class="admonition seealso">
  2605. <p class="admonition-title">See also</p>
  2606. <p><a class="reference internal" href="faq.html#faq2-10"><span class="std std-ref">2.10 How to generate a string of random bytes</span></a></p>
  2607. </div>
  2608. </dd></dl>
  2609. <dl class="config option">
  2610. <dt class="sig sig-object config" id="cfg_CookieSameSite">
  2611. <span class="sig-name descname"><span class="pre">$cfg['CookieSameSite']</span></span><a class="headerlink" href="#cfg_CookieSameSite" title="Permalink to this definition">¶</a></dt>
  2612. <dd><dl class="field-list simple">
  2613. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2614. <dd class="field-odd"><p>string</p>
  2615. </dd>
  2616. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2617. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'Strict'</span></code></p>
  2618. </dd>
  2619. </dl>
  2620. <div class="versionadded">
  2621. <p><span class="versionmodified added">New in version 5.1.0.</span></p>
  2622. </div>
  2623. <p>It sets SameSite attribute of the Set-Cookie <a class="reference internal" href="glossary.html#term-HTTP"><span class="xref std std-term">HTTP</span></a> response header.
  2624. Valid values are:</p>
  2625. <ul class="simple">
  2626. <li><p><code class="docutils literal notranslate"><span class="pre">Lax</span></code></p></li>
  2627. <li><p><code class="docutils literal notranslate"><span class="pre">Strict</span></code></p></li>
  2628. <li><p><code class="docutils literal notranslate"><span class="pre">None</span></code></p></li>
  2629. </ul>
  2630. <div class="admonition seealso">
  2631. <p class="admonition-title">See also</p>
  2632. <p><a class="reference external" href="https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-rfc6265bis-03#section-5.3.7">rfc6265 bis</a></p>
  2633. </div>
  2634. </dd></dl>
  2635. <dl class="config option">
  2636. <dt class="sig sig-object config" id="cfg_LoginCookieRecall">
  2637. <span class="sig-name descname"><span class="pre">$cfg['LoginCookieRecall']</span></span><a class="headerlink" href="#cfg_LoginCookieRecall" title="Permalink to this definition">¶</a></dt>
  2638. <dd><dl class="field-list simple">
  2639. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2640. <dd class="field-odd"><p>boolean</p>
  2641. </dd>
  2642. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2643. <dd class="field-even"><p>true</p>
  2644. </dd>
  2645. </dl>
  2646. <p>Define whether the previous login should be recalled or not in cookie
  2647. authentication mode.</p>
  2648. <p>This is automatically disabled if you do not have
  2649. configured <span class="target" id="index-139"></span><a class="reference internal" href="#cfg_blowfish_secret"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['blowfish_secret']</span></code></a>.</p>
  2650. </dd></dl>
  2651. <dl class="config option">
  2652. <dt class="sig sig-object config" id="cfg_LoginCookieValidity">
  2653. <span class="sig-name descname"><span class="pre">$cfg['LoginCookieValidity']</span></span><a class="headerlink" href="#cfg_LoginCookieValidity" title="Permalink to this definition">¶</a></dt>
  2654. <dd><dl class="field-list simple">
  2655. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2656. <dd class="field-odd"><p>integer [number of seconds]</p>
  2657. </dd>
  2658. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2659. <dd class="field-even"><p>1440</p>
  2660. </dd>
  2661. </dl>
  2662. <p>Define how long a login cookie is valid. Please note that php
  2663. configuration option <a class="reference external" href="https://www.php.net/manual/en/session.configuration.php#ini.session.gc-maxlifetime">session.gc_maxlifetime</a> might limit session validity and if the session is lost,
  2664. the login cookie is also invalidated. So it is a good idea to set
  2665. <code class="docutils literal notranslate"><span class="pre">session.gc_maxlifetime</span></code> at least to the same value of
  2666. <span class="target" id="index-140"></span><a class="reference internal" href="#cfg_LoginCookieValidity"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['LoginCookieValidity']</span></code></a>.</p>
  2667. </dd></dl>
  2668. <dl class="config option">
  2669. <dt class="sig sig-object config" id="cfg_LoginCookieStore">
  2670. <span class="sig-name descname"><span class="pre">$cfg['LoginCookieStore']</span></span><a class="headerlink" href="#cfg_LoginCookieStore" title="Permalink to this definition">¶</a></dt>
  2671. <dd><dl class="field-list simple">
  2672. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2673. <dd class="field-odd"><p>integer [number of seconds]</p>
  2674. </dd>
  2675. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2676. <dd class="field-even"><p>0</p>
  2677. </dd>
  2678. </dl>
  2679. <p>Define how long login cookie should be stored in browser. Default 0
  2680. means that it will be kept for existing session. This is recommended
  2681. for not trusted environments.</p>
  2682. </dd></dl>
  2683. <dl class="config option">
  2684. <dt class="sig sig-object config" id="cfg_LoginCookieDeleteAll">
  2685. <span class="sig-name descname"><span class="pre">$cfg['LoginCookieDeleteAll']</span></span><a class="headerlink" href="#cfg_LoginCookieDeleteAll" title="Permalink to this definition">¶</a></dt>
  2686. <dd><dl class="field-list simple">
  2687. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2688. <dd class="field-odd"><p>boolean</p>
  2689. </dd>
  2690. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2691. <dd class="field-even"><p>true</p>
  2692. </dd>
  2693. </dl>
  2694. <p>If enabled (default), logout deletes cookies for all servers,
  2695. otherwise only for current one. Setting this to false makes it easy to
  2696. forget to log out from other server, when you are using more of them.</p>
  2697. </dd></dl>
  2698. <span class="target" id="allowarbitraryserver"></span><dl class="config option">
  2699. <dt class="sig sig-object config" id="cfg_AllowArbitraryServer">
  2700. <span class="sig-name descname"><span class="pre">$cfg['AllowArbitraryServer']</span></span><a class="headerlink" href="#cfg_AllowArbitraryServer" title="Permalink to this definition">¶</a></dt>
  2701. <dd><dl class="field-list simple">
  2702. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2703. <dd class="field-odd"><p>boolean</p>
  2704. </dd>
  2705. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2706. <dd class="field-even"><p>false</p>
  2707. </dd>
  2708. </dl>
  2709. <p>If enabled, allows you to log in to arbitrary servers using cookie
  2710. authentication.</p>
  2711. <div class="admonition note">
  2712. <p class="admonition-title">Note</p>
  2713. <p>Please use this carefully, as this may allow users access to MySQL servers
  2714. behind the firewall where your <a class="reference internal" href="glossary.html#term-HTTP"><span class="xref std std-term">HTTP</span></a> server is placed.
  2715. See also <span class="target" id="index-141"></span><a class="reference internal" href="#cfg_ArbitraryServerRegexp"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['ArbitraryServerRegexp']</span></code></a>.</p>
  2716. </div>
  2717. </dd></dl>
  2718. <dl class="config option">
  2719. <dt class="sig sig-object config" id="cfg_ArbitraryServerRegexp">
  2720. <span class="sig-name descname"><span class="pre">$cfg['ArbitraryServerRegexp']</span></span><a class="headerlink" href="#cfg_ArbitraryServerRegexp" title="Permalink to this definition">¶</a></dt>
  2721. <dd><dl class="field-list simple">
  2722. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2723. <dd class="field-odd"><p>string</p>
  2724. </dd>
  2725. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2726. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2727. </dd>
  2728. </dl>
  2729. <p>Restricts the MySQL servers to which the user can log in when
  2730. <span class="target" id="index-142"></span><a class="reference internal" href="#cfg_AllowArbitraryServer"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['AllowArbitraryServer']</span></code></a> is enabled by
  2731. matching the <a class="reference internal" href="glossary.html#term-IP"><span class="xref std std-term">IP</span></a> or the hostname of the MySQL server
  2732. to the given regular expression. The regular expression must be enclosed
  2733. with a delimiter character.</p>
  2734. <p>It is recommended to include start and end symbols in the regular
  2735. expression, so that you can avoid partial matches on the string.</p>
  2736. <p><strong>Examples:</strong></p>
  2737. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Allow connection to three listed servers:</span>
  2738. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;ArbitraryServerRegexp&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;/^(server|another|yetdifferent)$/&#39;</span><span class="p">;</span>
  2739. <span class="c1">// Allow connection to range of IP addresses:</span>
  2740. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;ArbitraryServerRegexp&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;@^192\.168\.0\.[0-9]{1,}$@&#39;</span><span class="p">;</span>
  2741. <span class="c1">// Allow connection to server name ending with -mysql:</span>
  2742. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;ArbitraryServerRegexp&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;@^[^:]\-mysql$@&#39;</span><span class="p">;</span>
  2743. </pre></div>
  2744. </div>
  2745. <div class="admonition note">
  2746. <p class="admonition-title">Note</p>
  2747. <p>The whole server name is matched, it can include port as well. Due to
  2748. way MySQL is permissive in connection parameters, it is possible to use
  2749. connection strings as <code class="docutils literal notranslate"><span class="pre">`server:3306-mysql`</span></code>. This can be used to
  2750. bypass regular expression by the suffix, while connecting to another
  2751. server.</p>
  2752. </div>
  2753. </dd></dl>
  2754. <dl class="config option">
  2755. <dt class="sig sig-object config" id="cfg_CaptchaMethod">
  2756. <span class="sig-name descname"><span class="pre">$cfg['CaptchaMethod']</span></span><a class="headerlink" href="#cfg_CaptchaMethod" title="Permalink to this definition">¶</a></dt>
  2757. <dd><dl class="field-list simple">
  2758. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2759. <dd class="field-odd"><p>string</p>
  2760. </dd>
  2761. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2762. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'invisible'</span></code></p>
  2763. </dd>
  2764. </dl>
  2765. <p>Valid values are:</p>
  2766. <ul class="simple">
  2767. <li><p><code class="docutils literal notranslate"><span class="pre">'invisible'</span></code> Use an invisible captcha checking method;</p></li>
  2768. <li><p><code class="docutils literal notranslate"><span class="pre">'checkbox'</span></code> Use a checkbox to confirm the user is not a robot.</p></li>
  2769. </ul>
  2770. <div class="versionadded">
  2771. <p><span class="versionmodified added">New in version 5.0.3.</span></p>
  2772. </div>
  2773. </dd></dl>
  2774. <dl class="config option">
  2775. <dt class="sig sig-object config" id="cfg_CaptchaApi">
  2776. <span class="sig-name descname"><span class="pre">$cfg['CaptchaApi']</span></span><a class="headerlink" href="#cfg_CaptchaApi" title="Permalink to this definition">¶</a></dt>
  2777. <dd><dl class="field-list simple">
  2778. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2779. <dd class="field-odd"><p>string</p>
  2780. </dd>
  2781. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2782. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'https://www.google.com/recaptcha/api.js'</span></code></p>
  2783. </dd>
  2784. </dl>
  2785. <div class="versionadded">
  2786. <p><span class="versionmodified added">New in version 5.1.0.</span></p>
  2787. </div>
  2788. <p>The URL for the reCaptcha v2 service’s API, either Google’s or a compatible one.</p>
  2789. </dd></dl>
  2790. <dl class="config option">
  2791. <dt class="sig sig-object config" id="cfg_CaptchaCsp">
  2792. <span class="sig-name descname"><span class="pre">$cfg['CaptchaCsp']</span></span><a class="headerlink" href="#cfg_CaptchaCsp" title="Permalink to this definition">¶</a></dt>
  2793. <dd><dl class="field-list simple">
  2794. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2795. <dd class="field-odd"><p>string</p>
  2796. </dd>
  2797. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2798. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'https://apis.google.com</span> <span class="pre">https://www.google.com/recaptcha/</span> <span class="pre">https://www.gstatic.com/recaptcha/</span> <span class="pre">https://ssl.gstatic.com/'</span></code></p>
  2799. </dd>
  2800. </dl>
  2801. <div class="versionadded">
  2802. <p><span class="versionmodified added">New in version 5.1.0.</span></p>
  2803. </div>
  2804. <p>The Content-Security-Policy snippet (URLs from which to allow embedded content)
  2805. for the reCaptcha v2 service, either Google’s or a compatible one.</p>
  2806. </dd></dl>
  2807. <dl class="config option">
  2808. <dt class="sig sig-object config" id="cfg_CaptchaRequestParam">
  2809. <span class="sig-name descname"><span class="pre">$cfg['CaptchaRequestParam']</span></span><a class="headerlink" href="#cfg_CaptchaRequestParam" title="Permalink to this definition">¶</a></dt>
  2810. <dd><dl class="field-list simple">
  2811. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2812. <dd class="field-odd"><p>string</p>
  2813. </dd>
  2814. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2815. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'g-recaptcha'</span></code></p>
  2816. </dd>
  2817. </dl>
  2818. <div class="versionadded">
  2819. <p><span class="versionmodified added">New in version 5.1.0.</span></p>
  2820. </div>
  2821. <p>The request parameter used for the reCaptcha v2 service.</p>
  2822. </dd></dl>
  2823. <dl class="config option">
  2824. <dt class="sig sig-object config" id="cfg_CaptchaResponseParam">
  2825. <span class="sig-name descname"><span class="pre">$cfg['CaptchaResponseParam']</span></span><a class="headerlink" href="#cfg_CaptchaResponseParam" title="Permalink to this definition">¶</a></dt>
  2826. <dd><dl class="field-list simple">
  2827. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2828. <dd class="field-odd"><p>string</p>
  2829. </dd>
  2830. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2831. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'g-recaptcha-response'</span></code></p>
  2832. </dd>
  2833. </dl>
  2834. <div class="versionadded">
  2835. <p><span class="versionmodified added">New in version 5.1.0.</span></p>
  2836. </div>
  2837. <p>The response parameter used for the reCaptcha v2 service.</p>
  2838. </dd></dl>
  2839. <dl class="config option">
  2840. <dt class="sig sig-object config" id="cfg_CaptchaLoginPublicKey">
  2841. <span class="sig-name descname"><span class="pre">$cfg['CaptchaLoginPublicKey']</span></span><a class="headerlink" href="#cfg_CaptchaLoginPublicKey" title="Permalink to this definition">¶</a></dt>
  2842. <dd><dl class="field-list simple">
  2843. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2844. <dd class="field-odd"><p>string</p>
  2845. </dd>
  2846. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2847. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2848. </dd>
  2849. </dl>
  2850. <p>The public key for the reCaptcha service that can be obtained from the
  2851. “Admin Console” on <a class="reference external" href="https://www.google.com/recaptcha/about/">https://www.google.com/recaptcha/about/</a>.</p>
  2852. <div class="admonition seealso">
  2853. <p class="admonition-title">See also</p>
  2854. <p>&lt;<a class="reference external" href="https://developers.google.com/recaptcha/docs/v3">https://developers.google.com/recaptcha/docs/v3</a>&gt;</p>
  2855. </div>
  2856. <p>reCaptcha will be then used in <a class="reference internal" href="setup.html#cookie"><span class="std std-ref">Cookie authentication mode</span></a>.</p>
  2857. <div class="versionadded">
  2858. <p><span class="versionmodified added">New in version 4.1.0.</span></p>
  2859. </div>
  2860. </dd></dl>
  2861. <dl class="config option">
  2862. <dt class="sig sig-object config" id="cfg_CaptchaLoginPrivateKey">
  2863. <span class="sig-name descname"><span class="pre">$cfg['CaptchaLoginPrivateKey']</span></span><a class="headerlink" href="#cfg_CaptchaLoginPrivateKey" title="Permalink to this definition">¶</a></dt>
  2864. <dd><dl class="field-list simple">
  2865. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2866. <dd class="field-odd"><p>string</p>
  2867. </dd>
  2868. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2869. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2870. </dd>
  2871. </dl>
  2872. <p>The private key for the reCaptcha service that can be obtained from the
  2873. “Admin Console” on <a class="reference external" href="https://www.google.com/recaptcha/about/">https://www.google.com/recaptcha/about/</a>.</p>
  2874. <div class="admonition seealso">
  2875. <p class="admonition-title">See also</p>
  2876. <p>&lt;<a class="reference external" href="https://developers.google.com/recaptcha/docs/v3">https://developers.google.com/recaptcha/docs/v3</a>&gt;</p>
  2877. </div>
  2878. <p>reCaptcha will be then used in <a class="reference internal" href="setup.html#cookie"><span class="std std-ref">Cookie authentication mode</span></a>.</p>
  2879. <div class="versionadded">
  2880. <p><span class="versionmodified added">New in version 4.1.0.</span></p>
  2881. </div>
  2882. </dd></dl>
  2883. <dl class="config option">
  2884. <dt class="sig sig-object config" id="cfg_CaptchaSiteVerifyURL">
  2885. <span class="sig-name descname"><span class="pre">$cfg['CaptchaSiteVerifyURL']</span></span><a class="headerlink" href="#cfg_CaptchaSiteVerifyURL" title="Permalink to this definition">¶</a></dt>
  2886. <dd><dl class="field-list simple">
  2887. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2888. <dd class="field-odd"><p>string</p>
  2889. </dd>
  2890. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2891. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  2892. </dd>
  2893. </dl>
  2894. <p>The URL for the reCaptcha service to do siteverify action.</p>
  2895. <p>reCaptcha will be then used in <a class="reference internal" href="setup.html#cookie"><span class="std std-ref">Cookie authentication mode</span></a>.</p>
  2896. <div class="versionadded">
  2897. <p><span class="versionmodified added">New in version 5.1.0.</span></p>
  2898. </div>
  2899. </dd></dl>
  2900. </section>
  2901. <section id="navigation-panel-setup">
  2902. <h2>Navigation panel setup<a class="headerlink" href="#navigation-panel-setup" title="Permalink to this heading">¶</a></h2>
  2903. <dl class="config option">
  2904. <dt class="sig sig-object config" id="cfg_ShowDatabasesNavigationAsTree">
  2905. <span class="sig-name descname"><span class="pre">$cfg['ShowDatabasesNavigationAsTree']</span></span><a class="headerlink" href="#cfg_ShowDatabasesNavigationAsTree" title="Permalink to this definition">¶</a></dt>
  2906. <dd><dl class="field-list simple">
  2907. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2908. <dd class="field-odd"><p>boolean</p>
  2909. </dd>
  2910. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2911. <dd class="field-even"><p>true</p>
  2912. </dd>
  2913. </dl>
  2914. <p>In the navigation panel, replaces the database tree with a selector</p>
  2915. </dd></dl>
  2916. <dl class="config option">
  2917. <dt class="sig sig-object config" id="cfg_FirstLevelNavigationItems">
  2918. <span class="sig-name descname"><span class="pre">$cfg['FirstLevelNavigationItems']</span></span><a class="headerlink" href="#cfg_FirstLevelNavigationItems" title="Permalink to this definition">¶</a></dt>
  2919. <dd><dl class="field-list simple">
  2920. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2921. <dd class="field-odd"><p>integer</p>
  2922. </dd>
  2923. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2924. <dd class="field-even"><p>100</p>
  2925. </dd>
  2926. </dl>
  2927. <p>The number of first level databases that can be displayed on each page
  2928. of navigation tree.</p>
  2929. </dd></dl>
  2930. <dl class="config option">
  2931. <dt class="sig sig-object config" id="cfg_MaxNavigationItems">
  2932. <span class="sig-name descname"><span class="pre">$cfg['MaxNavigationItems']</span></span><a class="headerlink" href="#cfg_MaxNavigationItems" title="Permalink to this definition">¶</a></dt>
  2933. <dd><dl class="field-list simple">
  2934. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2935. <dd class="field-odd"><p>integer</p>
  2936. </dd>
  2937. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2938. <dd class="field-even"><p>50</p>
  2939. </dd>
  2940. </dl>
  2941. <p>The number of items (tables, columns, indexes) that can be displayed on each
  2942. page of the navigation tree.</p>
  2943. </dd></dl>
  2944. <dl class="config option">
  2945. <dt class="sig sig-object config" id="cfg_NavigationTreeEnableGrouping">
  2946. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeEnableGrouping']</span></span><a class="headerlink" href="#cfg_NavigationTreeEnableGrouping" title="Permalink to this definition">¶</a></dt>
  2947. <dd><dl class="field-list simple">
  2948. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2949. <dd class="field-odd"><p>boolean</p>
  2950. </dd>
  2951. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2952. <dd class="field-even"><p>true</p>
  2953. </dd>
  2954. </dl>
  2955. <p>Defines whether to group the databases based on a common prefix
  2956. in their name <span class="target" id="index-143"></span><a class="reference internal" href="#cfg_NavigationTreeDbSeparator"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['NavigationTreeDbSeparator']</span></code></a>.</p>
  2957. </dd></dl>
  2958. <dl class="config option">
  2959. <dt class="sig sig-object config" id="cfg_NavigationTreeDbSeparator">
  2960. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeDbSeparator']</span></span><a class="headerlink" href="#cfg_NavigationTreeDbSeparator" title="Permalink to this definition">¶</a></dt>
  2961. <dd><dl class="field-list simple">
  2962. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2963. <dd class="field-odd"><p>string</p>
  2964. </dd>
  2965. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2966. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'_'</span></code></p>
  2967. </dd>
  2968. </dl>
  2969. <p>The string used to separate the parts of the database name when
  2970. showing them in a tree.</p>
  2971. </dd></dl>
  2972. <dl class="config option">
  2973. <dt class="sig sig-object config" id="cfg_NavigationTreeTableSeparator">
  2974. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeTableSeparator']</span></span><a class="headerlink" href="#cfg_NavigationTreeTableSeparator" title="Permalink to this definition">¶</a></dt>
  2975. <dd><dl class="field-list simple">
  2976. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2977. <dd class="field-odd"><p>string or array</p>
  2978. </dd>
  2979. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2980. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'__'</span></code></p>
  2981. </dd>
  2982. </dl>
  2983. <p>Defines a string to be used to nest table spaces. This means if you have
  2984. tables like <code class="docutils literal notranslate"><span class="pre">first__second__third</span></code> this will be shown as a three-level
  2985. hierarchy like: first &gt; second &gt; third. If set to false or empty, the
  2986. feature is disabled. NOTE: You should not use this separator at the
  2987. beginning or end of a table name or multiple times after another without
  2988. any other characters in between.</p>
  2989. </dd></dl>
  2990. <dl class="config option">
  2991. <dt class="sig sig-object config" id="cfg_NavigationTreeTableLevel">
  2992. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeTableLevel']</span></span><a class="headerlink" href="#cfg_NavigationTreeTableLevel" title="Permalink to this definition">¶</a></dt>
  2993. <dd><dl class="field-list simple">
  2994. <dt class="field-odd">Type<span class="colon">:</span></dt>
  2995. <dd class="field-odd"><p>integer</p>
  2996. </dd>
  2997. <dt class="field-even">Default value<span class="colon">:</span></dt>
  2998. <dd class="field-even"><p>1</p>
  2999. </dd>
  3000. </dl>
  3001. <p>Defines how many sublevels should be displayed when splitting up
  3002. tables by the above separator.</p>
  3003. </dd></dl>
  3004. <dl class="config option">
  3005. <dt class="sig sig-object config" id="cfg_NumRecentTables">
  3006. <span class="sig-name descname"><span class="pre">$cfg['NumRecentTables']</span></span><a class="headerlink" href="#cfg_NumRecentTables" title="Permalink to this definition">¶</a></dt>
  3007. <dd><dl class="field-list simple">
  3008. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3009. <dd class="field-odd"><p>integer</p>
  3010. </dd>
  3011. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3012. <dd class="field-even"><p>10</p>
  3013. </dd>
  3014. </dl>
  3015. <p>The maximum number of recently used tables shown in the navigation
  3016. panel. Set this to 0 (zero) to disable the listing of recent tables.</p>
  3017. </dd></dl>
  3018. <dl class="config option">
  3019. <dt class="sig sig-object config" id="cfg_NumFavoriteTables">
  3020. <span class="sig-name descname"><span class="pre">$cfg['NumFavoriteTables']</span></span><a class="headerlink" href="#cfg_NumFavoriteTables" title="Permalink to this definition">¶</a></dt>
  3021. <dd><dl class="field-list simple">
  3022. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3023. <dd class="field-odd"><p>integer</p>
  3024. </dd>
  3025. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3026. <dd class="field-even"><p>10</p>
  3027. </dd>
  3028. </dl>
  3029. <p>The maximum number of favorite tables shown in the navigation
  3030. panel. Set this to 0 (zero) to disable the listing of favorite tables.</p>
  3031. </dd></dl>
  3032. <dl class="config option">
  3033. <dt class="sig sig-object config" id="cfg_ZeroConf">
  3034. <span class="sig-name descname"><span class="pre">$cfg['ZeroConf']</span></span><a class="headerlink" href="#cfg_ZeroConf" title="Permalink to this definition">¶</a></dt>
  3035. <dd><dl class="field-list simple">
  3036. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3037. <dd class="field-odd"><p>boolean</p>
  3038. </dd>
  3039. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3040. <dd class="field-even"><p>true</p>
  3041. </dd>
  3042. </dl>
  3043. <p>Enables Zero Configuration mode in which the user will be offered a choice to
  3044. create phpMyAdmin configuration storage in the current database
  3045. or use the existing one, if already present.</p>
  3046. <p>This setting has no effect if the phpMyAdmin configuration storage database
  3047. is properly created and the related configuration directives (such as
  3048. <span class="target" id="index-144"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a> and so on) are configured.</p>
  3049. </dd></dl>
  3050. <dl class="config option">
  3051. <dt class="sig sig-object config" id="cfg_NavigationLinkWithMainPanel">
  3052. <span class="sig-name descname"><span class="pre">$cfg['NavigationLinkWithMainPanel']</span></span><a class="headerlink" href="#cfg_NavigationLinkWithMainPanel" title="Permalink to this definition">¶</a></dt>
  3053. <dd><dl class="field-list simple">
  3054. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3055. <dd class="field-odd"><p>boolean</p>
  3056. </dd>
  3057. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3058. <dd class="field-even"><p>true</p>
  3059. </dd>
  3060. </dl>
  3061. <p>Defines whether or not to link with main panel by highlighting
  3062. the current database or table.</p>
  3063. </dd></dl>
  3064. <dl class="config option">
  3065. <dt class="sig sig-object config" id="cfg_NavigationDisplayLogo">
  3066. <span class="sig-name descname"><span class="pre">$cfg['NavigationDisplayLogo']</span></span><a class="headerlink" href="#cfg_NavigationDisplayLogo" title="Permalink to this definition">¶</a></dt>
  3067. <dd><dl class="field-list simple">
  3068. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3069. <dd class="field-odd"><p>boolean</p>
  3070. </dd>
  3071. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3072. <dd class="field-even"><p>true</p>
  3073. </dd>
  3074. </dl>
  3075. <p>Defines whether or not to display the phpMyAdmin logo at the top of
  3076. the navigation panel.</p>
  3077. </dd></dl>
  3078. <dl class="config option">
  3079. <dt class="sig sig-object config" id="cfg_NavigationLogoLink">
  3080. <span class="sig-name descname"><span class="pre">$cfg['NavigationLogoLink']</span></span><a class="headerlink" href="#cfg_NavigationLogoLink" title="Permalink to this definition">¶</a></dt>
  3081. <dd><dl class="field-list simple">
  3082. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3083. <dd class="field-odd"><p>string</p>
  3084. </dd>
  3085. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3086. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'index.php'</span></code></p>
  3087. </dd>
  3088. </dl>
  3089. <p>Enter the <a class="reference internal" href="glossary.html#term-URL"><span class="xref std std-term">URL</span></a> where the logo in the navigation panel will point to.
  3090. For use especially with self made theme which changes this.
  3091. For relative/internal URLs, you need to have leading `` ./ `` or trailing characters `` ? `` such as <code class="docutils literal notranslate"><span class="pre">'./index.php?route=/server/sql?'</span></code>.
  3092. For external URLs, you should include URL protocol schemes (<code class="docutils literal notranslate"><span class="pre">http</span></code> or <code class="docutils literal notranslate"><span class="pre">https</span></code>) with absolute URLs.</p>
  3093. <p>You may want to make the link open in a new browser tab, for that you need to use <span class="target" id="index-145"></span><a class="reference internal" href="#cfg_NavigationLogoLinkWindow"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['NavigationLogoLinkWindow']</span></code></a></p>
  3094. </dd></dl>
  3095. <dl class="config option">
  3096. <dt class="sig sig-object config" id="cfg_NavigationLogoLinkWindow">
  3097. <span class="sig-name descname"><span class="pre">$cfg['NavigationLogoLinkWindow']</span></span><a class="headerlink" href="#cfg_NavigationLogoLinkWindow" title="Permalink to this definition">¶</a></dt>
  3098. <dd><dl class="field-list simple">
  3099. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3100. <dd class="field-odd"><p>string</p>
  3101. </dd>
  3102. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3103. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'main'</span></code></p>
  3104. </dd>
  3105. </dl>
  3106. <p>Whether to open the linked page in the main window (<code class="docutils literal notranslate"><span class="pre">main</span></code>) or in a
  3107. new one (<code class="docutils literal notranslate"><span class="pre">new</span></code>). Note: use <code class="docutils literal notranslate"><span class="pre">new</span></code> if you are linking to
  3108. <code class="docutils literal notranslate"><span class="pre">phpmyadmin.net</span></code>.</p>
  3109. <p>To open the link in the main window you will need to add the value of <span class="target" id="index-146"></span><a class="reference internal" href="#cfg_NavigationLogoLink"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['NavigationLogoLink']</span></code></a>
  3110. to <span class="target" id="index-147"></span><a class="reference internal" href="#cfg_CSPAllow"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['CSPAllow']</span></code></a> because of the <a class="reference internal" href="glossary.html#term-Content-Security-Policy"><span class="xref std std-term">Content Security Policy</span></a> header.</p>
  3111. </dd></dl>
  3112. <dl class="config option">
  3113. <dt class="sig sig-object config" id="cfg_NavigationTreeDisplayItemFilterMinimum">
  3114. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeDisplayItemFilterMinimum']</span></span><a class="headerlink" href="#cfg_NavigationTreeDisplayItemFilterMinimum" title="Permalink to this definition">¶</a></dt>
  3115. <dd><dl class="field-list simple">
  3116. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3117. <dd class="field-odd"><p>integer</p>
  3118. </dd>
  3119. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3120. <dd class="field-even"><p>30</p>
  3121. </dd>
  3122. </dl>
  3123. <p>Defines the minimum number of items (tables, views, routines and
  3124. events) to display a JavaScript filter box above the list of items in
  3125. the navigation tree.</p>
  3126. <p>To disable the filter completely some high number can be used (e.g. 9999)</p>
  3127. </dd></dl>
  3128. <dl class="config option">
  3129. <dt class="sig sig-object config" id="cfg_NavigationTreeDisplayDbFilterMinimum">
  3130. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeDisplayDbFilterMinimum']</span></span><a class="headerlink" href="#cfg_NavigationTreeDisplayDbFilterMinimum" title="Permalink to this definition">¶</a></dt>
  3131. <dd><dl class="field-list simple">
  3132. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3133. <dd class="field-odd"><p>integer</p>
  3134. </dd>
  3135. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3136. <dd class="field-even"><p>30</p>
  3137. </dd>
  3138. </dl>
  3139. <p>Defines the minimum number of databases to display a JavaScript filter
  3140. box above the list of databases in the navigation tree.</p>
  3141. <p>To disable the filter completely some high number can be used
  3142. (e.g. 9999)</p>
  3143. </dd></dl>
  3144. <dl class="config option">
  3145. <dt class="sig sig-object config" id="cfg_NavigationDisplayServers">
  3146. <span class="sig-name descname"><span class="pre">$cfg['NavigationDisplayServers']</span></span><a class="headerlink" href="#cfg_NavigationDisplayServers" title="Permalink to this definition">¶</a></dt>
  3147. <dd><dl class="field-list simple">
  3148. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3149. <dd class="field-odd"><p>boolean</p>
  3150. </dd>
  3151. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3152. <dd class="field-even"><p>true</p>
  3153. </dd>
  3154. </dl>
  3155. <p>Defines whether or not to display a server choice at the top of the
  3156. navigation panel.</p>
  3157. </dd></dl>
  3158. <dl class="config option">
  3159. <dt class="sig sig-object config" id="cfg_DisplayServersList">
  3160. <span class="sig-name descname"><span class="pre">$cfg['DisplayServersList']</span></span><a class="headerlink" href="#cfg_DisplayServersList" title="Permalink to this definition">¶</a></dt>
  3161. <dd><dl class="field-list simple">
  3162. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3163. <dd class="field-odd"><p>boolean</p>
  3164. </dd>
  3165. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3166. <dd class="field-even"><p>false</p>
  3167. </dd>
  3168. </dl>
  3169. <p>Defines whether to display this server choice as links instead of in a
  3170. drop-down.</p>
  3171. </dd></dl>
  3172. <dl class="config option">
  3173. <dt class="sig sig-object config" id="cfg_NavigationTreeDefaultTabTable">
  3174. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeDefaultTabTable']</span></span><a class="headerlink" href="#cfg_NavigationTreeDefaultTabTable" title="Permalink to this definition">¶</a></dt>
  3175. <dd><dl class="field-list simple">
  3176. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3177. <dd class="field-odd"><p>string</p>
  3178. </dd>
  3179. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3180. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'structure'</span></code></p>
  3181. </dd>
  3182. </dl>
  3183. <p>Defines the tab displayed by default when clicking the small icon next
  3184. to each table name in the navigation panel. The possible values are the
  3185. localized equivalent of:</p>
  3186. <ul class="simple">
  3187. <li><p><code class="docutils literal notranslate"><span class="pre">structure</span></code></p></li>
  3188. <li><p><code class="docutils literal notranslate"><span class="pre">sql</span></code></p></li>
  3189. <li><p><code class="docutils literal notranslate"><span class="pre">search</span></code></p></li>
  3190. <li><p><code class="docutils literal notranslate"><span class="pre">insert</span></code></p></li>
  3191. <li><p><code class="docutils literal notranslate"><span class="pre">browse</span></code></p></li>
  3192. </ul>
  3193. </dd></dl>
  3194. <dl class="config option">
  3195. <dt class="sig sig-object config" id="cfg_NavigationTreeDefaultTabTable2">
  3196. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeDefaultTabTable2']</span></span><a class="headerlink" href="#cfg_NavigationTreeDefaultTabTable2" title="Permalink to this definition">¶</a></dt>
  3197. <dd><dl class="field-list simple">
  3198. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3199. <dd class="field-odd"><p>string</p>
  3200. </dd>
  3201. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3202. <dd class="field-even"><p>null</p>
  3203. </dd>
  3204. </dl>
  3205. <p>Defines the tab displayed by default when clicking the second small icon next
  3206. to each table name in the navigation panel. The possible values are the
  3207. localized equivalent of:</p>
  3208. <ul class="simple">
  3209. <li><p><code class="docutils literal notranslate"><span class="pre">(empty)</span></code></p></li>
  3210. <li><p><code class="docutils literal notranslate"><span class="pre">structure</span></code></p></li>
  3211. <li><p><code class="docutils literal notranslate"><span class="pre">sql</span></code></p></li>
  3212. <li><p><code class="docutils literal notranslate"><span class="pre">search</span></code></p></li>
  3213. <li><p><code class="docutils literal notranslate"><span class="pre">insert</span></code></p></li>
  3214. <li><p><code class="docutils literal notranslate"><span class="pre">browse</span></code></p></li>
  3215. </ul>
  3216. </dd></dl>
  3217. <dl class="config option">
  3218. <dt class="sig sig-object config" id="cfg_NavigationTreeEnableExpansion">
  3219. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeEnableExpansion']</span></span><a class="headerlink" href="#cfg_NavigationTreeEnableExpansion" title="Permalink to this definition">¶</a></dt>
  3220. <dd><dl class="field-list simple">
  3221. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3222. <dd class="field-odd"><p>boolean</p>
  3223. </dd>
  3224. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3225. <dd class="field-even"><p>true</p>
  3226. </dd>
  3227. </dl>
  3228. <p>Whether to offer the possibility of tree expansion in the navigation panel.</p>
  3229. </dd></dl>
  3230. <dl class="config option">
  3231. <dt class="sig sig-object config" id="cfg_NavigationTreeShowTables">
  3232. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeShowTables']</span></span><a class="headerlink" href="#cfg_NavigationTreeShowTables" title="Permalink to this definition">¶</a></dt>
  3233. <dd><dl class="field-list simple">
  3234. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3235. <dd class="field-odd"><p>boolean</p>
  3236. </dd>
  3237. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3238. <dd class="field-even"><p>true</p>
  3239. </dd>
  3240. </dl>
  3241. <p>Whether to show tables under database in the navigation panel.</p>
  3242. </dd></dl>
  3243. <dl class="config option">
  3244. <dt class="sig sig-object config" id="cfg_NavigationTreeShowViews">
  3245. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeShowViews']</span></span><a class="headerlink" href="#cfg_NavigationTreeShowViews" title="Permalink to this definition">¶</a></dt>
  3246. <dd><dl class="field-list simple">
  3247. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3248. <dd class="field-odd"><p>boolean</p>
  3249. </dd>
  3250. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3251. <dd class="field-even"><p>true</p>
  3252. </dd>
  3253. </dl>
  3254. <p>Whether to show views under database in the navigation panel.</p>
  3255. </dd></dl>
  3256. <dl class="config option">
  3257. <dt class="sig sig-object config" id="cfg_NavigationTreeShowFunctions">
  3258. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeShowFunctions']</span></span><a class="headerlink" href="#cfg_NavigationTreeShowFunctions" title="Permalink to this definition">¶</a></dt>
  3259. <dd><dl class="field-list simple">
  3260. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3261. <dd class="field-odd"><p>boolean</p>
  3262. </dd>
  3263. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3264. <dd class="field-even"><p>true</p>
  3265. </dd>
  3266. </dl>
  3267. <p>Whether to show functions under database in the navigation panel.</p>
  3268. </dd></dl>
  3269. <dl class="config option">
  3270. <dt class="sig sig-object config" id="cfg_NavigationTreeShowProcedures">
  3271. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeShowProcedures']</span></span><a class="headerlink" href="#cfg_NavigationTreeShowProcedures" title="Permalink to this definition">¶</a></dt>
  3272. <dd><dl class="field-list simple">
  3273. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3274. <dd class="field-odd"><p>boolean</p>
  3275. </dd>
  3276. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3277. <dd class="field-even"><p>true</p>
  3278. </dd>
  3279. </dl>
  3280. <p>Whether to show procedures under database in the navigation panel.</p>
  3281. </dd></dl>
  3282. <dl class="config option">
  3283. <dt class="sig sig-object config" id="cfg_NavigationTreeShowEvents">
  3284. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeShowEvents']</span></span><a class="headerlink" href="#cfg_NavigationTreeShowEvents" title="Permalink to this definition">¶</a></dt>
  3285. <dd><dl class="field-list simple">
  3286. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3287. <dd class="field-odd"><p>boolean</p>
  3288. </dd>
  3289. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3290. <dd class="field-even"><p>true</p>
  3291. </dd>
  3292. </dl>
  3293. <p>Whether to show events under database in the navigation panel.</p>
  3294. </dd></dl>
  3295. <dl class="config option">
  3296. <dt class="sig sig-object config" id="cfg_NavigationTreeAutoexpandSingleDb">
  3297. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreeAutoexpandSingleDb']</span></span><a class="headerlink" href="#cfg_NavigationTreeAutoexpandSingleDb" title="Permalink to this definition">¶</a></dt>
  3298. <dd><dl class="field-list simple">
  3299. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3300. <dd class="field-odd"><p>boolean</p>
  3301. </dd>
  3302. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3303. <dd class="field-even"><p>true</p>
  3304. </dd>
  3305. </dl>
  3306. <p>Whether to expand single database in the navigation tree automatically.</p>
  3307. </dd></dl>
  3308. <dl class="config option">
  3309. <dt class="sig sig-object config" id="cfg_NavigationWidth">
  3310. <span class="sig-name descname"><span class="pre">$cfg['NavigationWidth']</span></span><a class="headerlink" href="#cfg_NavigationWidth" title="Permalink to this definition">¶</a></dt>
  3311. <dd><dl class="field-list simple">
  3312. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3313. <dd class="field-odd"><p>integer</p>
  3314. </dd>
  3315. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3316. <dd class="field-even"><p>240</p>
  3317. </dd>
  3318. </dl>
  3319. <p>Navigation panel width, set to 0 to collapse it by default.</p>
  3320. </dd></dl>
  3321. </section>
  3322. <section id="main-panel">
  3323. <h2>Main panel<a class="headerlink" href="#main-panel" title="Permalink to this heading">¶</a></h2>
  3324. <dl class="config option">
  3325. <dt class="sig sig-object config" id="cfg_ShowStats">
  3326. <span class="sig-name descname"><span class="pre">$cfg['ShowStats']</span></span><a class="headerlink" href="#cfg_ShowStats" title="Permalink to this definition">¶</a></dt>
  3327. <dd><dl class="field-list simple">
  3328. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3329. <dd class="field-odd"><p>boolean</p>
  3330. </dd>
  3331. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3332. <dd class="field-even"><p>true</p>
  3333. </dd>
  3334. </dl>
  3335. <p>Defines whether or not to display space usage and statistics about
  3336. databases and tables. Note that statistics requires at least MySQL
  3337. 3.23.3 and that, at this date, MySQL doesn’t return such information
  3338. for Berkeley DB tables.</p>
  3339. </dd></dl>
  3340. <dl class="config option">
  3341. <dt class="sig sig-object config" id="cfg_ShowServerInfo">
  3342. <span class="sig-name descname"><span class="pre">$cfg['ShowServerInfo']</span></span><a class="headerlink" href="#cfg_ShowServerInfo" title="Permalink to this definition">¶</a></dt>
  3343. <dd><dl class="field-list simple">
  3344. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3345. <dd class="field-odd"><p>boolean</p>
  3346. </dd>
  3347. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3348. <dd class="field-even"><p>true</p>
  3349. </dd>
  3350. </dl>
  3351. <p>Defines whether to display detailed server information on main page.
  3352. You can additionally hide more information by using
  3353. <span class="target" id="index-148"></span><a class="reference internal" href="#cfg_Servers_verbose"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['verbose']</span></code></a>.</p>
  3354. </dd></dl>
  3355. <dl class="config option">
  3356. <dt class="sig sig-object config" id="cfg_ShowPhpInfo">
  3357. <span class="sig-name descname"><span class="pre">$cfg['ShowPhpInfo']</span></span><a class="headerlink" href="#cfg_ShowPhpInfo" title="Permalink to this definition">¶</a></dt>
  3358. <dd><dl class="field-list simple">
  3359. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3360. <dd class="field-odd"><p>boolean</p>
  3361. </dd>
  3362. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3363. <dd class="field-even"><p>false</p>
  3364. </dd>
  3365. </dl>
  3366. <p>Defines whether to display the <span class="guilabel">PHP information</span> or not at
  3367. the starting main (right) frame.</p>
  3368. <p>Please note that to block the usage of <code class="docutils literal notranslate"><span class="pre">phpinfo()</span></code> in scripts, you have to
  3369. put this in your <code class="file docutils literal notranslate"><span class="pre">php.ini</span></code>:</p>
  3370. <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="na">disable_functions</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">phpinfo()</span>
  3371. </pre></div>
  3372. </div>
  3373. <div class="admonition warning">
  3374. <p class="admonition-title">Warning</p>
  3375. <p>Enabling phpinfo page will leak quite a lot of information about server
  3376. setup. Is it not recommended to enable this on shared installations.</p>
  3377. <p>This might also make easier some remote attacks on your installations,
  3378. so enable this only when needed.</p>
  3379. </div>
  3380. </dd></dl>
  3381. <dl class="config option">
  3382. <dt class="sig sig-object config" id="cfg_ShowChgPassword">
  3383. <span class="sig-name descname"><span class="pre">$cfg['ShowChgPassword']</span></span><a class="headerlink" href="#cfg_ShowChgPassword" title="Permalink to this definition">¶</a></dt>
  3384. <dd><dl class="field-list simple">
  3385. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3386. <dd class="field-odd"><p>boolean</p>
  3387. </dd>
  3388. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3389. <dd class="field-even"><p>true</p>
  3390. </dd>
  3391. </dl>
  3392. <p>Defines whether to display the <span class="guilabel">Change password</span> link or not at
  3393. the starting main (right) frame. This setting does not check MySQL commands
  3394. entered directly.</p>
  3395. <p>Please note that enabling the <span class="guilabel">Change password</span> link has no effect
  3396. with config authentication mode: because of the hard coded password value
  3397. in the configuration file, end users can’t be allowed to change their
  3398. passwords.</p>
  3399. </dd></dl>
  3400. <dl class="config option">
  3401. <dt class="sig sig-object config" id="cfg_ShowCreateDb">
  3402. <span class="sig-name descname"><span class="pre">$cfg['ShowCreateDb']</span></span><a class="headerlink" href="#cfg_ShowCreateDb" title="Permalink to this definition">¶</a></dt>
  3403. <dd><dl class="field-list simple">
  3404. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3405. <dd class="field-odd"><p>boolean</p>
  3406. </dd>
  3407. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3408. <dd class="field-even"><p>true</p>
  3409. </dd>
  3410. </dl>
  3411. <p>Defines whether to display the form for creating database or not at the
  3412. starting main (right) frame. This setting does not check MySQL commands
  3413. entered directly.</p>
  3414. </dd></dl>
  3415. <dl class="config option">
  3416. <dt class="sig sig-object config" id="cfg_ShowGitRevision">
  3417. <span class="sig-name descname"><span class="pre">$cfg['ShowGitRevision']</span></span><a class="headerlink" href="#cfg_ShowGitRevision" title="Permalink to this definition">¶</a></dt>
  3418. <dd><dl class="field-list simple">
  3419. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3420. <dd class="field-odd"><p>boolean</p>
  3421. </dd>
  3422. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3423. <dd class="field-even"><p>true</p>
  3424. </dd>
  3425. </dl>
  3426. <p>Defines whether to display information about the current Git revision (if
  3427. applicable) on the main panel.</p>
  3428. </dd></dl>
  3429. <dl class="config option">
  3430. <dt class="sig sig-object config" id="cfg_MysqlMinVersion">
  3431. <span class="sig-name descname"><span class="pre">$cfg['MysqlMinVersion']</span></span><a class="headerlink" href="#cfg_MysqlMinVersion" title="Permalink to this definition">¶</a></dt>
  3432. <dd><dl class="field-list simple">
  3433. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3434. <dd class="field-odd"><p>array</p>
  3435. </dd>
  3436. </dl>
  3437. <p>Defines the minimum supported MySQL version. The default is chosen
  3438. by the phpMyAdmin team; however this directive was asked by a developer
  3439. of the Plesk control panel to ease integration with older MySQL servers
  3440. (where most of the phpMyAdmin features work).</p>
  3441. </dd></dl>
  3442. </section>
  3443. <section id="database-structure">
  3444. <h2>Database structure<a class="headerlink" href="#database-structure" title="Permalink to this heading">¶</a></h2>
  3445. <dl class="config option">
  3446. <dt class="sig sig-object config" id="cfg_ShowDbStructureCharset">
  3447. <span class="sig-name descname"><span class="pre">$cfg['ShowDbStructureCharset']</span></span><a class="headerlink" href="#cfg_ShowDbStructureCharset" title="Permalink to this definition">¶</a></dt>
  3448. <dd><dl class="field-list simple">
  3449. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3450. <dd class="field-odd"><p>boolean</p>
  3451. </dd>
  3452. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3453. <dd class="field-even"><p>false</p>
  3454. </dd>
  3455. </dl>
  3456. <p>Defines whether to show a column displaying the charset for all tables in the database structure page.</p>
  3457. </dd></dl>
  3458. <dl class="config option">
  3459. <dt class="sig sig-object config" id="cfg_ShowDbStructureComment">
  3460. <span class="sig-name descname"><span class="pre">$cfg['ShowDbStructureComment']</span></span><a class="headerlink" href="#cfg_ShowDbStructureComment" title="Permalink to this definition">¶</a></dt>
  3461. <dd><dl class="field-list simple">
  3462. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3463. <dd class="field-odd"><p>boolean</p>
  3464. </dd>
  3465. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3466. <dd class="field-even"><p>false</p>
  3467. </dd>
  3468. </dl>
  3469. <p>Defines whether to show a column displaying the comments for all tables in the database structure page.</p>
  3470. </dd></dl>
  3471. <dl class="config option">
  3472. <dt class="sig sig-object config" id="cfg_ShowDbStructureCreation">
  3473. <span class="sig-name descname"><span class="pre">$cfg['ShowDbStructureCreation']</span></span><a class="headerlink" href="#cfg_ShowDbStructureCreation" title="Permalink to this definition">¶</a></dt>
  3474. <dd><dl class="field-list simple">
  3475. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3476. <dd class="field-odd"><p>boolean</p>
  3477. </dd>
  3478. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3479. <dd class="field-even"><p>false</p>
  3480. </dd>
  3481. </dl>
  3482. <p>Defines whether the database structure page (tables list) has a
  3483. “Creation” column that displays when each table was created.</p>
  3484. </dd></dl>
  3485. <dl class="config option">
  3486. <dt class="sig sig-object config" id="cfg_ShowDbStructureLastUpdate">
  3487. <span class="sig-name descname"><span class="pre">$cfg['ShowDbStructureLastUpdate']</span></span><a class="headerlink" href="#cfg_ShowDbStructureLastUpdate" title="Permalink to this definition">¶</a></dt>
  3488. <dd><dl class="field-list simple">
  3489. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3490. <dd class="field-odd"><p>boolean</p>
  3491. </dd>
  3492. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3493. <dd class="field-even"><p>false</p>
  3494. </dd>
  3495. </dl>
  3496. <p>Defines whether the database structure page (tables list) has a “Last
  3497. update” column that displays when each table was last updated.</p>
  3498. </dd></dl>
  3499. <dl class="config option">
  3500. <dt class="sig sig-object config" id="cfg_ShowDbStructureLastCheck">
  3501. <span class="sig-name descname"><span class="pre">$cfg['ShowDbStructureLastCheck']</span></span><a class="headerlink" href="#cfg_ShowDbStructureLastCheck" title="Permalink to this definition">¶</a></dt>
  3502. <dd><dl class="field-list simple">
  3503. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3504. <dd class="field-odd"><p>boolean</p>
  3505. </dd>
  3506. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3507. <dd class="field-even"><p>false</p>
  3508. </dd>
  3509. </dl>
  3510. <p>Defines whether the database structure page (tables list) has a “Last
  3511. check” column that displays when each table was last checked.</p>
  3512. </dd></dl>
  3513. <dl class="config option">
  3514. <dt class="sig sig-object config" id="cfg_HideStructureActions">
  3515. <span class="sig-name descname"><span class="pre">$cfg['HideStructureActions']</span></span><a class="headerlink" href="#cfg_HideStructureActions" title="Permalink to this definition">¶</a></dt>
  3516. <dd><dl class="field-list simple">
  3517. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3518. <dd class="field-odd"><p>boolean</p>
  3519. </dd>
  3520. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3521. <dd class="field-even"><p>true</p>
  3522. </dd>
  3523. </dl>
  3524. <p>Defines whether the table structure actions are hidden under a “<span class="guilabel">More</span>”
  3525. drop-down.</p>
  3526. </dd></dl>
  3527. <dl class="config option">
  3528. <dt class="sig sig-object config" id="cfg_ShowColumnComments">
  3529. <span class="sig-name descname"><span class="pre">$cfg['ShowColumnComments']</span></span><a class="headerlink" href="#cfg_ShowColumnComments" title="Permalink to this definition">¶</a></dt>
  3530. <dd><dl class="field-list simple">
  3531. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3532. <dd class="field-odd"><p>boolean</p>
  3533. </dd>
  3534. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3535. <dd class="field-even"><p>true</p>
  3536. </dd>
  3537. </dl>
  3538. <p>Defines whether to show column comments as a column in the table structure view.</p>
  3539. </dd></dl>
  3540. </section>
  3541. <section id="browse-mode">
  3542. <h2>Browse mode<a class="headerlink" href="#browse-mode" title="Permalink to this heading">¶</a></h2>
  3543. <dl class="config option">
  3544. <dt class="sig sig-object config" id="cfg_TableNavigationLinksMode">
  3545. <span class="sig-name descname"><span class="pre">$cfg['TableNavigationLinksMode']</span></span><a class="headerlink" href="#cfg_TableNavigationLinksMode" title="Permalink to this definition">¶</a></dt>
  3546. <dd><dl class="field-list simple">
  3547. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3548. <dd class="field-odd"><p>string</p>
  3549. </dd>
  3550. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3551. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'icons'</span></code></p>
  3552. </dd>
  3553. </dl>
  3554. <p>Defines whether the table navigation links contain <code class="docutils literal notranslate"><span class="pre">'icons'</span></code>, <code class="docutils literal notranslate"><span class="pre">'text'</span></code>
  3555. or <code class="docutils literal notranslate"><span class="pre">'both'</span></code>.</p>
  3556. </dd></dl>
  3557. <dl class="config option">
  3558. <dt class="sig sig-object config" id="cfg_ActionLinksMode">
  3559. <span class="sig-name descname"><span class="pre">$cfg['ActionLinksMode']</span></span><a class="headerlink" href="#cfg_ActionLinksMode" title="Permalink to this definition">¶</a></dt>
  3560. <dd><dl class="field-list simple">
  3561. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3562. <dd class="field-odd"><p>string</p>
  3563. </dd>
  3564. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3565. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'both'</span></code></p>
  3566. </dd>
  3567. </dl>
  3568. <p>If set to <code class="docutils literal notranslate"><span class="pre">icons</span></code>, will display icons instead of text for db and table
  3569. properties links (like <span class="guilabel">Browse</span>, <span class="guilabel">Select</span>,
  3570. <span class="guilabel">Insert</span>, …). Can be set to <code class="docutils literal notranslate"><span class="pre">'both'</span></code>
  3571. if you want icons AND text. When set to <code class="docutils literal notranslate"><span class="pre">text</span></code>, will only show text.</p>
  3572. </dd></dl>
  3573. <dl class="config option">
  3574. <dt class="sig sig-object config" id="cfg_RowActionType">
  3575. <span class="sig-name descname"><span class="pre">$cfg['RowActionType']</span></span><a class="headerlink" href="#cfg_RowActionType" title="Permalink to this definition">¶</a></dt>
  3576. <dd><dl class="field-list simple">
  3577. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3578. <dd class="field-odd"><p>string</p>
  3579. </dd>
  3580. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3581. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'both'</span></code></p>
  3582. </dd>
  3583. </dl>
  3584. <p>Whether to display icons or text or both icons and text in table row action
  3585. segment. Value can be either of <code class="docutils literal notranslate"><span class="pre">'icons'</span></code>, <code class="docutils literal notranslate"><span class="pre">'text'</span></code> or <code class="docutils literal notranslate"><span class="pre">'both'</span></code>.</p>
  3586. </dd></dl>
  3587. <dl class="config option">
  3588. <dt class="sig sig-object config" id="cfg_ShowAll">
  3589. <span class="sig-name descname"><span class="pre">$cfg['ShowAll']</span></span><a class="headerlink" href="#cfg_ShowAll" title="Permalink to this definition">¶</a></dt>
  3590. <dd><dl class="field-list simple">
  3591. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3592. <dd class="field-odd"><p>boolean</p>
  3593. </dd>
  3594. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3595. <dd class="field-even"><p>false</p>
  3596. </dd>
  3597. </dl>
  3598. <p>Defines whether a user should be displayed a “<span class="guilabel">Show all</span>” button in browse
  3599. mode or not in all cases. By default it is shown only on small tables (less
  3600. than 500 rows) to avoid performance issues while getting too many rows.</p>
  3601. </dd></dl>
  3602. <dl class="config option">
  3603. <dt class="sig sig-object config" id="cfg_MaxRows">
  3604. <span class="sig-name descname"><span class="pre">$cfg['MaxRows']</span></span><a class="headerlink" href="#cfg_MaxRows" title="Permalink to this definition">¶</a></dt>
  3605. <dd><dl class="field-list simple">
  3606. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3607. <dd class="field-odd"><p>integer</p>
  3608. </dd>
  3609. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3610. <dd class="field-even"><p>25</p>
  3611. </dd>
  3612. </dl>
  3613. <p>Number of rows displayed when browsing a result set and no LIMIT
  3614. clause is used. If the result set contains more rows, “<span class="guilabel">Previous</span>” and
  3615. “<span class="guilabel">Next</span>” links will be shown. Possible values: 25,50,100,250,500.</p>
  3616. </dd></dl>
  3617. <dl class="config option">
  3618. <dt class="sig sig-object config" id="cfg_Order">
  3619. <span class="sig-name descname"><span class="pre">$cfg['Order']</span></span><a class="headerlink" href="#cfg_Order" title="Permalink to this definition">¶</a></dt>
  3620. <dd><dl class="field-list simple">
  3621. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3622. <dd class="field-odd"><p>string</p>
  3623. </dd>
  3624. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3625. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'SMART'</span></code></p>
  3626. </dd>
  3627. </dl>
  3628. <p>Defines whether columns are displayed in ascending (<code class="docutils literal notranslate"><span class="pre">ASC</span></code>) order, in
  3629. descending (<code class="docutils literal notranslate"><span class="pre">DESC</span></code>) order or in a “smart” (<code class="docutils literal notranslate"><span class="pre">SMART</span></code>) order - I.E.
  3630. descending order for columns of type TIME, DATE, DATETIME and
  3631. TIMESTAMP, ascending order else- by default.</p>
  3632. <div class="versionchanged">
  3633. <p><span class="versionmodified changed">Changed in version 3.4.0: </span>Since phpMyAdmin 3.4.0 the default value is <code class="docutils literal notranslate"><span class="pre">'SMART'</span></code>.</p>
  3634. </div>
  3635. </dd></dl>
  3636. <dl class="config option">
  3637. <dt class="sig sig-object config" id="cfg_DisplayBinaryAsHex">
  3638. <span class="sig-name descname"><span class="pre">$cfg['DisplayBinaryAsHex']</span></span><a class="headerlink" href="#cfg_DisplayBinaryAsHex" title="Permalink to this definition">¶</a></dt>
  3639. <dd><dl class="field-list simple">
  3640. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3641. <dd class="field-odd"><p>boolean</p>
  3642. </dd>
  3643. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3644. <dd class="field-even"><p>true</p>
  3645. </dd>
  3646. </dl>
  3647. <p>Defines whether the “<span class="guilabel">Show binary contents as HEX</span>” browse option is
  3648. ticked by default.</p>
  3649. <div class="versionadded">
  3650. <p><span class="versionmodified added">New in version 3.3.0.</span></p>
  3651. </div>
  3652. <div class="deprecated">
  3653. <p><span class="versionmodified deprecated">Deprecated since version 4.3.0: </span>This setting was removed.</p>
  3654. </div>
  3655. </dd></dl>
  3656. <dl class="config option">
  3657. <dt class="sig sig-object config" id="cfg_GridEditing">
  3658. <span class="sig-name descname"><span class="pre">$cfg['GridEditing']</span></span><a class="headerlink" href="#cfg_GridEditing" title="Permalink to this definition">¶</a></dt>
  3659. <dd><dl class="field-list simple">
  3660. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3661. <dd class="field-odd"><p>string</p>
  3662. </dd>
  3663. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3664. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'double-click'</span></code></p>
  3665. </dd>
  3666. </dl>
  3667. <p>Defines which action (<code class="docutils literal notranslate"><span class="pre">double-click</span></code> or <code class="docutils literal notranslate"><span class="pre">click</span></code>) triggers grid
  3668. editing. Can be deactivated with the <code class="docutils literal notranslate"><span class="pre">disabled</span></code> value.</p>
  3669. </dd></dl>
  3670. <dl class="config option">
  3671. <dt class="sig sig-object config" id="cfg_RelationalDisplay">
  3672. <span class="sig-name descname"><span class="pre">$cfg['RelationalDisplay']</span></span><a class="headerlink" href="#cfg_RelationalDisplay" title="Permalink to this definition">¶</a></dt>
  3673. <dd><dl class="field-list simple">
  3674. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3675. <dd class="field-odd"><p>string</p>
  3676. </dd>
  3677. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3678. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'K'</span></code></p>
  3679. </dd>
  3680. </dl>
  3681. <p>Defines the initial behavior for Options &gt; Relational. <code class="docutils literal notranslate"><span class="pre">K</span></code>, which
  3682. is the default, displays the key while <code class="docutils literal notranslate"><span class="pre">D</span></code> shows the display column.</p>
  3683. </dd></dl>
  3684. <dl class="config option">
  3685. <dt class="sig sig-object config" id="cfg_SaveCellsAtOnce">
  3686. <span class="sig-name descname"><span class="pre">$cfg['SaveCellsAtOnce']</span></span><a class="headerlink" href="#cfg_SaveCellsAtOnce" title="Permalink to this definition">¶</a></dt>
  3687. <dd><dl class="field-list simple">
  3688. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3689. <dd class="field-odd"><p>boolean</p>
  3690. </dd>
  3691. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3692. <dd class="field-even"><p>false</p>
  3693. </dd>
  3694. </dl>
  3695. <p>Defines whether or not to save all edited cells at once for grid
  3696. editing.</p>
  3697. </dd></dl>
  3698. </section>
  3699. <section id="editing-mode">
  3700. <h2>Editing mode<a class="headerlink" href="#editing-mode" title="Permalink to this heading">¶</a></h2>
  3701. <dl class="config option">
  3702. <dt class="sig sig-object config" id="cfg_ProtectBinary">
  3703. <span class="sig-name descname"><span class="pre">$cfg['ProtectBinary']</span></span><a class="headerlink" href="#cfg_ProtectBinary" title="Permalink to this definition">¶</a></dt>
  3704. <dd><dl class="field-list simple">
  3705. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3706. <dd class="field-odd"><p>boolean or string</p>
  3707. </dd>
  3708. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3709. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'blob'</span></code></p>
  3710. </dd>
  3711. </dl>
  3712. <p>Defines whether <code class="docutils literal notranslate"><span class="pre">BLOB</span></code> or <code class="docutils literal notranslate"><span class="pre">BINARY</span></code> columns are protected from
  3713. editing when browsing a table’s content. Valid values are:</p>
  3714. <ul class="simple">
  3715. <li><p><code class="docutils literal notranslate"><span class="pre">false</span></code> to allow editing of all columns;</p></li>
  3716. <li><p><code class="docutils literal notranslate"><span class="pre">'blob'</span></code> to allow editing of all columns except <code class="docutils literal notranslate"><span class="pre">BLOBS</span></code>;</p></li>
  3717. <li><p><code class="docutils literal notranslate"><span class="pre">'noblob'</span></code> to disallow editing of all columns except <code class="docutils literal notranslate"><span class="pre">BLOBS</span></code> (the
  3718. opposite of <code class="docutils literal notranslate"><span class="pre">'blob'</span></code>);</p></li>
  3719. <li><p><code class="docutils literal notranslate"><span class="pre">'all'</span></code> to disallow editing of all <code class="docutils literal notranslate"><span class="pre">BINARY</span></code> or <code class="docutils literal notranslate"><span class="pre">BLOB</span></code> columns.</p></li>
  3720. </ul>
  3721. </dd></dl>
  3722. <dl class="config option">
  3723. <dt class="sig sig-object config" id="cfg_ShowFunctionFields">
  3724. <span class="sig-name descname"><span class="pre">$cfg['ShowFunctionFields']</span></span><a class="headerlink" href="#cfg_ShowFunctionFields" title="Permalink to this definition">¶</a></dt>
  3725. <dd><dl class="field-list simple">
  3726. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3727. <dd class="field-odd"><p>boolean</p>
  3728. </dd>
  3729. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3730. <dd class="field-even"><p>true</p>
  3731. </dd>
  3732. </dl>
  3733. <p>Defines whether or not MySQL functions fields should be initially
  3734. displayed in edit/insert mode. Since version 2.10, the user can toggle
  3735. this setting from the interface.</p>
  3736. </dd></dl>
  3737. <dl class="config option">
  3738. <dt class="sig sig-object config" id="cfg_ShowFieldTypesInDataEditView">
  3739. <span class="sig-name descname"><span class="pre">$cfg['ShowFieldTypesInDataEditView']</span></span><a class="headerlink" href="#cfg_ShowFieldTypesInDataEditView" title="Permalink to this definition">¶</a></dt>
  3740. <dd><dl class="field-list simple">
  3741. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3742. <dd class="field-odd"><p>boolean</p>
  3743. </dd>
  3744. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3745. <dd class="field-even"><p>true</p>
  3746. </dd>
  3747. </dl>
  3748. <p>Defines whether or not type fields should be initially displayed in
  3749. edit/insert mode. The user can toggle this setting from the interface.</p>
  3750. </dd></dl>
  3751. <dl class="config option">
  3752. <dt class="sig sig-object config" id="cfg_InsertRows">
  3753. <span class="sig-name descname"><span class="pre">$cfg['InsertRows']</span></span><a class="headerlink" href="#cfg_InsertRows" title="Permalink to this definition">¶</a></dt>
  3754. <dd><dl class="field-list simple">
  3755. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3756. <dd class="field-odd"><p>integer</p>
  3757. </dd>
  3758. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3759. <dd class="field-even"><p>2</p>
  3760. </dd>
  3761. </dl>
  3762. <p>Defines the default number of rows to be entered from the Insert page.
  3763. Users can manually change this from the bottom of that page to add or remove
  3764. blank rows.</p>
  3765. </dd></dl>
  3766. <dl class="config option">
  3767. <dt class="sig sig-object config" id="cfg_ForeignKeyMaxLimit">
  3768. <span class="sig-name descname"><span class="pre">$cfg['ForeignKeyMaxLimit']</span></span><a class="headerlink" href="#cfg_ForeignKeyMaxLimit" title="Permalink to this definition">¶</a></dt>
  3769. <dd><dl class="field-list simple">
  3770. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3771. <dd class="field-odd"><p>integer</p>
  3772. </dd>
  3773. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3774. <dd class="field-even"><p>100</p>
  3775. </dd>
  3776. </dl>
  3777. <p>If there are fewer items than this in the set of foreign keys, then a
  3778. drop-down box of foreign keys is presented, in the style described by
  3779. the <span class="target" id="index-149"></span><a class="reference internal" href="#cfg_ForeignKeyDropdownOrder"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['ForeignKeyDropdownOrder']</span></code></a> setting.</p>
  3780. </dd></dl>
  3781. <dl class="config option">
  3782. <dt class="sig sig-object config" id="cfg_ForeignKeyDropdownOrder">
  3783. <span class="sig-name descname"><span class="pre">$cfg['ForeignKeyDropdownOrder']</span></span><a class="headerlink" href="#cfg_ForeignKeyDropdownOrder" title="Permalink to this definition">¶</a></dt>
  3784. <dd><dl class="field-list simple">
  3785. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3786. <dd class="field-odd"><p>array</p>
  3787. </dd>
  3788. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3789. <dd class="field-even"><p>array(‘content-id’, ‘id-content’)</p>
  3790. </dd>
  3791. </dl>
  3792. <p>For the foreign key drop-down fields, there are several methods of
  3793. display, offering both the key and value data. The contents of the
  3794. array should be one or both of the following strings: <code class="docutils literal notranslate"><span class="pre">content-id</span></code>,
  3795. <code class="docutils literal notranslate"><span class="pre">id-content</span></code>.</p>
  3796. </dd></dl>
  3797. </section>
  3798. <section id="export-and-import-settings">
  3799. <h2>Export and import settings<a class="headerlink" href="#export-and-import-settings" title="Permalink to this heading">¶</a></h2>
  3800. <dl class="config option">
  3801. <dt class="sig sig-object config" id="cfg_ZipDump">
  3802. <span class="sig-name descname"><span class="pre">$cfg['ZipDump']</span></span><a class="headerlink" href="#cfg_ZipDump" title="Permalink to this definition">¶</a></dt>
  3803. <dd><dl class="field-list simple">
  3804. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3805. <dd class="field-odd"><p>boolean</p>
  3806. </dd>
  3807. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3808. <dd class="field-even"><p>true</p>
  3809. </dd>
  3810. </dl>
  3811. </dd></dl>
  3812. <dl class="config option">
  3813. <dt class="sig sig-object config" id="cfg_GZipDump">
  3814. <span class="sig-name descname"><span class="pre">$cfg['GZipDump']</span></span><a class="headerlink" href="#cfg_GZipDump" title="Permalink to this definition">¶</a></dt>
  3815. <dd><dl class="field-list simple">
  3816. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3817. <dd class="field-odd"><p>boolean</p>
  3818. </dd>
  3819. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3820. <dd class="field-even"><p>true</p>
  3821. </dd>
  3822. </dl>
  3823. </dd></dl>
  3824. <dl class="config option">
  3825. <dt class="sig sig-object config" id="cfg_BZipDump">
  3826. <span class="sig-name descname"><span class="pre">$cfg['BZipDump']</span></span><a class="headerlink" href="#cfg_BZipDump" title="Permalink to this definition">¶</a></dt>
  3827. <dd><dl class="field-list simple">
  3828. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3829. <dd class="field-odd"><p>boolean</p>
  3830. </dd>
  3831. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3832. <dd class="field-even"><p>true</p>
  3833. </dd>
  3834. </dl>
  3835. <p>Defines whether to allow the use of zip/GZip/BZip2 compression when
  3836. creating a dump file</p>
  3837. </dd></dl>
  3838. <dl class="config option">
  3839. <dt class="sig sig-object config" id="cfg_CompressOnFly">
  3840. <span class="sig-name descname"><span class="pre">$cfg['CompressOnFly']</span></span><a class="headerlink" href="#cfg_CompressOnFly" title="Permalink to this definition">¶</a></dt>
  3841. <dd><dl class="field-list simple">
  3842. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3843. <dd class="field-odd"><p>boolean</p>
  3844. </dd>
  3845. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3846. <dd class="field-even"><p>true</p>
  3847. </dd>
  3848. </dl>
  3849. <p>Defines whether to allow on the fly compression for GZip/BZip2
  3850. compressed exports. This doesn’t affect smaller dumps and allows users
  3851. to create larger dumps that won’t otherwise fit in memory due to php
  3852. memory limit. Produced files contain more GZip/BZip2 headers, but all
  3853. normal programs handle this correctly.</p>
  3854. </dd></dl>
  3855. <dl class="config option">
  3856. <dt class="sig sig-object config" id="cfg_Export">
  3857. <span class="sig-name descname"><span class="pre">$cfg['Export']</span></span><a class="headerlink" href="#cfg_Export" title="Permalink to this definition">¶</a></dt>
  3858. <dd><dl class="field-list simple">
  3859. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3860. <dd class="field-odd"><p>array</p>
  3861. </dd>
  3862. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3863. <dd class="field-even"><p>array(…)</p>
  3864. </dd>
  3865. </dl>
  3866. <p>In this array are defined default parameters for export, names of
  3867. items are similar to texts seen on export page, so you can easily
  3868. identify what they mean.</p>
  3869. </dd></dl>
  3870. <dl class="config option">
  3871. <dt class="sig sig-object config" id="cfg_Export_format">
  3872. <span class="sig-name descname"><span class="pre">$cfg['Export']['format']</span></span><a class="headerlink" href="#cfg_Export_format" title="Permalink to this definition">¶</a></dt>
  3873. <dd><dl class="field-list simple">
  3874. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3875. <dd class="field-odd"><p>string</p>
  3876. </dd>
  3877. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3878. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'sql'</span></code></p>
  3879. </dd>
  3880. </dl>
  3881. <p>Default export format.</p>
  3882. </dd></dl>
  3883. <dl class="config option">
  3884. <dt class="sig sig-object config" id="cfg_Export_method">
  3885. <span class="sig-name descname"><span class="pre">$cfg['Export']['method']</span></span><a class="headerlink" href="#cfg_Export_method" title="Permalink to this definition">¶</a></dt>
  3886. <dd><dl class="field-list simple">
  3887. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3888. <dd class="field-odd"><p>string</p>
  3889. </dd>
  3890. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3891. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'quick'</span></code></p>
  3892. </dd>
  3893. </dl>
  3894. <p>Defines how the export form is displayed when it loads. Valid values
  3895. are:</p>
  3896. <ul class="simple">
  3897. <li><p><code class="docutils literal notranslate"><span class="pre">quick</span></code> to display the minimum number of options to configure</p></li>
  3898. <li><p><code class="docutils literal notranslate"><span class="pre">custom</span></code> to display every available option to configure</p></li>
  3899. <li><p><code class="docutils literal notranslate"><span class="pre">custom-no-form</span></code> same as <code class="docutils literal notranslate"><span class="pre">custom</span></code> but does not display the option
  3900. of using quick export</p></li>
  3901. </ul>
  3902. </dd></dl>
  3903. <dl class="config option">
  3904. <dt class="sig sig-object config" id="cfg_Export_compression">
  3905. <span class="sig-name descname"><span class="pre">$cfg['Export']['compression']</span></span><a class="headerlink" href="#cfg_Export_compression" title="Permalink to this definition">¶</a></dt>
  3906. <dd><dl class="field-list simple">
  3907. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3908. <dd class="field-odd"><p>string</p>
  3909. </dd>
  3910. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3911. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'none'</span></code></p>
  3912. </dd>
  3913. </dl>
  3914. <p>Default export compression method. Possible values are <code class="docutils literal notranslate"><span class="pre">'none'</span></code>, <code class="docutils literal notranslate"><span class="pre">'zip'</span></code> or <code class="docutils literal notranslate"><span class="pre">'gzip'</span></code>.</p>
  3915. </dd></dl>
  3916. <dl class="config option">
  3917. <dt class="sig sig-object config" id="cfg_Export_charset">
  3918. <span class="sig-name descname"><span class="pre">$cfg['Export']['charset']</span></span><a class="headerlink" href="#cfg_Export_charset" title="Permalink to this definition">¶</a></dt>
  3919. <dd><dl class="field-list simple">
  3920. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3921. <dd class="field-odd"><p>string</p>
  3922. </dd>
  3923. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3924. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  3925. </dd>
  3926. </dl>
  3927. <p>Defines charset for generated export. By default no charset conversion is
  3928. done assuming UTF-8.</p>
  3929. </dd></dl>
  3930. <dl class="config option">
  3931. <dt class="sig sig-object config" id="cfg_Export_file_template_table">
  3932. <span class="sig-name descname"><span class="pre">$cfg['Export']['file_template_table']</span></span><a class="headerlink" href="#cfg_Export_file_template_table" title="Permalink to this definition">¶</a></dt>
  3933. <dd><dl class="field-list simple">
  3934. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3935. <dd class="field-odd"><p>string</p>
  3936. </dd>
  3937. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3938. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'&#64;TABLE&#64;'</span></code></p>
  3939. </dd>
  3940. </dl>
  3941. <p>Default filename template for table exports.</p>
  3942. <div class="admonition seealso">
  3943. <p class="admonition-title">See also</p>
  3944. <p><a class="reference internal" href="faq.html#faq6-27"><span class="std std-ref">6.27 What format strings can I use?</span></a></p>
  3945. </div>
  3946. </dd></dl>
  3947. <dl class="config option">
  3948. <dt class="sig sig-object config" id="cfg_Export_file_template_database">
  3949. <span class="sig-name descname"><span class="pre">$cfg['Export']['file_template_database']</span></span><a class="headerlink" href="#cfg_Export_file_template_database" title="Permalink to this definition">¶</a></dt>
  3950. <dd><dl class="field-list simple">
  3951. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3952. <dd class="field-odd"><p>string</p>
  3953. </dd>
  3954. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3955. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'&#64;DATABASE&#64;'</span></code></p>
  3956. </dd>
  3957. </dl>
  3958. <p>Default filename template for database exports.</p>
  3959. <div class="admonition seealso">
  3960. <p class="admonition-title">See also</p>
  3961. <p><a class="reference internal" href="faq.html#faq6-27"><span class="std std-ref">6.27 What format strings can I use?</span></a></p>
  3962. </div>
  3963. </dd></dl>
  3964. <dl class="config option">
  3965. <dt class="sig sig-object config" id="cfg_Export_file_template_server">
  3966. <span class="sig-name descname"><span class="pre">$cfg['Export']['file_template_server']</span></span><a class="headerlink" href="#cfg_Export_file_template_server" title="Permalink to this definition">¶</a></dt>
  3967. <dd><dl class="field-list simple">
  3968. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3969. <dd class="field-odd"><p>string</p>
  3970. </dd>
  3971. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3972. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'&#64;SERVER&#64;'</span></code></p>
  3973. </dd>
  3974. </dl>
  3975. <p>Default filename template for server exports.</p>
  3976. <div class="admonition seealso">
  3977. <p class="admonition-title">See also</p>
  3978. <p><a class="reference internal" href="faq.html#faq6-27"><span class="std std-ref">6.27 What format strings can I use?</span></a></p>
  3979. </div>
  3980. </dd></dl>
  3981. <dl class="config option">
  3982. <dt class="sig sig-object config" id="cfg_Export_remove_definer_from_definitions">
  3983. <span class="sig-name descname"><span class="pre">$cfg['Export']['remove_definer_from_definitions']</span></span><a class="headerlink" href="#cfg_Export_remove_definer_from_definitions" title="Permalink to this definition">¶</a></dt>
  3984. <dd><dl class="field-list simple">
  3985. <dt class="field-odd">Type<span class="colon">:</span></dt>
  3986. <dd class="field-odd"><p>boolean</p>
  3987. </dd>
  3988. <dt class="field-even">Default value<span class="colon">:</span></dt>
  3989. <dd class="field-even"><p>false</p>
  3990. </dd>
  3991. </dl>
  3992. <p>Remove DEFINER clause from the event, view and routine definitions.</p>
  3993. <div class="versionadded">
  3994. <p><span class="versionmodified added">New in version 5.2.0.</span></p>
  3995. </div>
  3996. </dd></dl>
  3997. <dl class="config option">
  3998. <dt class="sig sig-object config" id="cfg_Import">
  3999. <span class="sig-name descname"><span class="pre">$cfg['Import']</span></span><a class="headerlink" href="#cfg_Import" title="Permalink to this definition">¶</a></dt>
  4000. <dd><dl class="field-list simple">
  4001. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4002. <dd class="field-odd"><p>array</p>
  4003. </dd>
  4004. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4005. <dd class="field-even"><p>array(…)</p>
  4006. </dd>
  4007. </dl>
  4008. <p>In this array are defined default parameters for import, names of
  4009. items are similar to texts seen on import page, so you can easily
  4010. identify what they mean.</p>
  4011. </dd></dl>
  4012. <dl class="config option">
  4013. <dt class="sig sig-object config" id="cfg_Import_charset">
  4014. <span class="sig-name descname"><span class="pre">$cfg['Import']['charset']</span></span><a class="headerlink" href="#cfg_Import_charset" title="Permalink to this definition">¶</a></dt>
  4015. <dd><dl class="field-list simple">
  4016. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4017. <dd class="field-odd"><p>string</p>
  4018. </dd>
  4019. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4020. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  4021. </dd>
  4022. </dl>
  4023. <p>Defines charset for import. By default no charset conversion is done
  4024. assuming UTF-8.</p>
  4025. </dd></dl>
  4026. <dl class="config option">
  4027. <dt class="sig sig-object config" id="cfg_Schema">
  4028. <span class="sig-name descname"><span class="pre">$cfg['Schema']</span></span><a class="headerlink" href="#cfg_Schema" title="Permalink to this definition">¶</a></dt>
  4029. <dd><dl class="field-list simple">
  4030. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4031. <dd class="field-odd"><p>array</p>
  4032. </dd>
  4033. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4034. <dd class="field-even"><p>array(…)</p>
  4035. </dd>
  4036. </dl>
  4037. </dd></dl>
  4038. <dl class="config option">
  4039. <dt class="sig sig-object config" id="cfg_Schema_format">
  4040. <span class="sig-name descname"><span class="pre">$cfg['Schema']['format']</span></span><a class="headerlink" href="#cfg_Schema_format" title="Permalink to this definition">¶</a></dt>
  4041. <dd><dl class="field-list simple">
  4042. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4043. <dd class="field-odd"><p>string</p>
  4044. </dd>
  4045. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4046. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'pdf'</span></code></p>
  4047. </dd>
  4048. </dl>
  4049. <p>Defines the default format for schema export. Possible values are <code class="docutils literal notranslate"><span class="pre">'pdf'</span></code>, <code class="docutils literal notranslate"><span class="pre">'eps'</span></code>, <code class="docutils literal notranslate"><span class="pre">'dia'</span></code> or <code class="docutils literal notranslate"><span class="pre">'svg'</span></code>.</p>
  4050. </dd></dl>
  4051. </section>
  4052. <section id="tabs-display-settings">
  4053. <h2>Tabs display settings<a class="headerlink" href="#tabs-display-settings" title="Permalink to this heading">¶</a></h2>
  4054. <dl class="config option">
  4055. <dt class="sig sig-object config" id="cfg_TabsMode">
  4056. <span class="sig-name descname"><span class="pre">$cfg['TabsMode']</span></span><a class="headerlink" href="#cfg_TabsMode" title="Permalink to this definition">¶</a></dt>
  4057. <dd><dl class="field-list simple">
  4058. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4059. <dd class="field-odd"><p>string</p>
  4060. </dd>
  4061. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4062. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'both'</span></code></p>
  4063. </dd>
  4064. </dl>
  4065. <p>Defines whether the menu tabs contain <code class="docutils literal notranslate"><span class="pre">'icons'</span></code>, <code class="docutils literal notranslate"><span class="pre">'text'</span></code> or <code class="docutils literal notranslate"><span class="pre">'both'</span></code>.</p>
  4066. </dd></dl>
  4067. <dl class="config option">
  4068. <dt class="sig sig-object config" id="cfg_PropertiesNumColumns">
  4069. <span class="sig-name descname"><span class="pre">$cfg['PropertiesNumColumns']</span></span><a class="headerlink" href="#cfg_PropertiesNumColumns" title="Permalink to this definition">¶</a></dt>
  4070. <dd><dl class="field-list simple">
  4071. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4072. <dd class="field-odd"><p>integer</p>
  4073. </dd>
  4074. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4075. <dd class="field-even"><p>1</p>
  4076. </dd>
  4077. </dl>
  4078. <p>How many columns will be utilized to display the tables on the database
  4079. property view? When setting this to a value larger than 1, the type of the
  4080. database will be omitted for more display space.</p>
  4081. </dd></dl>
  4082. <dl class="config option">
  4083. <dt class="sig sig-object config" id="cfg_DefaultTabServer">
  4084. <span class="sig-name descname"><span class="pre">$cfg['DefaultTabServer']</span></span><a class="headerlink" href="#cfg_DefaultTabServer" title="Permalink to this definition">¶</a></dt>
  4085. <dd><dl class="field-list simple">
  4086. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4087. <dd class="field-odd"><p>string</p>
  4088. </dd>
  4089. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4090. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'welcome'</span></code></p>
  4091. </dd>
  4092. </dl>
  4093. <p>Defines the tab displayed by default on server view. The possible values
  4094. are the localized equivalent of:</p>
  4095. <ul class="simple">
  4096. <li><p><code class="docutils literal notranslate"><span class="pre">welcome</span></code> (recommended for multi-user setups)</p></li>
  4097. <li><p><code class="docutils literal notranslate"><span class="pre">databases</span></code>,</p></li>
  4098. <li><p><code class="docutils literal notranslate"><span class="pre">status</span></code></p></li>
  4099. <li><p><code class="docutils literal notranslate"><span class="pre">variables</span></code></p></li>
  4100. <li><p><code class="docutils literal notranslate"><span class="pre">privileges</span></code></p></li>
  4101. </ul>
  4102. </dd></dl>
  4103. <dl class="config option">
  4104. <dt class="sig sig-object config" id="cfg_DefaultTabDatabase">
  4105. <span class="sig-name descname"><span class="pre">$cfg['DefaultTabDatabase']</span></span><a class="headerlink" href="#cfg_DefaultTabDatabase" title="Permalink to this definition">¶</a></dt>
  4106. <dd><dl class="field-list simple">
  4107. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4108. <dd class="field-odd"><p>string</p>
  4109. </dd>
  4110. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4111. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'structure'</span></code></p>
  4112. </dd>
  4113. </dl>
  4114. <p>Defines the tab displayed by default on database view. The possible values
  4115. are the localized equivalent of:</p>
  4116. <ul class="simple">
  4117. <li><p><code class="docutils literal notranslate"><span class="pre">structure</span></code></p></li>
  4118. <li><p><code class="docutils literal notranslate"><span class="pre">sql</span></code></p></li>
  4119. <li><p><code class="docutils literal notranslate"><span class="pre">search</span></code></p></li>
  4120. <li><p><code class="docutils literal notranslate"><span class="pre">operations</span></code></p></li>
  4121. </ul>
  4122. </dd></dl>
  4123. <dl class="config option">
  4124. <dt class="sig sig-object config" id="cfg_DefaultTabTable">
  4125. <span class="sig-name descname"><span class="pre">$cfg['DefaultTabTable']</span></span><a class="headerlink" href="#cfg_DefaultTabTable" title="Permalink to this definition">¶</a></dt>
  4126. <dd><dl class="field-list simple">
  4127. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4128. <dd class="field-odd"><p>string</p>
  4129. </dd>
  4130. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4131. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'browse'</span></code></p>
  4132. </dd>
  4133. </dl>
  4134. <p>Defines the tab displayed by default on table view. The possible values
  4135. are the localized equivalent of:</p>
  4136. <ul class="simple">
  4137. <li><p><code class="docutils literal notranslate"><span class="pre">structure</span></code></p></li>
  4138. <li><p><code class="docutils literal notranslate"><span class="pre">sql</span></code></p></li>
  4139. <li><p><code class="docutils literal notranslate"><span class="pre">search</span></code></p></li>
  4140. <li><p><code class="docutils literal notranslate"><span class="pre">insert</span></code></p></li>
  4141. <li><p><code class="docutils literal notranslate"><span class="pre">browse</span></code></p></li>
  4142. </ul>
  4143. </dd></dl>
  4144. </section>
  4145. <section id="pdf-options">
  4146. <h2>PDF Options<a class="headerlink" href="#pdf-options" title="Permalink to this heading">¶</a></h2>
  4147. <dl class="config option">
  4148. <dt class="sig sig-object config" id="cfg_PDFPageSizes">
  4149. <span class="sig-name descname"><span class="pre">$cfg['PDFPageSizes']</span></span><a class="headerlink" href="#cfg_PDFPageSizes" title="Permalink to this definition">¶</a></dt>
  4150. <dd><dl class="field-list simple">
  4151. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4152. <dd class="field-odd"><p>array</p>
  4153. </dd>
  4154. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4155. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">array('A3',</span> <span class="pre">'A4',</span> <span class="pre">'A5',</span> <span class="pre">'letter',</span> <span class="pre">'legal')</span></code></p>
  4156. </dd>
  4157. </dl>
  4158. <p>Array of possible paper sizes for creating PDF pages.</p>
  4159. <p>You should never need to change this.</p>
  4160. </dd></dl>
  4161. <dl class="config option">
  4162. <dt class="sig sig-object config" id="cfg_PDFDefaultPageSize">
  4163. <span class="sig-name descname"><span class="pre">$cfg['PDFDefaultPageSize']</span></span><a class="headerlink" href="#cfg_PDFDefaultPageSize" title="Permalink to this definition">¶</a></dt>
  4164. <dd><dl class="field-list simple">
  4165. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4166. <dd class="field-odd"><p>string</p>
  4167. </dd>
  4168. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4169. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'A4'</span></code></p>
  4170. </dd>
  4171. </dl>
  4172. <p>Default page size to use when creating PDF pages. Valid values are any
  4173. listed in <span class="target" id="index-150"></span><a class="reference internal" href="#cfg_PDFPageSizes"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['PDFPageSizes']</span></code></a>.</p>
  4174. </dd></dl>
  4175. </section>
  4176. <section id="languages">
  4177. <h2>Languages<a class="headerlink" href="#languages" title="Permalink to this heading">¶</a></h2>
  4178. <dl class="config option">
  4179. <dt class="sig sig-object config" id="cfg_DefaultLang">
  4180. <span class="sig-name descname"><span class="pre">$cfg['DefaultLang']</span></span><a class="headerlink" href="#cfg_DefaultLang" title="Permalink to this definition">¶</a></dt>
  4181. <dd><dl class="field-list simple">
  4182. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4183. <dd class="field-odd"><p>string</p>
  4184. </dd>
  4185. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4186. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'en'</span></code></p>
  4187. </dd>
  4188. </dl>
  4189. <p>Defines the default language to use, if not browser-defined or user-
  4190. defined. The corresponding language file needs to be in
  4191. locale/<em>code</em>/LC_MESSAGES/phpmyadmin.mo.</p>
  4192. </dd></dl>
  4193. <dl class="config option">
  4194. <dt class="sig sig-object config" id="cfg_DefaultConnectionCollation">
  4195. <span class="sig-name descname"><span class="pre">$cfg['DefaultConnectionCollation']</span></span><a class="headerlink" href="#cfg_DefaultConnectionCollation" title="Permalink to this definition">¶</a></dt>
  4196. <dd><dl class="field-list simple">
  4197. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4198. <dd class="field-odd"><p>string</p>
  4199. </dd>
  4200. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4201. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'utf8mb4_general_ci'</span></code></p>
  4202. </dd>
  4203. </dl>
  4204. <p>Defines the default connection collation to use, if not user-defined.
  4205. See the <a class="reference external" href="https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html">MySQL documentation for charsets</a>
  4206. for list of possible values.</p>
  4207. </dd></dl>
  4208. <dl class="config option">
  4209. <dt class="sig sig-object config" id="cfg_Lang">
  4210. <span class="sig-name descname"><span class="pre">$cfg['Lang']</span></span><a class="headerlink" href="#cfg_Lang" title="Permalink to this definition">¶</a></dt>
  4211. <dd><dl class="field-list simple">
  4212. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4213. <dd class="field-odd"><p>string</p>
  4214. </dd>
  4215. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4216. <dd class="field-even"><p>not set</p>
  4217. </dd>
  4218. </dl>
  4219. <p>Force language to use. The corresponding language file needs to be in
  4220. locale/<em>code</em>/LC_MESSAGES/phpmyadmin.mo.</p>
  4221. </dd></dl>
  4222. <dl class="config option">
  4223. <dt class="sig sig-object config" id="cfg_FilterLanguages">
  4224. <span class="sig-name descname"><span class="pre">$cfg['FilterLanguages']</span></span><a class="headerlink" href="#cfg_FilterLanguages" title="Permalink to this definition">¶</a></dt>
  4225. <dd><dl class="field-list simple">
  4226. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4227. <dd class="field-odd"><p>string</p>
  4228. </dd>
  4229. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4230. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  4231. </dd>
  4232. </dl>
  4233. <p>Limit list of available languages to those matching the given regular
  4234. expression. For example if you want only Czech and English, you should
  4235. set filter to <code class="docutils literal notranslate"><span class="pre">'^(cs|en)'</span></code>.</p>
  4236. </dd></dl>
  4237. <dl class="config option">
  4238. <dt class="sig sig-object config" id="cfg_RecodingEngine">
  4239. <span class="sig-name descname"><span class="pre">$cfg['RecodingEngine']</span></span><a class="headerlink" href="#cfg_RecodingEngine" title="Permalink to this definition">¶</a></dt>
  4240. <dd><dl class="field-list simple">
  4241. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4242. <dd class="field-odd"><p>string</p>
  4243. </dd>
  4244. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4245. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'auto'</span></code></p>
  4246. </dd>
  4247. </dl>
  4248. <p>You can select here which functions will be used for character set
  4249. conversion. Possible values are:</p>
  4250. <ul class="simple">
  4251. <li><p>auto - automatically use available one (first is tested iconv, then
  4252. recode)</p></li>
  4253. <li><p>iconv - use iconv or libiconv functions</p></li>
  4254. <li><p>recode - use recode_string function</p></li>
  4255. <li><p>mb - use <a class="reference internal" href="glossary.html#term-mbstring"><span class="xref std std-term">mbstring</span></a> extension</p></li>
  4256. <li><p>none - disable encoding conversion</p></li>
  4257. </ul>
  4258. <p>Enabled charset conversion activates a pull-down menu in the Export
  4259. and Import pages, to choose the character set when exporting a file.
  4260. The default value in this menu comes from
  4261. <span class="target" id="index-151"></span><a class="reference internal" href="#cfg_Export_charset"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Export']['charset']</span></code></a> and <span class="target" id="index-152"></span><a class="reference internal" href="#cfg_Import_charset"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Import']['charset']</span></code></a>.</p>
  4262. </dd></dl>
  4263. <dl class="config option">
  4264. <dt class="sig sig-object config" id="cfg_IconvExtraParams">
  4265. <span class="sig-name descname"><span class="pre">$cfg['IconvExtraParams']</span></span><a class="headerlink" href="#cfg_IconvExtraParams" title="Permalink to this definition">¶</a></dt>
  4266. <dd><dl class="field-list simple">
  4267. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4268. <dd class="field-odd"><p>string</p>
  4269. </dd>
  4270. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4271. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'//TRANSLIT'</span></code></p>
  4272. </dd>
  4273. </dl>
  4274. <p>Specify some parameters for iconv used in charset conversion. See
  4275. <a class="reference external" href="https://www.gnu.org/savannah-checkouts/gnu/libiconv/documentation/libiconv-1.15/iconv_open.3.html">iconv documentation</a> for details. By default
  4276. <code class="docutils literal notranslate"><span class="pre">//TRANSLIT</span></code> is used, so that invalid characters will be
  4277. transliterated.</p>
  4278. </dd></dl>
  4279. <dl class="config option">
  4280. <dt class="sig sig-object config" id="cfg_AvailableCharsets">
  4281. <span class="sig-name descname"><span class="pre">$cfg['AvailableCharsets']</span></span><a class="headerlink" href="#cfg_AvailableCharsets" title="Permalink to this definition">¶</a></dt>
  4282. <dd><dl class="field-list simple">
  4283. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4284. <dd class="field-odd"><p>array</p>
  4285. </dd>
  4286. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4287. <dd class="field-even"><p>array(…)</p>
  4288. </dd>
  4289. </dl>
  4290. <p>Available character sets for MySQL conversion. You can add your own
  4291. (any of supported by recode/iconv) or remove these which you don’t
  4292. use. Character sets will be shown in same order as here listed, so if
  4293. you frequently use some of these move them to the top.</p>
  4294. </dd></dl>
  4295. </section>
  4296. <section id="web-server-settings">
  4297. <h2>Web server settings<a class="headerlink" href="#web-server-settings" title="Permalink to this heading">¶</a></h2>
  4298. <dl class="config option">
  4299. <dt class="sig sig-object config" id="cfg_OBGzip">
  4300. <span class="sig-name descname"><span class="pre">$cfg['OBGzip']</span></span><a class="headerlink" href="#cfg_OBGzip" title="Permalink to this definition">¶</a></dt>
  4301. <dd><dl class="field-list simple">
  4302. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4303. <dd class="field-odd"><p>string/boolean</p>
  4304. </dd>
  4305. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4306. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'auto'</span></code></p>
  4307. </dd>
  4308. </dl>
  4309. <p>Defines whether to use GZip output buffering for increased speed in
  4310. <a class="reference internal" href="glossary.html#term-HTTP"><span class="xref std std-term">HTTP</span></a> transfers. Set to
  4311. true/false for enabling/disabling. When set to ‘auto’ (string),
  4312. phpMyAdmin tries to enable output buffering and will automatically
  4313. disable it if your browser has some problems with buffering. IE6 with
  4314. a certain patch is known to cause data corruption when having enabled
  4315. buffering.</p>
  4316. </dd></dl>
  4317. <dl class="config option">
  4318. <dt class="sig sig-object config" id="cfg_TrustedProxies">
  4319. <span class="sig-name descname"><span class="pre">$cfg['TrustedProxies']</span></span><a class="headerlink" href="#cfg_TrustedProxies" title="Permalink to this definition">¶</a></dt>
  4320. <dd><dl class="field-list simple">
  4321. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4322. <dd class="field-odd"><p>array</p>
  4323. </dd>
  4324. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4325. <dd class="field-even"><p>array()</p>
  4326. </dd>
  4327. </dl>
  4328. <p>Lists proxies and HTTP headers which are trusted for
  4329. <span class="target" id="index-153"></span><a class="reference internal" href="#cfg_Servers_AllowDeny_order"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['AllowDeny']['order']</span></code></a>. This list is by
  4330. default empty, you need to fill in some trusted proxy servers if you
  4331. want to use rules for IP addresses behind proxy.</p>
  4332. <p>The following example specifies that phpMyAdmin should trust a
  4333. HTTP_X_FORWARDED_FOR (<code class="docutils literal notranslate"><span class="pre">X-Forwarded-For</span></code>) header coming from the proxy
  4334. 1.2.3.4:</p>
  4335. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;TrustedProxies&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;1.2.3.4&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;HTTP_X_FORWARDED_FOR&#39;</span><span class="p">];</span>
  4336. </pre></div>
  4337. </div>
  4338. <p>The <span class="target" id="index-154"></span><a class="reference internal" href="#cfg_Servers_AllowDeny_rules"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['AllowDeny']['rules']</span></code></a> directive uses the
  4339. client’s IP address as usual.</p>
  4340. </dd></dl>
  4341. <dl class="config option">
  4342. <dt class="sig sig-object config" id="cfg_GD2Available">
  4343. <span class="sig-name descname"><span class="pre">$cfg['GD2Available']</span></span><a class="headerlink" href="#cfg_GD2Available" title="Permalink to this definition">¶</a></dt>
  4344. <dd><dl class="field-list simple">
  4345. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4346. <dd class="field-odd"><p>string</p>
  4347. </dd>
  4348. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4349. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'auto'</span></code></p>
  4350. </dd>
  4351. </dl>
  4352. <p>Specifies whether GD &gt;= 2 is available. If yes it can be used for MIME
  4353. transformations. Possible values are:</p>
  4354. <ul class="simple">
  4355. <li><p>auto - automatically detect</p></li>
  4356. <li><p>yes - GD 2 functions can be used</p></li>
  4357. <li><p>no - GD 2 function cannot be used</p></li>
  4358. </ul>
  4359. </dd></dl>
  4360. <dl class="config option">
  4361. <dt class="sig sig-object config" id="cfg_CheckConfigurationPermissions">
  4362. <span class="sig-name descname"><span class="pre">$cfg['CheckConfigurationPermissions']</span></span><a class="headerlink" href="#cfg_CheckConfigurationPermissions" title="Permalink to this definition">¶</a></dt>
  4363. <dd><dl class="field-list simple">
  4364. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4365. <dd class="field-odd"><p>boolean</p>
  4366. </dd>
  4367. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4368. <dd class="field-even"><p>true</p>
  4369. </dd>
  4370. </dl>
  4371. <p>We normally check the permissions on the configuration file to ensure
  4372. it’s not world writable. However, phpMyAdmin could be installed on a
  4373. NTFS filesystem mounted on a non-Windows server, in which case the
  4374. permissions seems wrong but in fact cannot be detected. In this case a
  4375. sysadmin would set this parameter to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
  4376. </dd></dl>
  4377. <dl class="config option">
  4378. <dt class="sig sig-object config" id="cfg_LinkLengthLimit">
  4379. <span class="sig-name descname"><span class="pre">$cfg['LinkLengthLimit']</span></span><a class="headerlink" href="#cfg_LinkLengthLimit" title="Permalink to this definition">¶</a></dt>
  4380. <dd><dl class="field-list simple">
  4381. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4382. <dd class="field-odd"><p>integer</p>
  4383. </dd>
  4384. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4385. <dd class="field-even"><p>1000</p>
  4386. </dd>
  4387. </dl>
  4388. <p>Limit for length of <a class="reference internal" href="glossary.html#term-URL"><span class="xref std std-term">URL</span></a> in links. When length would be above this
  4389. limit, it is replaced by form with button. This is required as some web
  4390. servers (<a class="reference internal" href="glossary.html#term-IIS"><span class="xref std std-term">IIS</span></a>) have problems with long <a class="reference internal" href="glossary.html#term-URL"><span class="xref std std-term">URL</span></a> .</p>
  4391. </dd></dl>
  4392. <dl class="config option">
  4393. <dt class="sig sig-object config" id="cfg_CSPAllow">
  4394. <span class="sig-name descname"><span class="pre">$cfg['CSPAllow']</span></span><a class="headerlink" href="#cfg_CSPAllow" title="Permalink to this definition">¶</a></dt>
  4395. <dd><dl class="field-list simple">
  4396. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4397. <dd class="field-odd"><p>string</p>
  4398. </dd>
  4399. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4400. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  4401. </dd>
  4402. </dl>
  4403. <p>Additional string to include in allowed script and image sources in Content
  4404. Security Policy header.</p>
  4405. <p>This can be useful when you want to include some external JavaScript files
  4406. in <code class="file docutils literal notranslate"><span class="pre">config.footer.inc.php</span></code> or <code class="file docutils literal notranslate"><span class="pre">config.header.inc.php</span></code>, which
  4407. would be normally not allowed by <a class="reference internal" href="glossary.html#term-Content-Security-Policy"><span class="xref std std-term">Content Security Policy</span></a>.</p>
  4408. <p>To allow some sites, just list them within the string:</p>
  4409. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CSPAllow&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;example.com example.net&#39;</span><span class="p">;</span>
  4410. </pre></div>
  4411. </div>
  4412. <div class="versionadded">
  4413. <p><span class="versionmodified added">New in version 4.0.4.</span></p>
  4414. </div>
  4415. </dd></dl>
  4416. <dl class="config option">
  4417. <dt class="sig sig-object config" id="cfg_DisableMultiTableMaintenance">
  4418. <span class="sig-name descname"><span class="pre">$cfg['DisableMultiTableMaintenance']</span></span><a class="headerlink" href="#cfg_DisableMultiTableMaintenance" title="Permalink to this definition">¶</a></dt>
  4419. <dd><dl class="field-list simple">
  4420. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4421. <dd class="field-odd"><p>boolean</p>
  4422. </dd>
  4423. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4424. <dd class="field-even"><p>false</p>
  4425. </dd>
  4426. </dl>
  4427. <p>In the database Structure page, it’s possible to mark some tables then
  4428. choose an operation like optimizing for many tables. This can slow
  4429. down a server; therefore, setting this to <code class="docutils literal notranslate"><span class="pre">true</span></code> prevents this kind
  4430. of multiple maintenance operation.</p>
  4431. </dd></dl>
  4432. </section>
  4433. <section id="theme-settings">
  4434. <h2>Theme settings<a class="headerlink" href="#theme-settings" title="Permalink to this heading">¶</a></h2>
  4435. <blockquote>
  4436. <div><p>Please directly modify <code class="file docutils literal notranslate"><span class="pre">themes/themename/scss/_variables.scss</span></code>, although
  4437. your changes will be overwritten with the next update.</p>
  4438. </div></blockquote>
  4439. </section>
  4440. <section id="design-customization">
  4441. <h2>Design customization<a class="headerlink" href="#design-customization" title="Permalink to this heading">¶</a></h2>
  4442. <dl class="config option">
  4443. <dt class="sig sig-object config" id="cfg_NavigationTreePointerEnable">
  4444. <span class="sig-name descname"><span class="pre">$cfg['NavigationTreePointerEnable']</span></span><a class="headerlink" href="#cfg_NavigationTreePointerEnable" title="Permalink to this definition">¶</a></dt>
  4445. <dd><dl class="field-list simple">
  4446. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4447. <dd class="field-odd"><p>boolean</p>
  4448. </dd>
  4449. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4450. <dd class="field-even"><p>true</p>
  4451. </dd>
  4452. </dl>
  4453. <p>When set to true, hovering over an item in the navigation panel causes that item to be marked
  4454. (the background is highlighted).</p>
  4455. </dd></dl>
  4456. <dl class="config option">
  4457. <dt class="sig sig-object config" id="cfg_BrowsePointerEnable">
  4458. <span class="sig-name descname"><span class="pre">$cfg['BrowsePointerEnable']</span></span><a class="headerlink" href="#cfg_BrowsePointerEnable" title="Permalink to this definition">¶</a></dt>
  4459. <dd><dl class="field-list simple">
  4460. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4461. <dd class="field-odd"><p>boolean</p>
  4462. </dd>
  4463. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4464. <dd class="field-even"><p>true</p>
  4465. </dd>
  4466. </dl>
  4467. <p>When set to true, hovering over a row in the Browse page causes that row to be marked (the background
  4468. is highlighted).</p>
  4469. </dd></dl>
  4470. <dl class="config option">
  4471. <dt class="sig sig-object config" id="cfg_BrowseMarkerEnable">
  4472. <span class="sig-name descname"><span class="pre">$cfg['BrowseMarkerEnable']</span></span><a class="headerlink" href="#cfg_BrowseMarkerEnable" title="Permalink to this definition">¶</a></dt>
  4473. <dd><dl class="field-list simple">
  4474. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4475. <dd class="field-odd"><p>boolean</p>
  4476. </dd>
  4477. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4478. <dd class="field-even"><p>true</p>
  4479. </dd>
  4480. </dl>
  4481. <p>When set to true, a data row is marked (the background is highlighted) when the row is selected
  4482. with the checkbox.</p>
  4483. </dd></dl>
  4484. <dl class="config option">
  4485. <dt class="sig sig-object config" id="cfg_LimitChars">
  4486. <span class="sig-name descname"><span class="pre">$cfg['LimitChars']</span></span><a class="headerlink" href="#cfg_LimitChars" title="Permalink to this definition">¶</a></dt>
  4487. <dd><dl class="field-list simple">
  4488. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4489. <dd class="field-odd"><p>integer</p>
  4490. </dd>
  4491. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4492. <dd class="field-even"><p>50</p>
  4493. </dd>
  4494. </dl>
  4495. <p>Maximum number of characters shown in any non-numeric field on browse
  4496. view. Can be turned off by a toggle button on the browse page.</p>
  4497. </dd></dl>
  4498. <dl class="config option">
  4499. <dt class="sig sig-object config" id="cfg_RowActionLinks">
  4500. <span class="sig-name descname"><span class="pre">$cfg['RowActionLinks']</span></span><a class="headerlink" href="#cfg_RowActionLinks" title="Permalink to this definition">¶</a></dt>
  4501. <dd><dl class="field-list simple">
  4502. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4503. <dd class="field-odd"><p>string</p>
  4504. </dd>
  4505. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4506. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'left'</span></code></p>
  4507. </dd>
  4508. </dl>
  4509. <p>Defines the place where table row links (Edit, Copy, Delete) would be
  4510. put when tables contents are displayed (you may have them displayed at
  4511. the left side, right side, both sides or nowhere).</p>
  4512. </dd></dl>
  4513. <dl class="config option">
  4514. <dt class="sig sig-object config" id="cfg_RowActionLinksWithoutUnique">
  4515. <span class="sig-name descname"><span class="pre">$cfg['RowActionLinksWithoutUnique']</span></span><a class="headerlink" href="#cfg_RowActionLinksWithoutUnique" title="Permalink to this definition">¶</a></dt>
  4516. <dd><dl class="field-list simple">
  4517. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4518. <dd class="field-odd"><p>boolean</p>
  4519. </dd>
  4520. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4521. <dd class="field-even"><p>false</p>
  4522. </dd>
  4523. </dl>
  4524. <p>Defines whether to show row links (Edit, Copy, Delete) and checkboxes
  4525. for multiple row operations even when the selection does not have a <a class="reference internal" href="glossary.html#term-unique-key"><span class="xref std std-term">unique key</span></a>.
  4526. Using row actions in the absence of a unique key may result in different/more
  4527. rows being affected since there is no guaranteed way to select the exact row(s).</p>
  4528. </dd></dl>
  4529. <dl class="config option">
  4530. <dt class="sig sig-object config" id="cfg_RememberSorting">
  4531. <span class="sig-name descname"><span class="pre">$cfg['RememberSorting']</span></span><a class="headerlink" href="#cfg_RememberSorting" title="Permalink to this definition">¶</a></dt>
  4532. <dd><dl class="field-list simple">
  4533. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4534. <dd class="field-odd"><p>boolean</p>
  4535. </dd>
  4536. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4537. <dd class="field-even"><p>true</p>
  4538. </dd>
  4539. </dl>
  4540. <p>If enabled, remember the sorting of each table when browsing them.</p>
  4541. </dd></dl>
  4542. <dl class="config option">
  4543. <dt class="sig sig-object config" id="cfg_TablePrimaryKeyOrder">
  4544. <span class="sig-name descname"><span class="pre">$cfg['TablePrimaryKeyOrder']</span></span><a class="headerlink" href="#cfg_TablePrimaryKeyOrder" title="Permalink to this definition">¶</a></dt>
  4545. <dd><dl class="field-list simple">
  4546. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4547. <dd class="field-odd"><p>string</p>
  4548. </dd>
  4549. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4550. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'NONE'</span></code></p>
  4551. </dd>
  4552. </dl>
  4553. <p>This defines the default sort order for the tables, having a <a class="reference internal" href="glossary.html#term-primary-key"><span class="xref std std-term">primary key</span></a>,
  4554. when there is no sort order defines externally.
  4555. Acceptable values : [‘NONE’, ‘ASC’, ‘DESC’]</p>
  4556. </dd></dl>
  4557. <dl class="config option">
  4558. <dt class="sig sig-object config" id="cfg_ShowBrowseComments">
  4559. <span class="sig-name descname"><span class="pre">$cfg['ShowBrowseComments']</span></span><a class="headerlink" href="#cfg_ShowBrowseComments" title="Permalink to this definition">¶</a></dt>
  4560. <dd><dl class="field-list simple">
  4561. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4562. <dd class="field-odd"><p>boolean</p>
  4563. </dd>
  4564. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4565. <dd class="field-even"><p>true</p>
  4566. </dd>
  4567. </dl>
  4568. </dd></dl>
  4569. <dl class="config option">
  4570. <dt class="sig sig-object config" id="cfg_ShowPropertyComments">
  4571. <span class="sig-name descname"><span class="pre">$cfg['ShowPropertyComments']</span></span><a class="headerlink" href="#cfg_ShowPropertyComments" title="Permalink to this definition">¶</a></dt>
  4572. <dd><dl class="field-list simple">
  4573. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4574. <dd class="field-odd"><p>boolean</p>
  4575. </dd>
  4576. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4577. <dd class="field-even"><p>true</p>
  4578. </dd>
  4579. </dl>
  4580. <p>By setting the corresponding variable to <code class="docutils literal notranslate"><span class="pre">true</span></code> you can enable the
  4581. display of column comments in Browse or Property display. In browse
  4582. mode, the comments are shown inside the header. In property mode,
  4583. comments are displayed using a CSS-formatted dashed-line below the
  4584. name of the column. The comment is shown as a tool-tip for that
  4585. column.</p>
  4586. </dd></dl>
  4587. <dl class="config option">
  4588. <dt class="sig sig-object config" id="cfg_FirstDayOfCalendar">
  4589. <span class="sig-name descname"><span class="pre">$cfg['FirstDayOfCalendar']</span></span><a class="headerlink" href="#cfg_FirstDayOfCalendar" title="Permalink to this definition">¶</a></dt>
  4590. <dd><dl class="field-list simple">
  4591. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4592. <dd class="field-odd"><p>integer</p>
  4593. </dd>
  4594. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4595. <dd class="field-even"><p>0</p>
  4596. </dd>
  4597. </dl>
  4598. <p>This will define the first day of week in the calendar. The number
  4599. can be set from 0 to 6, which represents the seven days of the week,
  4600. Sunday to Saturday respectively. This value can also be configured by the user
  4601. in <span class="guilabel">Settings</span> -&gt; <span class="guilabel">Features</span> -&gt; <span class="guilabel">General</span> -&gt; <span class="guilabel">First day of calendar</span> field.</p>
  4602. </dd></dl>
  4603. </section>
  4604. <section id="text-fields">
  4605. <h2>Text fields<a class="headerlink" href="#text-fields" title="Permalink to this heading">¶</a></h2>
  4606. <dl class="config option">
  4607. <dt class="sig sig-object config" id="cfg_CharEditing">
  4608. <span class="sig-name descname"><span class="pre">$cfg['CharEditing']</span></span><a class="headerlink" href="#cfg_CharEditing" title="Permalink to this definition">¶</a></dt>
  4609. <dd><dl class="field-list simple">
  4610. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4611. <dd class="field-odd"><p>string</p>
  4612. </dd>
  4613. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4614. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'input'</span></code></p>
  4615. </dd>
  4616. </dl>
  4617. <p>Defines which type of editing controls should be used for CHAR and
  4618. VARCHAR columns. Applies to data editing and also to the default values
  4619. in structure editing. Possible values are:</p>
  4620. <ul class="simple">
  4621. <li><p>input - this allows to limit size of text to size of columns in MySQL,
  4622. but has problems with newlines in columns</p></li>
  4623. <li><p>textarea - no problems with newlines in columns, but also no length
  4624. limitations</p></li>
  4625. </ul>
  4626. </dd></dl>
  4627. <dl class="config option">
  4628. <dt class="sig sig-object config" id="cfg_MinSizeForInputField">
  4629. <span class="sig-name descname"><span class="pre">$cfg['MinSizeForInputField']</span></span><a class="headerlink" href="#cfg_MinSizeForInputField" title="Permalink to this definition">¶</a></dt>
  4630. <dd><dl class="field-list simple">
  4631. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4632. <dd class="field-odd"><p>integer</p>
  4633. </dd>
  4634. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4635. <dd class="field-even"><p>4</p>
  4636. </dd>
  4637. </dl>
  4638. <p>Defines the minimum size for input fields generated for CHAR and
  4639. VARCHAR columns.</p>
  4640. </dd></dl>
  4641. <dl class="config option">
  4642. <dt class="sig sig-object config" id="cfg_MaxSizeForInputField">
  4643. <span class="sig-name descname"><span class="pre">$cfg['MaxSizeForInputField']</span></span><a class="headerlink" href="#cfg_MaxSizeForInputField" title="Permalink to this definition">¶</a></dt>
  4644. <dd><dl class="field-list simple">
  4645. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4646. <dd class="field-odd"><p>integer</p>
  4647. </dd>
  4648. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4649. <dd class="field-even"><p>60</p>
  4650. </dd>
  4651. </dl>
  4652. <p>Defines the maximum size for input fields generated for CHAR and
  4653. VARCHAR columns.</p>
  4654. </dd></dl>
  4655. <dl class="config option">
  4656. <dt class="sig sig-object config" id="cfg_TextareaCols">
  4657. <span class="sig-name descname"><span class="pre">$cfg['TextareaCols']</span></span><a class="headerlink" href="#cfg_TextareaCols" title="Permalink to this definition">¶</a></dt>
  4658. <dd><dl class="field-list simple">
  4659. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4660. <dd class="field-odd"><p>integer</p>
  4661. </dd>
  4662. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4663. <dd class="field-even"><p>40</p>
  4664. </dd>
  4665. </dl>
  4666. </dd></dl>
  4667. <dl class="config option">
  4668. <dt class="sig sig-object config" id="cfg_TextareaRows">
  4669. <span class="sig-name descname"><span class="pre">$cfg['TextareaRows']</span></span><a class="headerlink" href="#cfg_TextareaRows" title="Permalink to this definition">¶</a></dt>
  4670. <dd><dl class="field-list simple">
  4671. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4672. <dd class="field-odd"><p>integer</p>
  4673. </dd>
  4674. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4675. <dd class="field-even"><p>15</p>
  4676. </dd>
  4677. </dl>
  4678. </dd></dl>
  4679. <dl class="config option">
  4680. <dt class="sig sig-object config" id="cfg_CharTextareaCols">
  4681. <span class="sig-name descname"><span class="pre">$cfg['CharTextareaCols']</span></span><a class="headerlink" href="#cfg_CharTextareaCols" title="Permalink to this definition">¶</a></dt>
  4682. <dd><dl class="field-list simple">
  4683. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4684. <dd class="field-odd"><p>integer</p>
  4685. </dd>
  4686. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4687. <dd class="field-even"><p>40</p>
  4688. </dd>
  4689. </dl>
  4690. </dd></dl>
  4691. <dl class="config option">
  4692. <dt class="sig sig-object config" id="cfg_CharTextareaRows">
  4693. <span class="sig-name descname"><span class="pre">$cfg['CharTextareaRows']</span></span><a class="headerlink" href="#cfg_CharTextareaRows" title="Permalink to this definition">¶</a></dt>
  4694. <dd><dl class="field-list simple">
  4695. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4696. <dd class="field-odd"><p>integer</p>
  4697. </dd>
  4698. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4699. <dd class="field-even"><p>7</p>
  4700. </dd>
  4701. </dl>
  4702. <p>Number of columns and rows for the textareas. This value will be
  4703. emphasized (*2) for <a class="reference internal" href="glossary.html#term-SQL"><span class="xref std std-term">SQL</span></a> query
  4704. textareas and (*1.25) for <a class="reference internal" href="glossary.html#term-SQL"><span class="xref std std-term">SQL</span></a>
  4705. textareas inside the query window.</p>
  4706. <p>The Char* values are used for CHAR
  4707. and VARCHAR editing (if configured via <span class="target" id="index-155"></span><a class="reference internal" href="#cfg_CharEditing"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['CharEditing']</span></code></a>).</p>
  4708. <div class="versionchanged">
  4709. <p><span class="versionmodified changed">Changed in version 5.0.0: </span>The default value was changed from 2 to 7.</p>
  4710. </div>
  4711. </dd></dl>
  4712. <dl class="config option">
  4713. <dt class="sig sig-object config" id="cfg_LongtextDoubleTextarea">
  4714. <span class="sig-name descname"><span class="pre">$cfg['LongtextDoubleTextarea']</span></span><a class="headerlink" href="#cfg_LongtextDoubleTextarea" title="Permalink to this definition">¶</a></dt>
  4715. <dd><dl class="field-list simple">
  4716. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4717. <dd class="field-odd"><p>boolean</p>
  4718. </dd>
  4719. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4720. <dd class="field-even"><p>true</p>
  4721. </dd>
  4722. </dl>
  4723. <p>Defines whether textarea for LONGTEXT columns should have double size.</p>
  4724. </dd></dl>
  4725. <dl class="config option">
  4726. <dt class="sig sig-object config" id="cfg_TextareaAutoSelect">
  4727. <span class="sig-name descname"><span class="pre">$cfg['TextareaAutoSelect']</span></span><a class="headerlink" href="#cfg_TextareaAutoSelect" title="Permalink to this definition">¶</a></dt>
  4728. <dd><dl class="field-list simple">
  4729. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4730. <dd class="field-odd"><p>boolean</p>
  4731. </dd>
  4732. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4733. <dd class="field-even"><p>false</p>
  4734. </dd>
  4735. </dl>
  4736. <p>Defines if the whole textarea of the query box will be selected on
  4737. click.</p>
  4738. </dd></dl>
  4739. <dl class="config option">
  4740. <dt class="sig sig-object config" id="cfg_EnableAutocompleteForTablesAndColumns">
  4741. <span class="sig-name descname"><span class="pre">$cfg['EnableAutocompleteForTablesAndColumns']</span></span><a class="headerlink" href="#cfg_EnableAutocompleteForTablesAndColumns" title="Permalink to this definition">¶</a></dt>
  4742. <dd><dl class="field-list simple">
  4743. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4744. <dd class="field-odd"><p>boolean</p>
  4745. </dd>
  4746. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4747. <dd class="field-even"><p>true</p>
  4748. </dd>
  4749. </dl>
  4750. <p>Whether to enable autocomplete for table and column names in any
  4751. SQL query box.</p>
  4752. </dd></dl>
  4753. </section>
  4754. <section id="sql-query-box-settings">
  4755. <h2>SQL query box settings<a class="headerlink" href="#sql-query-box-settings" title="Permalink to this heading">¶</a></h2>
  4756. <dl class="config option">
  4757. <dt class="sig sig-object config" id="cfg_SQLQuery_Edit">
  4758. <span class="sig-name descname"><span class="pre">$cfg['SQLQuery']['Edit']</span></span><a class="headerlink" href="#cfg_SQLQuery_Edit" title="Permalink to this definition">¶</a></dt>
  4759. <dd><dl class="field-list simple">
  4760. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4761. <dd class="field-odd"><p>boolean</p>
  4762. </dd>
  4763. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4764. <dd class="field-even"><p>true</p>
  4765. </dd>
  4766. </dl>
  4767. <p>Whether to display an edit link to change a query in any SQL Query
  4768. box.</p>
  4769. </dd></dl>
  4770. <dl class="config option">
  4771. <dt class="sig sig-object config" id="cfg_SQLQuery_Explain">
  4772. <span class="sig-name descname"><span class="pre">$cfg['SQLQuery']['Explain']</span></span><a class="headerlink" href="#cfg_SQLQuery_Explain" title="Permalink to this definition">¶</a></dt>
  4773. <dd><dl class="field-list simple">
  4774. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4775. <dd class="field-odd"><p>boolean</p>
  4776. </dd>
  4777. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4778. <dd class="field-even"><p>true</p>
  4779. </dd>
  4780. </dl>
  4781. <p>Whether to display a link to explain a SELECT query in any SQL Query
  4782. box.</p>
  4783. </dd></dl>
  4784. <dl class="config option">
  4785. <dt class="sig sig-object config" id="cfg_SQLQuery_ShowAsPHP">
  4786. <span class="sig-name descname"><span class="pre">$cfg['SQLQuery']['ShowAsPHP']</span></span><a class="headerlink" href="#cfg_SQLQuery_ShowAsPHP" title="Permalink to this definition">¶</a></dt>
  4787. <dd><dl class="field-list simple">
  4788. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4789. <dd class="field-odd"><p>boolean</p>
  4790. </dd>
  4791. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4792. <dd class="field-even"><p>true</p>
  4793. </dd>
  4794. </dl>
  4795. <p>Whether to display a link to wrap a query in PHP code in any SQL Query
  4796. box.</p>
  4797. </dd></dl>
  4798. <dl class="config option">
  4799. <dt class="sig sig-object config" id="cfg_SQLQuery_Refresh">
  4800. <span class="sig-name descname"><span class="pre">$cfg['SQLQuery']['Refresh']</span></span><a class="headerlink" href="#cfg_SQLQuery_Refresh" title="Permalink to this definition">¶</a></dt>
  4801. <dd><dl class="field-list simple">
  4802. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4803. <dd class="field-odd"><p>boolean</p>
  4804. </dd>
  4805. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4806. <dd class="field-even"><p>true</p>
  4807. </dd>
  4808. </dl>
  4809. <p>Whether to display a link to refresh a query in any SQL Query box.</p>
  4810. </dd></dl>
  4811. </section>
  4812. <section id="web-server-upload-save-import-directories">
  4813. <span id="web-dirs"></span><h2>Web server upload/save/import directories<a class="headerlink" href="#web-server-upload-save-import-directories" title="Permalink to this heading">¶</a></h2>
  4814. <p>If PHP is running in safe mode, all directories must be owned by the same user
  4815. as the owner of the phpMyAdmin scripts.</p>
  4816. <p>If the directory where phpMyAdmin is installed is subject to an
  4817. <code class="docutils literal notranslate"><span class="pre">open_basedir</span></code> restriction, you need to create a temporary directory in some
  4818. directory accessible by the PHP interpreter.</p>
  4819. <p>For security reasons, all directories should be outside the tree published by
  4820. webserver. If you cannot avoid having this directory published by webserver,
  4821. limit access to it either by web server configuration (for example using
  4822. .htaccess or web.config files) or place at least an empty <code class="file docutils literal notranslate"><span class="pre">index.html</span></code>
  4823. file there, so that directory listing is not possible. However as long as the
  4824. directory is accessible by web server, an attacker can guess filenames to download
  4825. the files.</p>
  4826. <dl class="config option">
  4827. <dt class="sig sig-object config" id="cfg_UploadDir">
  4828. <span class="sig-name descname"><span class="pre">$cfg['UploadDir']</span></span><a class="headerlink" href="#cfg_UploadDir" title="Permalink to this definition">¶</a></dt>
  4829. <dd><dl class="field-list simple">
  4830. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4831. <dd class="field-odd"><p>string</p>
  4832. </dd>
  4833. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4834. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  4835. </dd>
  4836. </dl>
  4837. <p>The name of the directory where <a class="reference internal" href="glossary.html#term-SQL"><span class="xref std std-term">SQL</span></a> files have been uploaded by
  4838. other means than phpMyAdmin (for example, FTP). Those files are available
  4839. under a drop-down box when you click the database or table name, then the
  4840. Import tab.</p>
  4841. <p>If
  4842. you want different directory for each user, %u will be replaced with
  4843. username.</p>
  4844. <p>Please note that the file names must have the suffix “.sql”
  4845. (or “.sql.bz2” or “.sql.gz” if support for compressed formats is
  4846. enabled).</p>
  4847. <p>This feature is useful when your file is too big to be
  4848. uploaded via <a class="reference internal" href="glossary.html#term-HTTP"><span class="xref std std-term">HTTP</span></a>, or when file
  4849. uploads are disabled in PHP.</p>
  4850. <div class="admonition warning">
  4851. <p class="admonition-title">Warning</p>
  4852. <p>Please see top of this chapter (<a class="reference internal" href="#web-dirs"><span class="std std-ref">Web server upload/save/import directories</span></a>) for instructions how
  4853. to setup this directory and how to make its usage secure.</p>
  4854. </div>
  4855. <div class="admonition seealso">
  4856. <p class="admonition-title">See also</p>
  4857. <p>See <a class="reference internal" href="faq.html#faq1-16"><span class="std std-ref">1.16 I cannot upload big dump files (memory, HTTP or timeout problems).</span></a> for alternatives.</p>
  4858. </div>
  4859. </dd></dl>
  4860. <dl class="config option">
  4861. <dt class="sig sig-object config" id="cfg_SaveDir">
  4862. <span class="sig-name descname"><span class="pre">$cfg['SaveDir']</span></span><a class="headerlink" href="#cfg_SaveDir" title="Permalink to this definition">¶</a></dt>
  4863. <dd><dl class="field-list simple">
  4864. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4865. <dd class="field-odd"><p>string</p>
  4866. </dd>
  4867. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4868. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  4869. </dd>
  4870. </dl>
  4871. <p>The name of the webserver directory where exported files can be saved.</p>
  4872. <p>If you want a different directory for each user, %u will be replaced with the
  4873. username.</p>
  4874. <p>Please note that the directory must exist and has to be writable for
  4875. the user running webserver.</p>
  4876. <div class="admonition warning">
  4877. <p class="admonition-title">Warning</p>
  4878. <p>Please see top of this chapter (<a class="reference internal" href="#web-dirs"><span class="std std-ref">Web server upload/save/import directories</span></a>) for instructions how
  4879. to setup this directory and how to make its usage secure.</p>
  4880. </div>
  4881. </dd></dl>
  4882. <dl class="config option">
  4883. <dt class="sig sig-object config" id="cfg_TempDir">
  4884. <span class="sig-name descname"><span class="pre">$cfg['TempDir']</span></span><a class="headerlink" href="#cfg_TempDir" title="Permalink to this definition">¶</a></dt>
  4885. <dd><dl class="field-list simple">
  4886. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4887. <dd class="field-odd"><p>string</p>
  4888. </dd>
  4889. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4890. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'./tmp/'</span></code></p>
  4891. </dd>
  4892. </dl>
  4893. <p>The name of the directory where temporary files can be stored. It is used
  4894. for several purposes, currently:</p>
  4895. <ul class="simple">
  4896. <li><p>The templates cache which speeds up page loading.</p></li>
  4897. <li><p>ESRI Shapefiles import, see <a class="reference internal" href="faq.html#faq6-30"><span class="std std-ref">6.30 Import: How can I import ESRI Shapefiles?</span></a>.</p></li>
  4898. <li><p>To work around limitations of <code class="docutils literal notranslate"><span class="pre">open_basedir</span></code> for uploaded files, see
  4899. <a class="reference internal" href="faq.html#faq1-11"><span class="std std-ref">1.11 I get an ‘open_basedir restriction’ while uploading a file from the import tab.</span></a>.</p></li>
  4900. </ul>
  4901. <p>This directory should have as strict permissions as possible as the only
  4902. user required to access this directory is the one who runs the webserver.
  4903. If you have root privileges, simply make this user owner of this directory
  4904. and make it accessible only by it:</p>
  4905. <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>chown<span class="w"> </span>www-data:www-data<span class="w"> </span>tmp
  4906. chmod<span class="w"> </span><span class="m">700</span><span class="w"> </span>tmp
  4907. </pre></div>
  4908. </div>
  4909. <p>If you cannot change owner of the directory, you can achieve a similar
  4910. setup using <a class="reference internal" href="glossary.html#term-ACL"><span class="xref std std-term">ACL</span></a>:</p>
  4911. <div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>chmod<span class="w"> </span><span class="m">700</span><span class="w"> </span>tmp
  4912. setfacl<span class="w"> </span>-m<span class="w"> </span><span class="s2">&quot;g:www-data:rwx&quot;</span><span class="w"> </span>tmp
  4913. setfacl<span class="w"> </span>-d<span class="w"> </span>-m<span class="w"> </span><span class="s2">&quot;g:www-data:rwx&quot;</span><span class="w"> </span>tmp
  4914. </pre></div>
  4915. </div>
  4916. <p>If neither of above works for you, you can still make the directory
  4917. <strong class="command">chmod 777</strong>, but it might impose risk of other users on system
  4918. reading and writing data in this directory.</p>
  4919. <div class="admonition warning">
  4920. <p class="admonition-title">Warning</p>
  4921. <p>Please see top of this chapter (<a class="reference internal" href="#web-dirs"><span class="std std-ref">Web server upload/save/import directories</span></a>) for instructions how
  4922. to setup this directory and how to make its usage secure.</p>
  4923. </div>
  4924. </dd></dl>
  4925. </section>
  4926. <section id="various-display-setting">
  4927. <h2>Various display setting<a class="headerlink" href="#various-display-setting" title="Permalink to this heading">¶</a></h2>
  4928. <dl class="config option">
  4929. <dt class="sig sig-object config" id="cfg_RepeatCells">
  4930. <span class="sig-name descname"><span class="pre">$cfg['RepeatCells']</span></span><a class="headerlink" href="#cfg_RepeatCells" title="Permalink to this definition">¶</a></dt>
  4931. <dd><dl class="field-list simple">
  4932. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4933. <dd class="field-odd"><p>integer</p>
  4934. </dd>
  4935. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4936. <dd class="field-even"><p>100</p>
  4937. </dd>
  4938. </dl>
  4939. <p>Repeat the headers every X cells, or 0 to deactivate.</p>
  4940. </dd></dl>
  4941. <dl class="config option">
  4942. <dt class="sig sig-object config" id="cfg_EditInWindow">
  4943. <span class="sig-name descname"><span class="pre">$cfg['EditInWindow']</span></span><a class="headerlink" href="#cfg_EditInWindow" title="Permalink to this definition">¶</a></dt>
  4944. <dd><dl class="field-list simple">
  4945. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4946. <dd class="field-odd"><p>boolean</p>
  4947. </dd>
  4948. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4949. <dd class="field-even"><p>true</p>
  4950. </dd>
  4951. </dl>
  4952. <div class="admonition seealso">
  4953. <p class="admonition-title">See also</p>
  4954. <p><a class="reference external" href="https://github.com/phpmyadmin/phpmyadmin/issues/11983">Feature request to add a pop-up window back</a></p>
  4955. </div>
  4956. <div class="deprecated">
  4957. <p><span class="versionmodified deprecated">Deprecated since version 4.3.0: </span>This setting was removed.</p>
  4958. </div>
  4959. </dd></dl>
  4960. <dl class="config option">
  4961. <dt class="sig sig-object config" id="cfg_QueryWindowWidth">
  4962. <span class="sig-name descname"><span class="pre">$cfg['QueryWindowWidth']</span></span><a class="headerlink" href="#cfg_QueryWindowWidth" title="Permalink to this definition">¶</a></dt>
  4963. <dd><dl class="field-list simple">
  4964. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4965. <dd class="field-odd"><p>integer</p>
  4966. </dd>
  4967. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4968. <dd class="field-even"><p>550</p>
  4969. </dd>
  4970. </dl>
  4971. <div class="deprecated">
  4972. <p><span class="versionmodified deprecated">Deprecated since version 4.3.0: </span>This setting was removed.</p>
  4973. </div>
  4974. </dd></dl>
  4975. <dl class="config option">
  4976. <dt class="sig sig-object config" id="cfg_QueryWindowHeight">
  4977. <span class="sig-name descname"><span class="pre">$cfg['QueryWindowHeight']</span></span><a class="headerlink" href="#cfg_QueryWindowHeight" title="Permalink to this definition">¶</a></dt>
  4978. <dd><dl class="field-list simple">
  4979. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4980. <dd class="field-odd"><p>integer</p>
  4981. </dd>
  4982. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4983. <dd class="field-even"><p>310</p>
  4984. </dd>
  4985. </dl>
  4986. <div class="deprecated">
  4987. <p><span class="versionmodified deprecated">Deprecated since version 4.3.0: </span>This setting was removed.</p>
  4988. </div>
  4989. </dd></dl>
  4990. <dl class="config option">
  4991. <dt class="sig sig-object config" id="cfg_QueryHistoryDB">
  4992. <span class="sig-name descname"><span class="pre">$cfg['QueryHistoryDB']</span></span><a class="headerlink" href="#cfg_QueryHistoryDB" title="Permalink to this definition">¶</a></dt>
  4993. <dd><dl class="field-list simple">
  4994. <dt class="field-odd">Type<span class="colon">:</span></dt>
  4995. <dd class="field-odd"><p>boolean</p>
  4996. </dd>
  4997. <dt class="field-even">Default value<span class="colon">:</span></dt>
  4998. <dd class="field-even"><p>false</p>
  4999. </dd>
  5000. </dl>
  5001. </dd></dl>
  5002. <dl class="config option">
  5003. <dt class="sig sig-object config" id="cfg_QueryWindowDefTab">
  5004. <span class="sig-name descname"><span class="pre">$cfg['QueryWindowDefTab']</span></span><a class="headerlink" href="#cfg_QueryWindowDefTab" title="Permalink to this definition">¶</a></dt>
  5005. <dd><dl class="field-list simple">
  5006. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5007. <dd class="field-odd"><p>string</p>
  5008. </dd>
  5009. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5010. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'sql'</span></code></p>
  5011. </dd>
  5012. </dl>
  5013. <div class="deprecated">
  5014. <p><span class="versionmodified deprecated">Deprecated since version 4.3.0: </span>This setting was removed.</p>
  5015. </div>
  5016. </dd></dl>
  5017. <dl class="config option">
  5018. <dt class="sig sig-object config" id="cfg_QueryHistoryMax">
  5019. <span class="sig-name descname"><span class="pre">$cfg['QueryHistoryMax']</span></span><a class="headerlink" href="#cfg_QueryHistoryMax" title="Permalink to this definition">¶</a></dt>
  5020. <dd><dl class="field-list simple">
  5021. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5022. <dd class="field-odd"><p>integer</p>
  5023. </dd>
  5024. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5025. <dd class="field-even"><p>25</p>
  5026. </dd>
  5027. </dl>
  5028. <p>If <span class="target" id="index-156"></span><a class="reference internal" href="#cfg_QueryHistoryDB"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['QueryHistoryDB']</span></code></a> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, all your
  5029. Queries are logged to a table, which has to be created by you (see
  5030. <span class="target" id="index-157"></span><a class="reference internal" href="#cfg_Servers_history"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['history']</span></code></a>). If set to false, all your
  5031. queries will be appended to the form, but only as long as your window is
  5032. opened they remain saved.</p>
  5033. <p>When using the JavaScript based query window, it will always get updated
  5034. when you click on a new table/db to browse and will focus if you click on
  5035. <span class="guilabel">Edit SQL</span> after using a query. You can suppress updating the
  5036. query window by checking the box <span class="guilabel">Do not overwrite this query
  5037. from outside the window</span> below the query textarea. Then you can browse
  5038. tables/databases in the background without losing the contents of the
  5039. textarea, so this is especially useful when composing a query with tables
  5040. you first have to look in. The checkbox will get automatically checked
  5041. whenever you change the contents of the textarea. Please uncheck the button
  5042. whenever you definitely want the query window to get updated even though
  5043. you have made alterations.</p>
  5044. <p>If <span class="target" id="index-158"></span><a class="reference internal" href="#cfg_QueryHistoryDB"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['QueryHistoryDB']</span></code></a> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code> you can
  5045. specify the amount of saved history items using
  5046. <span class="target" id="index-159"></span><a class="reference internal" href="#cfg_QueryHistoryMax"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['QueryHistoryMax']</span></code></a>.</p>
  5047. </dd></dl>
  5048. <dl class="config option">
  5049. <dt class="sig sig-object config" id="cfg_BrowseMIME">
  5050. <span class="sig-name descname"><span class="pre">$cfg['BrowseMIME']</span></span><a class="headerlink" href="#cfg_BrowseMIME" title="Permalink to this definition">¶</a></dt>
  5051. <dd><dl class="field-list simple">
  5052. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5053. <dd class="field-odd"><p>boolean</p>
  5054. </dd>
  5055. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5056. <dd class="field-even"><p>true</p>
  5057. </dd>
  5058. </dl>
  5059. <p>Enable <a class="reference internal" href="transformations.html#transformations"><span class="std std-ref">Transformations</span></a>.</p>
  5060. </dd></dl>
  5061. <dl class="config option">
  5062. <dt class="sig sig-object config" id="cfg_MaxExactCount">
  5063. <span class="sig-name descname"><span class="pre">$cfg['MaxExactCount']</span></span><a class="headerlink" href="#cfg_MaxExactCount" title="Permalink to this definition">¶</a></dt>
  5064. <dd><dl class="field-list simple">
  5065. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5066. <dd class="field-odd"><p>integer</p>
  5067. </dd>
  5068. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5069. <dd class="field-even"><p>50000</p>
  5070. </dd>
  5071. </dl>
  5072. <p>For InnoDB tables, determines for how large tables phpMyAdmin should
  5073. get the exact row count using <code class="docutils literal notranslate"><span class="pre">SELECT</span> <span class="pre">COUNT</span></code>. If the approximate row
  5074. count as returned by <code class="docutils literal notranslate"><span class="pre">SHOW</span> <span class="pre">TABLE</span> <span class="pre">STATUS</span></code> is smaller than this value,
  5075. <code class="docutils literal notranslate"><span class="pre">SELECT</span> <span class="pre">COUNT</span></code> will be used, otherwise the approximate count will be
  5076. used.</p>
  5077. <div class="versionchanged">
  5078. <p><span class="versionmodified changed">Changed in version 4.8.0: </span>The default value was lowered to 50000 for performance reasons.</p>
  5079. </div>
  5080. <div class="versionchanged">
  5081. <p><span class="versionmodified changed">Changed in version 4.2.6: </span>The default value was changed to 500000.</p>
  5082. </div>
  5083. <div class="admonition seealso">
  5084. <p class="admonition-title">See also</p>
  5085. <p><a class="reference internal" href="faq.html#faq3-11"><span class="std std-ref">3.11 The number of rows for InnoDB tables is not correct.</span></a></p>
  5086. </div>
  5087. </dd></dl>
  5088. <dl class="config option">
  5089. <dt class="sig sig-object config" id="cfg_MaxExactCountViews">
  5090. <span class="sig-name descname"><span class="pre">$cfg['MaxExactCountViews']</span></span><a class="headerlink" href="#cfg_MaxExactCountViews" title="Permalink to this definition">¶</a></dt>
  5091. <dd><dl class="field-list simple">
  5092. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5093. <dd class="field-odd"><p>integer</p>
  5094. </dd>
  5095. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5096. <dd class="field-even"><p>0</p>
  5097. </dd>
  5098. </dl>
  5099. <p>For VIEWs, since obtaining the exact count could have an impact on
  5100. performance, this value is the maximum to be displayed, using a
  5101. <code class="docutils literal notranslate"><span class="pre">SELECT</span> <span class="pre">COUNT</span> <span class="pre">...</span> <span class="pre">LIMIT</span></code>. Setting this to 0 bypasses any row
  5102. counting.</p>
  5103. </dd></dl>
  5104. <dl class="config option">
  5105. <dt class="sig sig-object config" id="cfg_NaturalOrder">
  5106. <span class="sig-name descname"><span class="pre">$cfg['NaturalOrder']</span></span><a class="headerlink" href="#cfg_NaturalOrder" title="Permalink to this definition">¶</a></dt>
  5107. <dd><dl class="field-list simple">
  5108. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5109. <dd class="field-odd"><p>boolean</p>
  5110. </dd>
  5111. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5112. <dd class="field-even"><p>true</p>
  5113. </dd>
  5114. </dl>
  5115. <p>Sorts database and table names according to natural order (for
  5116. example, t1, t2, t10). Currently implemented in the navigation panel
  5117. and in Database view, for the table list.</p>
  5118. </dd></dl>
  5119. <dl class="config option">
  5120. <dt class="sig sig-object config" id="cfg_InitialSlidersState">
  5121. <span class="sig-name descname"><span class="pre">$cfg['InitialSlidersState']</span></span><a class="headerlink" href="#cfg_InitialSlidersState" title="Permalink to this definition">¶</a></dt>
  5122. <dd><dl class="field-list simple">
  5123. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5124. <dd class="field-odd"><p>string</p>
  5125. </dd>
  5126. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5127. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'closed'</span></code></p>
  5128. </dd>
  5129. </dl>
  5130. <p>If set to <code class="docutils literal notranslate"><span class="pre">'closed'</span></code>, the visual sliders are initially in a closed
  5131. state. A value of <code class="docutils literal notranslate"><span class="pre">'open'</span></code> does the reverse. To completely disable
  5132. all visual sliders, use <code class="docutils literal notranslate"><span class="pre">'disabled'</span></code>.</p>
  5133. </dd></dl>
  5134. <dl class="config option">
  5135. <dt class="sig sig-object config" id="cfg_UserprefsDisallow">
  5136. <span class="sig-name descname"><span class="pre">$cfg['UserprefsDisallow']</span></span><a class="headerlink" href="#cfg_UserprefsDisallow" title="Permalink to this definition">¶</a></dt>
  5137. <dd><dl class="field-list simple">
  5138. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5139. <dd class="field-odd"><p>array</p>
  5140. </dd>
  5141. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5142. <dd class="field-even"><p>array()</p>
  5143. </dd>
  5144. </dl>
  5145. <p>Contains names of configuration options (keys in <code class="docutils literal notranslate"><span class="pre">$cfg</span></code> array) that
  5146. users can’t set through user preferences. For possible values, refer
  5147. to classes under <code class="file docutils literal notranslate"><span class="pre">libraries/classes/Config/Forms/User/</span></code>.</p>
  5148. </dd></dl>
  5149. <dl class="config option">
  5150. <dt class="sig sig-object config" id="cfg_UserprefsDeveloperTab">
  5151. <span class="sig-name descname"><span class="pre">$cfg['UserprefsDeveloperTab']</span></span><a class="headerlink" href="#cfg_UserprefsDeveloperTab" title="Permalink to this definition">¶</a></dt>
  5152. <dd><dl class="field-list simple">
  5153. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5154. <dd class="field-odd"><p>boolean</p>
  5155. </dd>
  5156. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5157. <dd class="field-even"><p>false</p>
  5158. </dd>
  5159. </dl>
  5160. <div class="versionadded">
  5161. <p><span class="versionmodified added">New in version 3.4.0.</span></p>
  5162. </div>
  5163. <p>Activates in the user preferences a tab containing options for
  5164. developers of phpMyAdmin.</p>
  5165. </dd></dl>
  5166. </section>
  5167. <section id="page-titles">
  5168. <h2>Page titles<a class="headerlink" href="#page-titles" title="Permalink to this heading">¶</a></h2>
  5169. <p>The page title displayed by your browser’s window or tab title bar can be customized. You can use <a class="reference internal" href="faq.html#faq6-27"><span class="std std-ref">6.27 What format strings can I use?</span></a>.
  5170. The following four options allow customizing various parts of the phpMyAdmin interface. Note that the login page
  5171. title cannot be changed.</p>
  5172. <dl class="config option">
  5173. <dt class="sig sig-object config" id="cfg_TitleTable">
  5174. <span class="sig-name descname"><span class="pre">$cfg['TitleTable']</span></span><a class="headerlink" href="#cfg_TitleTable" title="Permalink to this definition">¶</a></dt>
  5175. <dd><dl class="field-list simple">
  5176. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5177. <dd class="field-odd"><p>string</p>
  5178. </dd>
  5179. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5180. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'&#64;HTTP_HOST&#64;</span> <span class="pre">/</span> <span class="pre">&#64;VSERVER&#64;</span> <span class="pre">/</span> <span class="pre">&#64;DATABASE&#64;</span> <span class="pre">/</span> <span class="pre">&#64;TABLE&#64;</span> <span class="pre">|</span> <span class="pre">&#64;PHPMYADMIN&#64;'</span></code></p>
  5181. </dd>
  5182. </dl>
  5183. </dd></dl>
  5184. <dl class="config option">
  5185. <dt class="sig sig-object config" id="cfg_TitleDatabase">
  5186. <span class="sig-name descname"><span class="pre">$cfg['TitleDatabase']</span></span><a class="headerlink" href="#cfg_TitleDatabase" title="Permalink to this definition">¶</a></dt>
  5187. <dd><dl class="field-list simple">
  5188. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5189. <dd class="field-odd"><p>string</p>
  5190. </dd>
  5191. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5192. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'&#64;HTTP_HOST&#64;</span> <span class="pre">/</span> <span class="pre">&#64;VSERVER&#64;</span> <span class="pre">/</span> <span class="pre">&#64;DATABASE&#64;</span> <span class="pre">|</span> <span class="pre">&#64;PHPMYADMIN&#64;'</span></code></p>
  5193. </dd>
  5194. </dl>
  5195. </dd></dl>
  5196. <dl class="config option">
  5197. <dt class="sig sig-object config" id="cfg_TitleServer">
  5198. <span class="sig-name descname"><span class="pre">$cfg['TitleServer']</span></span><a class="headerlink" href="#cfg_TitleServer" title="Permalink to this definition">¶</a></dt>
  5199. <dd><dl class="field-list simple">
  5200. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5201. <dd class="field-odd"><p>string</p>
  5202. </dd>
  5203. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5204. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'&#64;HTTP_HOST&#64;</span> <span class="pre">/</span> <span class="pre">&#64;VSERVER&#64;</span> <span class="pre">|</span> <span class="pre">&#64;PHPMYADMIN&#64;'</span></code></p>
  5205. </dd>
  5206. </dl>
  5207. </dd></dl>
  5208. <dl class="config option">
  5209. <dt class="sig sig-object config" id="cfg_TitleDefault">
  5210. <span class="sig-name descname"><span class="pre">$cfg['TitleDefault']</span></span><a class="headerlink" href="#cfg_TitleDefault" title="Permalink to this definition">¶</a></dt>
  5211. <dd><dl class="field-list simple">
  5212. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5213. <dd class="field-odd"><p>string</p>
  5214. </dd>
  5215. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5216. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'&#64;HTTP_HOST&#64;</span> <span class="pre">|</span> <span class="pre">&#64;PHPMYADMIN&#64;'</span></code></p>
  5217. </dd>
  5218. </dl>
  5219. </dd></dl>
  5220. </section>
  5221. <section id="theme-manager-settings">
  5222. <h2>Theme manager settings<a class="headerlink" href="#theme-manager-settings" title="Permalink to this heading">¶</a></h2>
  5223. <dl class="config option">
  5224. <dt class="sig sig-object config" id="cfg_ThemeManager">
  5225. <span class="sig-name descname"><span class="pre">$cfg['ThemeManager']</span></span><a class="headerlink" href="#cfg_ThemeManager" title="Permalink to this definition">¶</a></dt>
  5226. <dd><dl class="field-list simple">
  5227. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5228. <dd class="field-odd"><p>boolean</p>
  5229. </dd>
  5230. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5231. <dd class="field-even"><p>true</p>
  5232. </dd>
  5233. </dl>
  5234. <p>Enables user-selectable themes. See <a class="reference internal" href="faq.html#faqthemes"><span class="std std-ref">2.7 Using and creating themes</span></a>.</p>
  5235. </dd></dl>
  5236. <dl class="config option">
  5237. <dt class="sig sig-object config" id="cfg_ThemeDefault">
  5238. <span class="sig-name descname"><span class="pre">$cfg['ThemeDefault']</span></span><a class="headerlink" href="#cfg_ThemeDefault" title="Permalink to this definition">¶</a></dt>
  5239. <dd><dl class="field-list simple">
  5240. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5241. <dd class="field-odd"><p>string</p>
  5242. </dd>
  5243. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5244. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'pmahomme'</span></code></p>
  5245. </dd>
  5246. </dl>
  5247. <p>The default theme (a subdirectory under <code class="file docutils literal notranslate"><span class="pre">./themes/</span></code>).</p>
  5248. </dd></dl>
  5249. <dl class="config option">
  5250. <dt class="sig sig-object config" id="cfg_ThemePerServer">
  5251. <span class="sig-name descname"><span class="pre">$cfg['ThemePerServer']</span></span><a class="headerlink" href="#cfg_ThemePerServer" title="Permalink to this definition">¶</a></dt>
  5252. <dd><dl class="field-list simple">
  5253. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5254. <dd class="field-odd"><p>boolean</p>
  5255. </dd>
  5256. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5257. <dd class="field-even"><p>false</p>
  5258. </dd>
  5259. </dl>
  5260. <p>Whether to allow different theme for each server.</p>
  5261. </dd></dl>
  5262. <dl class="config option">
  5263. <dt class="sig sig-object config" id="cfg_FontSize">
  5264. <span class="sig-name descname"><span class="pre">$cfg['FontSize']</span></span><a class="headerlink" href="#cfg_FontSize" title="Permalink to this definition">¶</a></dt>
  5265. <dd><dl class="field-list simple">
  5266. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5267. <dd class="field-odd"><p>string</p>
  5268. </dd>
  5269. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5270. <dd class="field-even"><p>‘82%’</p>
  5271. </dd>
  5272. </dl>
  5273. <div class="deprecated">
  5274. <p><span class="versionmodified deprecated">Deprecated since version 5.0.0: </span>This setting was removed as the browser is more efficient,
  5275. thus no need of this option.</p>
  5276. </div>
  5277. <p>Font size to use, is applied in CSS.</p>
  5278. </dd></dl>
  5279. </section>
  5280. <section id="default-queries">
  5281. <h2>Default queries<a class="headerlink" href="#default-queries" title="Permalink to this heading">¶</a></h2>
  5282. <dl class="config option">
  5283. <dt class="sig sig-object config" id="cfg_DefaultQueryTable">
  5284. <span class="sig-name descname"><span class="pre">$cfg['DefaultQueryTable']</span></span><a class="headerlink" href="#cfg_DefaultQueryTable" title="Permalink to this definition">¶</a></dt>
  5285. <dd><dl class="field-list simple">
  5286. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5287. <dd class="field-odd"><p>string</p>
  5288. </dd>
  5289. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5290. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'SELECT</span> <span class="pre">*</span> <span class="pre">FROM</span> <span class="pre">&#64;TABLE&#64;</span> <span class="pre">WHERE</span> <span class="pre">1'</span></code></p>
  5291. </dd>
  5292. </dl>
  5293. </dd></dl>
  5294. <dl class="config option">
  5295. <dt class="sig sig-object config" id="cfg_DefaultQueryDatabase">
  5296. <span class="sig-name descname"><span class="pre">$cfg['DefaultQueryDatabase']</span></span><a class="headerlink" href="#cfg_DefaultQueryDatabase" title="Permalink to this definition">¶</a></dt>
  5297. <dd><dl class="field-list simple">
  5298. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5299. <dd class="field-odd"><p>string</p>
  5300. </dd>
  5301. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5302. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
  5303. </dd>
  5304. </dl>
  5305. <p>Default queries that will be displayed in query boxes when user didn’t
  5306. specify any. You can use standard <a class="reference internal" href="faq.html#faq6-27"><span class="std std-ref">6.27 What format strings can I use?</span></a>.</p>
  5307. </dd></dl>
  5308. </section>
  5309. <section id="mysql-settings">
  5310. <h2>MySQL settings<a class="headerlink" href="#mysql-settings" title="Permalink to this heading">¶</a></h2>
  5311. <dl class="config option">
  5312. <dt class="sig sig-object config" id="cfg_DefaultFunctions">
  5313. <span class="sig-name descname"><span class="pre">$cfg['DefaultFunctions']</span></span><a class="headerlink" href="#cfg_DefaultFunctions" title="Permalink to this definition">¶</a></dt>
  5314. <dd><dl class="field-list simple">
  5315. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5316. <dd class="field-odd"><p>array</p>
  5317. </dd>
  5318. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5319. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">array('FUNC_CHAR'</span> <span class="pre">=&gt;</span> <span class="pre">'',</span> <span class="pre">'FUNC_DATE'</span> <span class="pre">=&gt;</span> <span class="pre">'',</span> <span class="pre">'FUNC_NUMBER'</span> <span class="pre">=&gt;</span> <span class="pre">'',</span> <span class="pre">'FUNC_SPATIAL'</span> <span class="pre">=&gt;</span> <span class="pre">'GeomFromText',</span> <span class="pre">'FUNC_UUID'</span> <span class="pre">=&gt;</span> <span class="pre">'UUID',</span> <span class="pre">'first_timestamp'</span> <span class="pre">=&gt;</span> <span class="pre">'NOW')</span></code></p>
  5320. </dd>
  5321. </dl>
  5322. <p>Functions selected by default when inserting/changing row, Functions
  5323. are defined for meta types as (<code class="docutils literal notranslate"><span class="pre">FUNC_NUMBER</span></code>, <code class="docutils literal notranslate"><span class="pre">FUNC_DATE</span></code>, <code class="docutils literal notranslate"><span class="pre">FUNC_CHAR</span></code>,
  5324. <code class="docutils literal notranslate"><span class="pre">FUNC_SPATIAL</span></code>, <code class="docutils literal notranslate"><span class="pre">FUNC_UUID</span></code>) and for <code class="docutils literal notranslate"><span class="pre">first_timestamp</span></code>, which is used
  5325. for first timestamp column in table.</p>
  5326. <p>Example configuration</p>
  5327. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;DefaultFunctions&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span>
  5328. <span class="s1">&#39;FUNC_CHAR&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
  5329. <span class="s1">&#39;FUNC_DATE&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
  5330. <span class="s1">&#39;FUNC_NUMBER&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;&#39;</span><span class="p">,</span>
  5331. <span class="s1">&#39;FUNC_SPATIAL&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;ST_GeomFromText&#39;</span><span class="p">,</span>
  5332. <span class="s1">&#39;FUNC_UUID&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;UUID&#39;</span><span class="p">,</span>
  5333. <span class="s1">&#39;first_timestamp&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;UTC_TIMESTAMP&#39;</span><span class="p">,</span>
  5334. <span class="p">];</span>
  5335. </pre></div>
  5336. </div>
  5337. </dd></dl>
  5338. </section>
  5339. <section id="default-options-for-transformations">
  5340. <h2>Default options for Transformations<a class="headerlink" href="#default-options-for-transformations" title="Permalink to this heading">¶</a></h2>
  5341. <dl class="config option">
  5342. <dt class="sig sig-object config" id="cfg_DefaultTransformations">
  5343. <span class="sig-name descname"><span class="pre">$cfg['DefaultTransformations']</span></span><a class="headerlink" href="#cfg_DefaultTransformations" title="Permalink to this definition">¶</a></dt>
  5344. <dd><dl class="field-list simple">
  5345. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5346. <dd class="field-odd"><p>array</p>
  5347. </dd>
  5348. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5349. <dd class="field-even"><p>An array with below listed key-values</p>
  5350. </dd>
  5351. </dl>
  5352. </dd></dl>
  5353. <dl class="config option">
  5354. <dt class="sig sig-object config" id="cfg_DefaultTransformations_Substring">
  5355. <span class="sig-name descname"><span class="pre">$cfg['DefaultTransformations']['Substring']</span></span><a class="headerlink" href="#cfg_DefaultTransformations_Substring" title="Permalink to this definition">¶</a></dt>
  5356. <dd><dl class="field-list simple">
  5357. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5358. <dd class="field-odd"><p>array</p>
  5359. </dd>
  5360. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5361. <dd class="field-even"><p>array(0, ‘all’, ‘…’)</p>
  5362. </dd>
  5363. </dl>
  5364. </dd></dl>
  5365. <dl class="config option">
  5366. <dt class="sig sig-object config" id="cfg_DefaultTransformations_Bool2Text">
  5367. <span class="sig-name descname"><span class="pre">$cfg['DefaultTransformations']['Bool2Text']</span></span><a class="headerlink" href="#cfg_DefaultTransformations_Bool2Text" title="Permalink to this definition">¶</a></dt>
  5368. <dd><dl class="field-list simple">
  5369. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5370. <dd class="field-odd"><p>array</p>
  5371. </dd>
  5372. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5373. <dd class="field-even"><p>array(‘T’, ‘F’)</p>
  5374. </dd>
  5375. </dl>
  5376. </dd></dl>
  5377. <dl class="config option">
  5378. <dt class="sig sig-object config" id="cfg_DefaultTransformations_External">
  5379. <span class="sig-name descname"><span class="pre">$cfg['DefaultTransformations']['External']</span></span><a class="headerlink" href="#cfg_DefaultTransformations_External" title="Permalink to this definition">¶</a></dt>
  5380. <dd><dl class="field-list simple">
  5381. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5382. <dd class="field-odd"><p>array</p>
  5383. </dd>
  5384. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5385. <dd class="field-even"><p>array(0, ‘-f /dev/null -i -wrap -q’, 1, 1)</p>
  5386. </dd>
  5387. </dl>
  5388. </dd></dl>
  5389. <dl class="config option">
  5390. <dt class="sig sig-object config" id="cfg_DefaultTransformations_PreApPend">
  5391. <span class="sig-name descname"><span class="pre">$cfg['DefaultTransformations']['PreApPend']</span></span><a class="headerlink" href="#cfg_DefaultTransformations_PreApPend" title="Permalink to this definition">¶</a></dt>
  5392. <dd><dl class="field-list simple">
  5393. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5394. <dd class="field-odd"><p>array</p>
  5395. </dd>
  5396. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5397. <dd class="field-even"><p>array(‘’, ‘’)</p>
  5398. </dd>
  5399. </dl>
  5400. </dd></dl>
  5401. <dl class="config option">
  5402. <dt class="sig sig-object config" id="cfg_DefaultTransformations_Hex">
  5403. <span class="sig-name descname"><span class="pre">$cfg['DefaultTransformations']['Hex']</span></span><a class="headerlink" href="#cfg_DefaultTransformations_Hex" title="Permalink to this definition">¶</a></dt>
  5404. <dd><dl class="field-list simple">
  5405. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5406. <dd class="field-odd"><p>array</p>
  5407. </dd>
  5408. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5409. <dd class="field-even"><p>array(‘2’)</p>
  5410. </dd>
  5411. </dl>
  5412. </dd></dl>
  5413. <dl class="config option">
  5414. <dt class="sig sig-object config" id="cfg_DefaultTransformations_DateFormat">
  5415. <span class="sig-name descname"><span class="pre">$cfg['DefaultTransformations']['DateFormat']</span></span><a class="headerlink" href="#cfg_DefaultTransformations_DateFormat" title="Permalink to this definition">¶</a></dt>
  5416. <dd><dl class="field-list simple">
  5417. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5418. <dd class="field-odd"><p>array</p>
  5419. </dd>
  5420. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5421. <dd class="field-even"><p>array(0, ‘’, ‘local’)</p>
  5422. </dd>
  5423. </dl>
  5424. </dd></dl>
  5425. <dl class="config option">
  5426. <dt class="sig sig-object config" id="cfg_DefaultTransformations_Inline">
  5427. <span class="sig-name descname"><span class="pre">$cfg['DefaultTransformations']['Inline']</span></span><a class="headerlink" href="#cfg_DefaultTransformations_Inline" title="Permalink to this definition">¶</a></dt>
  5428. <dd><dl class="field-list simple">
  5429. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5430. <dd class="field-odd"><p>array</p>
  5431. </dd>
  5432. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5433. <dd class="field-even"><p>array(‘100’, 100)</p>
  5434. </dd>
  5435. </dl>
  5436. </dd></dl>
  5437. <dl class="config option">
  5438. <dt class="sig sig-object config" id="cfg_DefaultTransformations_TextImageLink">
  5439. <span class="sig-name descname"><span class="pre">$cfg['DefaultTransformations']['TextImageLink']</span></span><a class="headerlink" href="#cfg_DefaultTransformations_TextImageLink" title="Permalink to this definition">¶</a></dt>
  5440. <dd><dl class="field-list simple">
  5441. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5442. <dd class="field-odd"><p>array</p>
  5443. </dd>
  5444. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5445. <dd class="field-even"><p>array(‘’, 100, 50)</p>
  5446. </dd>
  5447. </dl>
  5448. </dd></dl>
  5449. <dl class="config option">
  5450. <dt class="sig sig-object config" id="cfg_DefaultTransformations_TextLink">
  5451. <span class="sig-name descname"><span class="pre">$cfg['DefaultTransformations']['TextLink']</span></span><a class="headerlink" href="#cfg_DefaultTransformations_TextLink" title="Permalink to this definition">¶</a></dt>
  5452. <dd><dl class="field-list simple">
  5453. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5454. <dd class="field-odd"><p>array</p>
  5455. </dd>
  5456. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5457. <dd class="field-even"><p>array(‘’, ‘’, ‘’)</p>
  5458. </dd>
  5459. </dl>
  5460. </dd></dl>
  5461. </section>
  5462. <section id="console-settings">
  5463. <h2>Console settings<a class="headerlink" href="#console-settings" title="Permalink to this heading">¶</a></h2>
  5464. <div class="admonition note">
  5465. <p class="admonition-title">Note</p>
  5466. <p>These settings are mostly meant to be changed by user.</p>
  5467. </div>
  5468. <dl class="config option">
  5469. <dt class="sig sig-object config" id="cfg_Console_StartHistory">
  5470. <span class="sig-name descname"><span class="pre">$cfg['Console']['StartHistory']</span></span><a class="headerlink" href="#cfg_Console_StartHistory" title="Permalink to this definition">¶</a></dt>
  5471. <dd><dl class="field-list simple">
  5472. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5473. <dd class="field-odd"><p>boolean</p>
  5474. </dd>
  5475. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5476. <dd class="field-even"><p>false</p>
  5477. </dd>
  5478. </dl>
  5479. <p>Show query history at start</p>
  5480. </dd></dl>
  5481. <dl class="config option">
  5482. <dt class="sig sig-object config" id="cfg_Console_AlwaysExpand">
  5483. <span class="sig-name descname"><span class="pre">$cfg['Console']['AlwaysExpand']</span></span><a class="headerlink" href="#cfg_Console_AlwaysExpand" title="Permalink to this definition">¶</a></dt>
  5484. <dd><dl class="field-list simple">
  5485. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5486. <dd class="field-odd"><p>boolean</p>
  5487. </dd>
  5488. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5489. <dd class="field-even"><p>false</p>
  5490. </dd>
  5491. </dl>
  5492. <p>Always expand query messages</p>
  5493. </dd></dl>
  5494. <dl class="config option">
  5495. <dt class="sig sig-object config" id="cfg_Console_CurrentQuery">
  5496. <span class="sig-name descname"><span class="pre">$cfg['Console']['CurrentQuery']</span></span><a class="headerlink" href="#cfg_Console_CurrentQuery" title="Permalink to this definition">¶</a></dt>
  5497. <dd><dl class="field-list simple">
  5498. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5499. <dd class="field-odd"><p>boolean</p>
  5500. </dd>
  5501. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5502. <dd class="field-even"><p>true</p>
  5503. </dd>
  5504. </dl>
  5505. <p>Show current browsing query</p>
  5506. </dd></dl>
  5507. <dl class="config option">
  5508. <dt class="sig sig-object config" id="cfg_Console_EnterExecutes">
  5509. <span class="sig-name descname"><span class="pre">$cfg['Console']['EnterExecutes']</span></span><a class="headerlink" href="#cfg_Console_EnterExecutes" title="Permalink to this definition">¶</a></dt>
  5510. <dd><dl class="field-list simple">
  5511. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5512. <dd class="field-odd"><p>boolean</p>
  5513. </dd>
  5514. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5515. <dd class="field-even"><p>false</p>
  5516. </dd>
  5517. </dl>
  5518. <p>Execute queries on Enter and insert new line with Shift+Enter</p>
  5519. </dd></dl>
  5520. <dl class="config option">
  5521. <dt class="sig sig-object config" id="cfg_Console_DarkTheme">
  5522. <span class="sig-name descname"><span class="pre">$cfg['Console']['DarkTheme']</span></span><a class="headerlink" href="#cfg_Console_DarkTheme" title="Permalink to this definition">¶</a></dt>
  5523. <dd><dl class="field-list simple">
  5524. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5525. <dd class="field-odd"><p>boolean</p>
  5526. </dd>
  5527. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5528. <dd class="field-even"><p>false</p>
  5529. </dd>
  5530. </dl>
  5531. <p>Switch to dark theme</p>
  5532. </dd></dl>
  5533. <dl class="config option">
  5534. <dt class="sig sig-object config" id="cfg_Console_Mode">
  5535. <span class="sig-name descname"><span class="pre">$cfg['Console']['Mode']</span></span><a class="headerlink" href="#cfg_Console_Mode" title="Permalink to this definition">¶</a></dt>
  5536. <dd><dl class="field-list simple">
  5537. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5538. <dd class="field-odd"><p>string</p>
  5539. </dd>
  5540. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5541. <dd class="field-even"><p>‘info’</p>
  5542. </dd>
  5543. </dl>
  5544. <p>Console mode</p>
  5545. </dd></dl>
  5546. <dl class="config option">
  5547. <dt class="sig sig-object config" id="cfg_Console_Height">
  5548. <span class="sig-name descname"><span class="pre">$cfg['Console']['Height']</span></span><a class="headerlink" href="#cfg_Console_Height" title="Permalink to this definition">¶</a></dt>
  5549. <dd><dl class="field-list simple">
  5550. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5551. <dd class="field-odd"><p>integer</p>
  5552. </dd>
  5553. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5554. <dd class="field-even"><p>92</p>
  5555. </dd>
  5556. </dl>
  5557. <p>Console height</p>
  5558. </dd></dl>
  5559. </section>
  5560. <section id="developer">
  5561. <h2>Developer<a class="headerlink" href="#developer" title="Permalink to this heading">¶</a></h2>
  5562. <div class="admonition warning">
  5563. <p class="admonition-title">Warning</p>
  5564. <p>These settings might have huge effect on performance or security.</p>
  5565. </div>
  5566. <dl class="config option">
  5567. <dt class="sig sig-object config" id="cfg_environment">
  5568. <span class="sig-name descname"><span class="pre">$cfg['environment']</span></span><a class="headerlink" href="#cfg_environment" title="Permalink to this definition">¶</a></dt>
  5569. <dd><dl class="field-list simple">
  5570. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5571. <dd class="field-odd"><p>string</p>
  5572. </dd>
  5573. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5574. <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">'production'</span></code></p>
  5575. </dd>
  5576. </dl>
  5577. <p>Sets the working environment.</p>
  5578. <p>This only needs to be changed when you are developing phpMyAdmin itself.
  5579. The <code class="docutils literal notranslate"><span class="pre">development</span></code> mode may display debug information in some places.</p>
  5580. <p>Possible values are <code class="docutils literal notranslate"><span class="pre">'production'</span></code> or <code class="docutils literal notranslate"><span class="pre">'development'</span></code>.</p>
  5581. </dd></dl>
  5582. <dl class="config option">
  5583. <dt class="sig sig-object config" id="cfg_DBG">
  5584. <span class="sig-name descname"><span class="pre">$cfg['DBG']</span></span><a class="headerlink" href="#cfg_DBG" title="Permalink to this definition">¶</a></dt>
  5585. <dd><dl class="field-list simple">
  5586. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5587. <dd class="field-odd"><p>array</p>
  5588. </dd>
  5589. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5590. <dd class="field-even"><p>[]</p>
  5591. </dd>
  5592. </dl>
  5593. </dd></dl>
  5594. <dl class="config option">
  5595. <dt class="sig sig-object config" id="cfg_DBG_sql">
  5596. <span class="sig-name descname"><span class="pre">$cfg['DBG']['sql']</span></span><a class="headerlink" href="#cfg_DBG_sql" title="Permalink to this definition">¶</a></dt>
  5597. <dd><dl class="field-list simple">
  5598. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5599. <dd class="field-odd"><p>boolean</p>
  5600. </dd>
  5601. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5602. <dd class="field-even"><p>false</p>
  5603. </dd>
  5604. </dl>
  5605. <p>Enable logging queries and execution times to be
  5606. displayed in the console’s Debug SQL tab.</p>
  5607. </dd></dl>
  5608. <dl class="config option">
  5609. <dt class="sig sig-object config" id="cfg_DBG_sqllog">
  5610. <span class="sig-name descname"><span class="pre">$cfg['DBG']['sqllog']</span></span><a class="headerlink" href="#cfg_DBG_sqllog" title="Permalink to this definition">¶</a></dt>
  5611. <dd><dl class="field-list simple">
  5612. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5613. <dd class="field-odd"><p>boolean</p>
  5614. </dd>
  5615. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5616. <dd class="field-even"><p>false</p>
  5617. </dd>
  5618. </dl>
  5619. <p>Enable logging of queries and execution times to the syslog.
  5620. Requires <span class="target" id="index-160"></span><a class="reference internal" href="#cfg_DBG_sql"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['DBG']['sql']</span></code></a> to be enabled.</p>
  5621. </dd></dl>
  5622. <dl class="config option">
  5623. <dt class="sig sig-object config" id="cfg_DBG_demo">
  5624. <span class="sig-name descname"><span class="pre">$cfg['DBG']['demo']</span></span><a class="headerlink" href="#cfg_DBG_demo" title="Permalink to this definition">¶</a></dt>
  5625. <dd><dl class="field-list simple">
  5626. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5627. <dd class="field-odd"><p>boolean</p>
  5628. </dd>
  5629. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5630. <dd class="field-even"><p>false</p>
  5631. </dd>
  5632. </dl>
  5633. <p>Enable to let server present itself as demo server.
  5634. This is used for <a class="reference external" href="https://www.phpmyadmin.net/try/">phpMyAdmin demo server</a>.</p>
  5635. <p>It currently changes following behavior:</p>
  5636. <ul class="simple">
  5637. <li><p>There is welcome message on the main page.</p></li>
  5638. <li><p>There is footer information about demo server and used Git revision.</p></li>
  5639. <li><p>The setup script is enabled even with existing configuration.</p></li>
  5640. <li><p>The setup does not try to connect to the MySQL server.</p></li>
  5641. </ul>
  5642. </dd></dl>
  5643. <dl class="config option">
  5644. <dt class="sig sig-object config" id="cfg_DBG_simple2fa">
  5645. <span class="sig-name descname"><span class="pre">$cfg['DBG']['simple2fa']</span></span><a class="headerlink" href="#cfg_DBG_simple2fa" title="Permalink to this definition">¶</a></dt>
  5646. <dd><dl class="field-list simple">
  5647. <dt class="field-odd">Type<span class="colon">:</span></dt>
  5648. <dd class="field-odd"><p>boolean</p>
  5649. </dd>
  5650. <dt class="field-even">Default value<span class="colon">:</span></dt>
  5651. <dd class="field-even"><p>false</p>
  5652. </dd>
  5653. </dl>
  5654. <p>Can be used for testing two-factor authentication using <a class="reference internal" href="two_factor.html#simple2fa"><span class="std std-ref">Simple two-factor authentication</span></a>.</p>
  5655. </dd></dl>
  5656. </section>
  5657. <section id="examples">
  5658. <span id="config-examples"></span><h2>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">¶</a></h2>
  5659. <p>See following configuration snippets for typical setups of phpMyAdmin.</p>
  5660. <section id="basic-example">
  5661. <h3>Basic example<a class="headerlink" href="#basic-example" title="Permalink to this heading">¶</a></h3>
  5662. <p>Example configuration file, which can be copied to <code class="file docutils literal notranslate"><span class="pre">config.inc.php</span></code> to
  5663. get some core configuration layout; it is distributed with phpMyAdmin as
  5664. <code class="file docutils literal notranslate"><span class="pre">config.sample.inc.php</span></code>. Please note that it does not contain all
  5665. configuration options, only the most frequently used ones.</p>
  5666. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;?</span><span class="nx">php</span>
  5667. <span class="sd">/**</span>
  5668. <span class="sd"> * phpMyAdmin sample configuration, you can use it as base for</span>
  5669. <span class="sd"> * manual configuration. For easier setup you can use setup/</span>
  5670. <span class="sd"> *</span>
  5671. <span class="sd"> * All directives are explained in documentation in the doc/ folder</span>
  5672. <span class="sd"> * or at &lt;https://docs.phpmyadmin.net/&gt;.</span>
  5673. <span class="sd"> */</span>
  5674. <span class="k">declare</span><span class="p">(</span><span class="nx">strict_types</span><span class="o">=</span><span class="mi">1</span><span class="p">);</span>
  5675. <span class="sd">/**</span>
  5676. <span class="sd"> * This is needed for cookie based authentication to encrypt the cookie.</span>
  5677. <span class="sd"> * Needs to be a 32-bytes long string of random bytes. See FAQ 2.10.</span>
  5678. <span class="sd"> */</span>
  5679. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;blowfish_secret&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span> <span class="cm">/* YOU MUST FILL IN THIS FOR COOKIE AUTH! */</span>
  5680. <span class="sd">/**</span>
  5681. <span class="sd"> * Servers configuration</span>
  5682. <span class="sd"> */</span>
  5683. <span class="nv">$i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
  5684. <span class="sd">/**</span>
  5685. <span class="sd"> * First server</span>
  5686. <span class="sd"> */</span>
  5687. <span class="nv">$i</span><span class="o">++</span><span class="p">;</span>
  5688. <span class="cm">/* Authentication type */</span>
  5689. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;auth_type&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;cookie&#39;</span><span class="p">;</span>
  5690. <span class="cm">/* Server parameters */</span>
  5691. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;host&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;localhost&#39;</span><span class="p">;</span>
  5692. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;compress&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="k">false</span><span class="p">;</span>
  5693. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;AllowNoPassword&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="k">false</span><span class="p">;</span>
  5694. <span class="sd">/**</span>
  5695. <span class="sd"> * phpMyAdmin configuration storage settings.</span>
  5696. <span class="sd"> */</span>
  5697. <span class="cm">/* User used to manipulate with storage */</span>
  5698. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;controlhost&#39;] = &#39;&#39;;</span>
  5699. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;controlport&#39;] = &#39;&#39;;</span>
  5700. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;controluser&#39;] = &#39;pma&#39;;</span>
  5701. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;controlpass&#39;] = &#39;pmapass&#39;;</span>
  5702. <span class="cm">/* Storage database and tables */</span>
  5703. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;pmadb&#39;] = &#39;phpmyadmin&#39;;</span>
  5704. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;bookmarktable&#39;] = &#39;pma__bookmark&#39;;</span>
  5705. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;relation&#39;] = &#39;pma__relation&#39;;</span>
  5706. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;table_info&#39;] = &#39;pma__table_info&#39;;</span>
  5707. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;table_coords&#39;] = &#39;pma__table_coords&#39;;</span>
  5708. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;pdf_pages&#39;] = &#39;pma__pdf_pages&#39;;</span>
  5709. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;column_info&#39;] = &#39;pma__column_info&#39;;</span>
  5710. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;history&#39;] = &#39;pma__history&#39;;</span>
  5711. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;table_uiprefs&#39;] = &#39;pma__table_uiprefs&#39;;</span>
  5712. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;tracking&#39;] = &#39;pma__tracking&#39;;</span>
  5713. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;userconfig&#39;] = &#39;pma__userconfig&#39;;</span>
  5714. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;recent&#39;] = &#39;pma__recent&#39;;</span>
  5715. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;favorite&#39;] = &#39;pma__favorite&#39;;</span>
  5716. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;users&#39;] = &#39;pma__users&#39;;</span>
  5717. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;usergroups&#39;] = &#39;pma__usergroups&#39;;</span>
  5718. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;navigationhiding&#39;] = &#39;pma__navigationhiding&#39;;</span>
  5719. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;savedsearches&#39;] = &#39;pma__savedsearches&#39;;</span>
  5720. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;central_columns&#39;] = &#39;pma__central_columns&#39;;</span>
  5721. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;designer_settings&#39;] = &#39;pma__designer_settings&#39;;</span>
  5722. <span class="c1">// $cfg[&#39;Servers&#39;][$i][&#39;export_templates&#39;] = &#39;pma__export_templates&#39;;</span>
  5723. <span class="sd">/**</span>
  5724. <span class="sd"> * End of servers configuration</span>
  5725. <span class="sd"> */</span>
  5726. <span class="sd">/**</span>
  5727. <span class="sd"> * Directories for saving/loading files from server</span>
  5728. <span class="sd"> */</span>
  5729. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;UploadDir&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
  5730. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;SaveDir&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
  5731. <span class="sd">/**</span>
  5732. <span class="sd"> * Whether to display icons or text or both icons and text in table row</span>
  5733. <span class="sd"> * action segment. Value can be either of &#39;icons&#39;, &#39;text&#39; or &#39;both&#39;.</span>
  5734. <span class="sd"> * default = &#39;both&#39;</span>
  5735. <span class="sd"> */</span>
  5736. <span class="c1">//$cfg[&#39;RowActionType&#39;] = &#39;icons&#39;;</span>
  5737. <span class="sd">/**</span>
  5738. <span class="sd"> * Defines whether a user should be displayed a &quot;show all (records)&quot;</span>
  5739. <span class="sd"> * button in browse mode or not.</span>
  5740. <span class="sd"> * default = false</span>
  5741. <span class="sd"> */</span>
  5742. <span class="c1">//$cfg[&#39;ShowAll&#39;] = true;</span>
  5743. <span class="sd">/**</span>
  5744. <span class="sd"> * Number of rows displayed when browsing a result set. If the result</span>
  5745. <span class="sd"> * set contains more rows, &quot;Previous&quot; and &quot;Next&quot;.</span>
  5746. <span class="sd"> * Possible values: 25, 50, 100, 250, 500</span>
  5747. <span class="sd"> * default = 25</span>
  5748. <span class="sd"> */</span>
  5749. <span class="c1">//$cfg[&#39;MaxRows&#39;] = 50;</span>
  5750. <span class="sd">/**</span>
  5751. <span class="sd"> * Disallow editing of binary fields</span>
  5752. <span class="sd"> * valid values are:</span>
  5753. <span class="sd"> * false allow editing</span>
  5754. <span class="sd"> * &#39;blob&#39; allow editing except for BLOB fields</span>
  5755. <span class="sd"> * &#39;noblob&#39; disallow editing except for BLOB fields</span>
  5756. <span class="sd"> * &#39;all&#39; disallow editing</span>
  5757. <span class="sd"> * default = &#39;blob&#39;</span>
  5758. <span class="sd"> */</span>
  5759. <span class="c1">//$cfg[&#39;ProtectBinary&#39;] = false;</span>
  5760. <span class="sd">/**</span>
  5761. <span class="sd"> * Default language to use, if not browser-defined or user-defined</span>
  5762. <span class="sd"> * (you find all languages in the locale folder)</span>
  5763. <span class="sd"> * uncomment the desired line:</span>
  5764. <span class="sd"> * default = &#39;en&#39;</span>
  5765. <span class="sd"> */</span>
  5766. <span class="c1">//$cfg[&#39;DefaultLang&#39;] = &#39;en&#39;;</span>
  5767. <span class="c1">//$cfg[&#39;DefaultLang&#39;] = &#39;de&#39;;</span>
  5768. <span class="sd">/**</span>
  5769. <span class="sd"> * How many columns should be used for table display of a database?</span>
  5770. <span class="sd"> * (a value larger than 1 results in some information being hidden)</span>
  5771. <span class="sd"> * default = 1</span>
  5772. <span class="sd"> */</span>
  5773. <span class="c1">//$cfg[&#39;PropertiesNumColumns&#39;] = 2;</span>
  5774. <span class="sd">/**</span>
  5775. <span class="sd"> * Set to true if you want DB-based query history.If false, this utilizes</span>
  5776. <span class="sd"> * JS-routines to display query history (lost by window close)</span>
  5777. <span class="sd"> *</span>
  5778. <span class="sd"> * This requires configuration storage enabled, see above.</span>
  5779. <span class="sd"> * default = false</span>
  5780. <span class="sd"> */</span>
  5781. <span class="c1">//$cfg[&#39;QueryHistoryDB&#39;] = true;</span>
  5782. <span class="sd">/**</span>
  5783. <span class="sd"> * When using DB-based query history, how many entries should be kept?</span>
  5784. <span class="sd"> * default = 25</span>
  5785. <span class="sd"> */</span>
  5786. <span class="c1">//$cfg[&#39;QueryHistoryMax&#39;] = 100;</span>
  5787. <span class="sd">/**</span>
  5788. <span class="sd"> * Whether or not to query the user before sending the error report to</span>
  5789. <span class="sd"> * the phpMyAdmin team when a JavaScript error occurs</span>
  5790. <span class="sd"> *</span>
  5791. <span class="sd"> * Available options</span>
  5792. <span class="sd"> * (&#39;ask&#39; | &#39;always&#39; | &#39;never&#39;)</span>
  5793. <span class="sd"> * default = &#39;ask&#39;</span>
  5794. <span class="sd"> */</span>
  5795. <span class="c1">//$cfg[&#39;SendErrorReports&#39;] = &#39;always&#39;;</span>
  5796. <span class="sd">/**</span>
  5797. <span class="sd"> * &#39;URLQueryEncryption&#39; defines whether phpMyAdmin will encrypt sensitive data from the URL query string.</span>
  5798. <span class="sd"> * &#39;URLQueryEncryptionSecretKey&#39; is a 32 bytes long secret key used to encrypt/decrypt the URL query string.</span>
  5799. <span class="sd"> */</span>
  5800. <span class="c1">//$cfg[&#39;URLQueryEncryption&#39;] = true;</span>
  5801. <span class="c1">//$cfg[&#39;URLQueryEncryptionSecretKey&#39;] = &#39;&#39;;</span>
  5802. <span class="sd">/**</span>
  5803. <span class="sd"> * You can find more configuration options in the documentation</span>
  5804. <span class="sd"> * in the doc/ folder or at &lt;https://docs.phpmyadmin.net/&gt;.</span>
  5805. <span class="sd"> */</span>
  5806. </pre></div>
  5807. </div>
  5808. <div class="admonition warning">
  5809. <p class="admonition-title">Warning</p>
  5810. <p>Don’t use the controluser ‘pma’ if it does not yet exist and don’t use ‘pmapass’
  5811. as password.</p>
  5812. </div>
  5813. </section>
  5814. <section id="example-for-signon-authentication">
  5815. <span id="example-signon"></span><h3>Example for signon authentication<a class="headerlink" href="#example-for-signon-authentication" title="Permalink to this heading">¶</a></h3>
  5816. <p>This example uses <code class="file docutils literal notranslate"><span class="pre">examples/signon.php</span></code> to demonstrate usage of <a class="reference internal" href="setup.html#auth-signon"><span class="std std-ref">Signon authentication mode</span></a>:</p>
  5817. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;?</span><span class="nx">php</span>
  5818. <span class="nv">$i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
  5819. <span class="nv">$i</span><span class="o">++</span><span class="p">;</span>
  5820. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;auth_type&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;signon&#39;</span><span class="p">;</span>
  5821. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;SignonSession&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;SignonSession&#39;</span><span class="p">;</span>
  5822. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;SignonURL&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;examples/signon.php&#39;</span><span class="p">;</span>
  5823. </pre></div>
  5824. </div>
  5825. </section>
  5826. <section id="example-for-ip-address-limited-autologin">
  5827. <h3>Example for IP address limited autologin<a class="headerlink" href="#example-for-ip-address-limited-autologin" title="Permalink to this heading">¶</a></h3>
  5828. <p>If you want to automatically login when accessing phpMyAdmin locally while asking
  5829. for a password when accessing remotely, you can achieve it using following snippet:</p>
  5830. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="p">(</span><span class="nv">$_SERVER</span><span class="p">[</span><span class="s1">&#39;REMOTE_ADDR&#39;</span><span class="p">]</span> <span class="o">===</span> <span class="s1">&#39;127.0.0.1&#39;</span><span class="p">)</span> <span class="p">{</span>
  5831. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;auth_type&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;config&#39;</span><span class="p">;</span>
  5832. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;user&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;root&#39;</span><span class="p">;</span>
  5833. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;password&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;yourpassword&#39;</span><span class="p">;</span>
  5834. <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
  5835. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;auth_type&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;cookie&#39;</span><span class="p">;</span>
  5836. <span class="p">}</span>
  5837. </pre></div>
  5838. </div>
  5839. <div class="admonition note">
  5840. <p class="admonition-title">Note</p>
  5841. <p>Filtering based on IP addresses isn’t reliable over the internet, use it
  5842. only for local address.</p>
  5843. </div>
  5844. </section>
  5845. <section id="example-for-using-multiple-mysql-servers">
  5846. <h3>Example for using multiple MySQL servers<a class="headerlink" href="#example-for-using-multiple-mysql-servers" title="Permalink to this heading">¶</a></h3>
  5847. <p>You can configure any number of servers using <span class="target" id="index-161"></span><a class="reference internal" href="#cfg_Servers"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers']</span></code></a>,
  5848. following example shows two of them:</p>
  5849. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;?</span><span class="nx">php</span>
  5850. <span class="c1">// The string is a hexadecimal representation of a 32-bytes long string of random bytes.</span>
  5851. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;blowfish_secret&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">sodium_hex2bin</span><span class="p">(</span><span class="s1">&#39;f16ce59f45714194371b48fe362072dc3b019da7861558cd4ad29e4d6fb13851&#39;</span><span class="p">);</span>
  5852. <span class="nv">$i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
  5853. <span class="nv">$i</span><span class="o">++</span><span class="p">;</span> <span class="c1">// server 1 :</span>
  5854. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;auth_type&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;cookie&#39;</span><span class="p">;</span>
  5855. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;verbose&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;no1&#39;</span><span class="p">;</span>
  5856. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;host&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;localhost&#39;</span><span class="p">;</span>
  5857. <span class="c1">// more options for #1 ...</span>
  5858. <span class="nv">$i</span><span class="o">++</span><span class="p">;</span> <span class="c1">// server 2 :</span>
  5859. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;auth_type&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;cookie&#39;</span><span class="p">;</span>
  5860. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;verbose&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;no2&#39;</span><span class="p">;</span>
  5861. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;host&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;remote.host.addr&#39;</span><span class="p">;</span><span class="c1">//or ip:&#39;10.9.8.1&#39;</span>
  5862. <span class="c1">// this server must allow remote clients, e.g., host 10.9.8.%</span>
  5863. <span class="c1">// not only in mysql.host but also in the startup configuration</span>
  5864. <span class="c1">// more options for #2 ...</span>
  5865. <span class="c1">// end of server sections</span>
  5866. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;ServerDefault&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="c1">// to choose the server on startup</span>
  5867. <span class="c1">// further general options ...</span>
  5868. </pre></div>
  5869. </div>
  5870. </section>
  5871. <section id="google-cloud-sql-with-ssl">
  5872. <span id="example-google-ssl"></span><h3>Google Cloud SQL with SSL<a class="headerlink" href="#google-cloud-sql-with-ssl" title="Permalink to this heading">¶</a></h3>
  5873. <p>To connect to Google Could SQL, you currently need to disable certificate
  5874. verification. This is caused by the certificate being issued for CN matching
  5875. your instance name, but you connect to an IP address and PHP tries to match
  5876. these two. With verification you end up with error message like:</p>
  5877. <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Peer certificate CN=`api-project-851612429544:pmatest&#39; did not match expected CN=`8.8.8.8&#39;
  5878. </pre></div>
  5879. </div>
  5880. <div class="admonition warning">
  5881. <p class="admonition-title">Warning</p>
  5882. <p>With disabled verification your traffic is encrypted, but you’re open to
  5883. man in the middle attacks.</p>
  5884. </div>
  5885. <p>To connect phpMyAdmin to Google Cloud SQL using SSL download the client and
  5886. server certificates and tell phpMyAdmin to use them:</p>
  5887. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// IP address of your instance</span>
  5888. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;host&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;8.8.8.8&#39;</span><span class="p">;</span>
  5889. <span class="c1">// Use SSL for connection</span>
  5890. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;ssl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
  5891. <span class="c1">// Client secret key</span>
  5892. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;ssl_key&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;../client-key.pem&#39;</span><span class="p">;</span>
  5893. <span class="c1">// Client certificate</span>
  5894. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;ssl_cert&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;../client-cert.pem&#39;</span><span class="p">;</span>
  5895. <span class="c1">// Server certification authority</span>
  5896. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;ssl_ca&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;../server-ca.pem&#39;</span><span class="p">;</span>
  5897. <span class="c1">// Disable SSL verification (see above note)</span>
  5898. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;ssl_verify&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="k">false</span><span class="p">;</span>
  5899. </pre></div>
  5900. </div>
  5901. <div class="admonition seealso">
  5902. <p class="admonition-title">See also</p>
  5903. <p><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>,
  5904. <span class="target" id="index-162"></span><a class="reference internal" href="#cfg_Servers_ssl"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl']</span></code></a>,
  5905. <span class="target" id="index-163"></span><a class="reference internal" href="#cfg_Servers_ssl_key"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_key']</span></code></a>,
  5906. <span class="target" id="index-164"></span><a class="reference internal" href="#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_cert']</span></code></a>,
  5907. <span class="target" id="index-165"></span><a class="reference internal" href="#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></code></a>,
  5908. <span class="target" id="index-166"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a>,
  5909. &lt;<a class="reference external" href="https://bugs.php.net/bug.php?id=72048">https://bugs.php.net/bug.php?id=72048</a>&gt;</p>
  5910. </div>
  5911. </section>
  5912. <section id="amazon-rds-aurora-with-ssl">
  5913. <span id="example-aws-ssl"></span><h3>Amazon RDS Aurora with SSL<a class="headerlink" href="#amazon-rds-aurora-with-ssl" title="Permalink to this heading">¶</a></h3>
  5914. <p>To connect phpMyAdmin to an Amazon RDS Aurora MySQL database instance using SSL,
  5915. download the CA server certificate and tell phpMyAdmin to use it:</p>
  5916. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Address of your instance</span>
  5917. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;host&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;replace-me-cluster-name.cluster-replace-me-id.replace-me-region.rds.amazonaws.com&#39;</span><span class="p">;</span>
  5918. <span class="c1">// Use SSL for connection</span>
  5919. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;ssl&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
  5920. <span class="c1">// You need to have the region CA file and the authority CA file (2019 edition CA for example) in the PEM bundle for it to work</span>
  5921. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;ssl_ca&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;../rds-combined-ca-bundle.pem&#39;</span><span class="p">;</span>
  5922. <span class="c1">// Enable SSL verification</span>
  5923. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;Servers&#39;</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">&#39;ssl_verify&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
  5924. </pre></div>
  5925. </div>
  5926. <div class="admonition seealso">
  5927. <p class="admonition-title">See also</p>
  5928. <p><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>,
  5929. <span class="target" id="index-167"></span><a class="reference internal" href="#cfg_Servers_ssl"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl']</span></code></a>,
  5930. <span class="target" id="index-168"></span><a class="reference internal" href="#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></code></a>,
  5931. <span class="target" id="index-169"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a></p>
  5932. </div>
  5933. <div class="admonition seealso">
  5934. <p class="admonition-title">See also</p>
  5935. <ul class="simple">
  5936. <li><p>Current RDS CA bundle for all regions <a class="reference external" href="https://s3.amazonaws.com/rds-downloads/rds-combined-ca-bundle.pem">https://s3.amazonaws.com/rds-downloads/rds-combined-ca-bundle.pem</a></p></li>
  5937. <li><p>The RDS CA (2019 edition) for the region <cite>eu-west-3</cite> without the parent CA <a class="reference external" href="https://s3.amazonaws.com/rds-downloads/rds-ca-2019-eu-west-3.pem">https://s3.amazonaws.com/rds-downloads/rds-ca-2019-eu-west-3.pem</a></p></li>
  5938. <li><p><a class="reference external" href="https://s3.amazonaws.com/rds-downloads/">List of available Amazon RDS CA files</a></p></li>
  5939. <li><p><a class="reference external" href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Security.html">Amazon MySQL Aurora security guide</a></p></li>
  5940. <li><p><a class="reference external" href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html">Amazon certificates bundles per region</a></p></li>
  5941. </ul>
  5942. </div>
  5943. </section>
  5944. <section id="recaptcha-using-hcaptcha">
  5945. <h3>reCaptcha using hCaptcha<a class="headerlink" href="#recaptcha-using-hcaptcha" title="Permalink to this heading">¶</a></h3>
  5946. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaApi&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;https://www.hcaptcha.com/1/api.js&#39;</span><span class="p">;</span>
  5947. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaCsp&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;https://hcaptcha.com https://*.hcaptcha.com&#39;</span><span class="p">;</span>
  5948. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaRequestParam&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;h-captcha&#39;</span><span class="p">;</span>
  5949. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaResponseParam&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;h-captcha-response&#39;</span><span class="p">;</span>
  5950. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaSiteVerifyURL&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;https://hcaptcha.com/siteverify&#39;</span><span class="p">;</span>
  5951. <span class="c1">// This is the secret key from hCaptcha dashboard</span>
  5952. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaLoginPrivateKey&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;0xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&#39;</span><span class="p">;</span>
  5953. <span class="c1">// This is the site key from hCaptcha dashboard</span>
  5954. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaLoginPublicKey&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;xxx-xxx-xxx-xxx-xxxx&#39;</span><span class="p">;</span>
  5955. </pre></div>
  5956. </div>
  5957. <div class="admonition seealso">
  5958. <p class="admonition-title">See also</p>
  5959. <p><a class="reference external" href="https://www.hcaptcha.com/">hCaptcha website</a></p>
  5960. </div>
  5961. <div class="admonition seealso">
  5962. <p class="admonition-title">See also</p>
  5963. <p><a class="reference external" href="https://docs.hcaptcha.com/">hCaptcha Developer Guide</a></p>
  5964. </div>
  5965. </section>
  5966. <section id="recaptcha-using-turnstile">
  5967. <h3>reCaptcha using Turnstile<a class="headerlink" href="#recaptcha-using-turnstile" title="Permalink to this heading">¶</a></h3>
  5968. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaMethod&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;checkbox&#39;</span><span class="p">;</span>
  5969. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaApi&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;https://challenges.cloudflare.com/turnstile/v0/api.js&#39;</span><span class="p">;</span>
  5970. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaCsp&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;https://challenges.cloudflare.com https://static.cloudflareinsights.com&#39;</span><span class="p">;</span>
  5971. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaRequestParam&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;cf-turnstile&#39;</span><span class="p">;</span>
  5972. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaResponseParam&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;cf-turnstile-response&#39;</span><span class="p">;</span>
  5973. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaLoginPublicKey&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;0xxxxxxxxxxxxxxxxxxxxxx&#39;</span><span class="p">;</span>
  5974. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaLoginPrivateKey&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;0x4AAAAAAAA_xx_xxxxxxxxxxxxxxxxxxxx&#39;</span><span class="p">;</span>
  5975. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaSiteVerifyURL&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;https://challenges.cloudflare.com/turnstile/v0/siteverify&#39;</span><span class="p">;</span>
  5976. </pre></div>
  5977. </div>
  5978. <div class="admonition seealso">
  5979. <p class="admonition-title">See also</p>
  5980. <p><a class="reference external" href="https://dash.cloudflare.com/">Cloudflare Dashboard</a></p>
  5981. </div>
  5982. <div class="admonition seealso">
  5983. <p class="admonition-title">See also</p>
  5984. <p><a class="reference external" href="https://developers.cloudflare.com/turnstile/get-started/">Turnstile Developer Guide</a></p>
  5985. </div>
  5986. </section>
  5987. <section id="recaptcha-using-google-recaptcha-v2-v3">
  5988. <h3>reCaptcha using Google reCaptcha v2/v3<a class="headerlink" href="#recaptcha-using-google-recaptcha-v2-v3" title="Permalink to this heading">¶</a></h3>
  5989. <div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaLoginPublicKey&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;xxxxxxxxxxxxxxxx-xxxxxxxxxxxx&#39;</span><span class="p">;</span>
  5990. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaLoginPrivateKey&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;xxxxxxxxx-xxxxxxxxxxxxxx&#39;</span><span class="p">;</span>
  5991. <span class="c1">// Remove it if you dot not want the checkbox mode</span>
  5992. <span class="nv">$cfg</span><span class="p">[</span><span class="s1">&#39;CaptchaMethod&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;checkbox&#39;</span><span class="p">;</span>
  5993. </pre></div>
  5994. </div>
  5995. <div class="admonition seealso">
  5996. <p class="admonition-title">See also</p>
  5997. <p><a class="reference external" href="https://developers.google.com/recaptcha/intro">Google reCaptcha Developer’s Guide</a></p>
  5998. </div>
  5999. <div class="admonition seealso">
  6000. <p class="admonition-title">See also</p>
  6001. <p><a class="reference external" href="https://developers.google.com/recaptcha/docs/versions">Google reCaptcha types</a></p>
  6002. </div>
  6003. </section>
  6004. </section>
  6005. </section>
  6006. <div class="clearer"></div>
  6007. </div>
  6008. </div>
  6009. </div>
  6010. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  6011. <div class="sphinxsidebarwrapper">
  6012. <div>
  6013. <h3><a href="index.html">Table of Contents</a></h3>
  6014. <ul>
  6015. <li><a class="reference internal" href="#">Configuration</a><ul>
  6016. <li><a class="reference internal" href="#basic-settings">Basic settings</a></li>
  6017. <li><a class="reference internal" href="#server-connection-settings">Server connection settings</a></li>
  6018. <li><a class="reference internal" href="#generic-settings">Generic settings</a></li>
  6019. <li><a class="reference internal" href="#cookie-authentication-options">Cookie authentication options</a></li>
  6020. <li><a class="reference internal" href="#navigation-panel-setup">Navigation panel setup</a></li>
  6021. <li><a class="reference internal" href="#main-panel">Main panel</a></li>
  6022. <li><a class="reference internal" href="#database-structure">Database structure</a></li>
  6023. <li><a class="reference internal" href="#browse-mode">Browse mode</a></li>
  6024. <li><a class="reference internal" href="#editing-mode">Editing mode</a></li>
  6025. <li><a class="reference internal" href="#export-and-import-settings">Export and import settings</a></li>
  6026. <li><a class="reference internal" href="#tabs-display-settings">Tabs display settings</a></li>
  6027. <li><a class="reference internal" href="#pdf-options">PDF Options</a></li>
  6028. <li><a class="reference internal" href="#languages">Languages</a></li>
  6029. <li><a class="reference internal" href="#web-server-settings">Web server settings</a></li>
  6030. <li><a class="reference internal" href="#theme-settings">Theme settings</a></li>
  6031. <li><a class="reference internal" href="#design-customization">Design customization</a></li>
  6032. <li><a class="reference internal" href="#text-fields">Text fields</a></li>
  6033. <li><a class="reference internal" href="#sql-query-box-settings">SQL query box settings</a></li>
  6034. <li><a class="reference internal" href="#web-server-upload-save-import-directories">Web server upload/save/import directories</a></li>
  6035. <li><a class="reference internal" href="#various-display-setting">Various display setting</a></li>
  6036. <li><a class="reference internal" href="#page-titles">Page titles</a></li>
  6037. <li><a class="reference internal" href="#theme-manager-settings">Theme manager settings</a></li>
  6038. <li><a class="reference internal" href="#default-queries">Default queries</a></li>
  6039. <li><a class="reference internal" href="#mysql-settings">MySQL settings</a></li>
  6040. <li><a class="reference internal" href="#default-options-for-transformations">Default options for Transformations</a></li>
  6041. <li><a class="reference internal" href="#console-settings">Console settings</a></li>
  6042. <li><a class="reference internal" href="#developer">Developer</a></li>
  6043. <li><a class="reference internal" href="#examples">Examples</a><ul>
  6044. <li><a class="reference internal" href="#basic-example">Basic example</a></li>
  6045. <li><a class="reference internal" href="#example-for-signon-authentication">Example for signon authentication</a></li>
  6046. <li><a class="reference internal" href="#example-for-ip-address-limited-autologin">Example for IP address limited autologin</a></li>
  6047. <li><a class="reference internal" href="#example-for-using-multiple-mysql-servers">Example for using multiple MySQL servers</a></li>
  6048. <li><a class="reference internal" href="#google-cloud-sql-with-ssl">Google Cloud SQL with SSL</a></li>
  6049. <li><a class="reference internal" href="#amazon-rds-aurora-with-ssl">Amazon RDS Aurora with SSL</a></li>
  6050. <li><a class="reference internal" href="#recaptcha-using-hcaptcha">reCaptcha using hCaptcha</a></li>
  6051. <li><a class="reference internal" href="#recaptcha-using-turnstile">reCaptcha using Turnstile</a></li>
  6052. <li><a class="reference internal" href="#recaptcha-using-google-recaptcha-v2-v3">reCaptcha using Google reCaptcha v2/v3</a></li>
  6053. </ul>
  6054. </li>
  6055. </ul>
  6056. </li>
  6057. </ul>
  6058. </div>
  6059. <div>
  6060. <h4>Previous topic</h4>
  6061. <p class="topless"><a href="setup.html"
  6062. title="previous chapter">Installation</a></p>
  6063. </div>
  6064. <div>
  6065. <h4>Next topic</h4>
  6066. <p class="topless"><a href="user.html"
  6067. title="next chapter">User Guide</a></p>
  6068. </div>
  6069. <div role="note" aria-label="source link">
  6070. <h3>This Page</h3>
  6071. <ul class="this-page-menu">
  6072. <li><a href="_sources/config.rst.txt"
  6073. rel="nofollow">Show Source</a></li>
  6074. </ul>
  6075. </div>
  6076. <div id="searchbox" style="display: none" role="search">
  6077. <h3 id="searchlabel">Quick search</h3>
  6078. <div class="searchformwrapper">
  6079. <form class="search" action="search.html" method="get">
  6080. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  6081. <input type="submit" value="Go" />
  6082. </form>
  6083. </div>
  6084. </div>
  6085. <script>document.getElementById('searchbox').style.display = "block"</script>
  6086. </div>
  6087. </div>
  6088. <div class="clearer"></div>
  6089. </div>
  6090. <div class="related" role="navigation" aria-label="related navigation">
  6091. <h3>Navigation</h3>
  6092. <ul>
  6093. <li class="right" style="margin-right: 10px">
  6094. <a href="genindex.html" title="General Index"
  6095. >index</a></li>
  6096. <li class="right" >
  6097. <a href="user.html" title="User Guide"
  6098. >next</a> |</li>
  6099. <li class="right" >
  6100. <a href="setup.html" title="Installation"
  6101. >previous</a> |</li>
  6102. <li class="nav-item nav-item-0"><a href="index.html">phpMyAdmin 5.2.2 documentation</a> &#187;</li>
  6103. <li class="nav-item nav-item-this"><a href="">Configuration</a></li>
  6104. </ul>
  6105. </div>
  6106. <div class="footer" role="contentinfo">
  6107. &#169; <a href="copyright.html">Copyright</a> 2012 - 2024, The phpMyAdmin devel team.
  6108. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
  6109. </div>
  6110. </body>
  6111. </html>