Document how to generate a string of random bytes
[phpmyadmin.git] / config.sample.inc.php
blob2fca0b5bc44be315f25f526be763827b4db0f11c
1 <?php
2 /**
3 * phpMyAdmin sample configuration, you can use it as base for
4 * manual configuration. For easier setup you can use setup/
6 * All directives are explained in documentation in the doc/ folder
7 * or at <https://docs.phpmyadmin.net/>.
8 */
10 declare(strict_types=1);
12 /**
13 * This is needed for cookie based authentication to encrypt the cookie.
14 * Needs to be a 32-bytes long string of random bytes. See FAQ 2.10.
16 $cfg['blowfish_secret'] = ''; /* YOU MUST FILL IN THIS FOR COOKIE AUTH! */
18 /**
19 * Servers configuration
21 $i = 0;
23 /**
24 * First server
26 $i++;
27 /* Authentication type */
28 $cfg['Servers'][$i]['auth_type'] = 'cookie';
29 /* Server parameters */
30 $cfg['Servers'][$i]['host'] = 'localhost';
31 $cfg['Servers'][$i]['compress'] = false;
32 $cfg['Servers'][$i]['AllowNoPassword'] = false;
34 /**
35 * phpMyAdmin configuration storage settings.
38 /* User used to manipulate with storage */
39 // $cfg['Servers'][$i]['controlhost'] = '';
40 // $cfg['Servers'][$i]['controlport'] = '';
41 // $cfg['Servers'][$i]['controluser'] = 'pma';
42 // $cfg['Servers'][$i]['controlpass'] = 'pmapass';
44 /* Storage database and tables */
45 // $cfg['Servers'][$i]['pmadb'] = 'phpmyadmin';
46 // $cfg['Servers'][$i]['bookmarktable'] = 'pma__bookmark';
47 // $cfg['Servers'][$i]['relation'] = 'pma__relation';
48 // $cfg['Servers'][$i]['table_info'] = 'pma__table_info';
49 // $cfg['Servers'][$i]['table_coords'] = 'pma__table_coords';
50 // $cfg['Servers'][$i]['pdf_pages'] = 'pma__pdf_pages';
51 // $cfg['Servers'][$i]['column_info'] = 'pma__column_info';
52 // $cfg['Servers'][$i]['history'] = 'pma__history';
53 // $cfg['Servers'][$i]['table_uiprefs'] = 'pma__table_uiprefs';
54 // $cfg['Servers'][$i]['tracking'] = 'pma__tracking';
55 // $cfg['Servers'][$i]['userconfig'] = 'pma__userconfig';
56 // $cfg['Servers'][$i]['recent'] = 'pma__recent';
57 // $cfg['Servers'][$i]['favorite'] = 'pma__favorite';
58 // $cfg['Servers'][$i]['users'] = 'pma__users';
59 // $cfg['Servers'][$i]['usergroups'] = 'pma__usergroups';
60 // $cfg['Servers'][$i]['navigationhiding'] = 'pma__navigationhiding';
61 // $cfg['Servers'][$i]['savedsearches'] = 'pma__savedsearches';
62 // $cfg['Servers'][$i]['central_columns'] = 'pma__central_columns';
63 // $cfg['Servers'][$i]['designer_settings'] = 'pma__designer_settings';
64 // $cfg['Servers'][$i]['export_templates'] = 'pma__export_templates';
66 /**
67 * End of servers configuration
70 /**
71 * Directories for saving/loading files from server
73 $cfg['UploadDir'] = '';
74 $cfg['SaveDir'] = '';
76 /**
77 * Whether to display icons or text or both icons and text in table row
78 * action segment. Value can be either of 'icons', 'text' or 'both'.
79 * default = 'both'
81 //$cfg['RowActionType'] = 'icons';
83 /**
84 * Defines whether a user should be displayed a "show all (records)"
85 * button in browse mode or not.
86 * default = false
88 //$cfg['ShowAll'] = true;
90 /**
91 * Number of rows displayed when browsing a result set. If the result
92 * set contains more rows, "Previous" and "Next".
93 * Possible values: 25, 50, 100, 250, 500
94 * default = 25
96 //$cfg['MaxRows'] = 50;
98 /**
99 * Disallow editing of binary fields
100 * valid values are:
101 * false allow editing
102 * 'blob' allow editing except for BLOB fields
103 * 'noblob' disallow editing except for BLOB fields
104 * 'all' disallow editing
105 * default = 'blob'
107 //$cfg['ProtectBinary'] = false;
110 * Default language to use, if not browser-defined or user-defined
111 * (you find all languages in the locale folder)
112 * uncomment the desired line:
113 * default = 'en'
115 //$cfg['DefaultLang'] = 'en';
116 //$cfg['DefaultLang'] = 'de';
119 * How many columns should be used for table display of a database?
120 * (a value larger than 1 results in some information being hidden)
121 * default = 1
123 //$cfg['PropertiesNumColumns'] = 2;
126 * Set to true if you want DB-based query history.If false, this utilizes
127 * JS-routines to display query history (lost by window close)
129 * This requires configuration storage enabled, see above.
130 * default = false
132 //$cfg['QueryHistoryDB'] = true;
135 * When using DB-based query history, how many entries should be kept?
136 * default = 25
138 //$cfg['QueryHistoryMax'] = 100;
141 * Whether or not to query the user before sending the error report to
142 * the phpMyAdmin team when a JavaScript error occurs
144 * Available options
145 * ('ask' | 'always' | 'never')
146 * default = 'ask'
148 //$cfg['SendErrorReports'] = 'always';
151 * 'URLQueryEncryption' defines whether phpMyAdmin will encrypt sensitive data from the URL query string.
152 * 'URLQueryEncryptionSecretKey' is a 32 bytes long secret key used to encrypt/decrypt the URL query string.
154 //$cfg['URLQueryEncryption'] = true;
155 //$cfg['URLQueryEncryptionSecretKey'] = '';
158 * You can find more configuration options in the documentation
159 * in the doc/ folder or at <https://docs.phpmyadmin.net/>.