Skip to content

Commit cf1d92d

Browse files
committed
Fixes to documentation:
* Remove old references * Remove "added in" or "new in" if it's quite an old feature * Some language improvements Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
1 parent dfcf3dd commit cf1d92d

8 files changed

Lines changed: 317 additions & 512 deletions

File tree

docs/charts.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
Charts
44
======
55

6-
.. versionadded:: 3.4.0
7-
8-
Since phpMyAdmin version 3.4.0, you can easily generate charts from a SQL query
6+
You can easily generate charts from a SQL query
97
by clicking the "Display chart" link in the "Query results operations" area.
108

119
.. image:: images/query_result_operations.png

docs/config.rst

Lines changed: 160 additions & 196 deletions
Large diffs are not rendered by default.

docs/faq.rst

Lines changed: 117 additions & 275 deletions
Large diffs are not rendered by default.

docs/import_export.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ Import and export
44
Import
55
++++++
66

7-
To import data, go to the "Import" tab in phpMyAdmin. To import data into a
7+
To import data, go to the :guilabel:`Import` tab in phpMyAdmin. To import data into a
88
specific database or table, open the database or table before going to the
9-
"Import" tab.
9+
:guilabel:`Import` tab.
1010

1111
In addition to the standard Import and Export tab, you can also import an SQL
1212
file directly by dragging and dropping it from your local file manager to the
1313
phpMyAdmin interface in your web browser.
1414

1515
If you are having troubles importing big files, please consult :ref:`faq1_16`.
1616

17-
You can import using following methods:
17+
You can import using any of these methods:
1818

1919
Form based upload
2020

@@ -274,15 +274,15 @@ including table names or headers.
274274
OpenDocument Spreadsheet
275275
------------------------
276276

277-
Open standard for spreadsheet data, which is being widely adopted. Many recent
277+
Open standard for spreadsheet data, which has being widely adopted. Many recent
278278
spreadsheet programs, such as LibreOffice, OpenOffice, Microsoft Office or
279279
Google Docs can handle this format.
280280

281281
OpenDocument Text
282282
-----------------
283283

284-
New standard for text data which is being widely adopted. Most recent word
285-
processors (such as LibreOffice, OpenOffice, Microsoft Word, AbiWord or KWord)
284+
Open standard for text data which has being widely adopted. Most recent word
285+
processors (such as LibreOffice, OpenOffice, Microsoft Word, AbiWord or Google Docs)
286286
can handle this.
287287

288288
PDF
@@ -315,12 +315,12 @@ file, for large tables you avoid the error "Got a packet bigger than
315315
Data Options
316316
~~~~~~~~~~~~
317317

318-
**Complete inserts** adds the column names to the SQL dump. This parameter
318+
:guilabel:`Complete inserts` adds the column names to the SQL dump. This parameter
319319
improves the readability and reliability of the dump. Adding the column names
320320
increases the size of the dump, but when combined with Extended inserts it's
321321
negligible.
322322

323-
**Extended inserts** combines multiple rows of data into a single INSERT query.
323+
:guilabel:`Extended inserts` combines multiple rows of data into a single INSERT query.
324324
This will significantly decrease filesize for large SQL dumps, increases the
325325
INSERT speed when imported, and is generally recommended.
326326

docs/security.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
Security policy
22
===============
33

4-
The phpMyAdmin developer team is putting lot of effort to make phpMyAdmin as
5-
secure as possible. But still web application like phpMyAdmin can be vulnerable
6-
to a number of attacks and new ways to exploit are still being explored.
4+
The phpMyAdmin developer team is putting lot of effort in to making phpMyAdmin as
5+
secure as possible. Still, web applications like phpMyAdmin can be vulnerable
6+
to a number of attacks and new exploits are constantly being explored.
77

88
For every reported vulnerability we issue a phpMyAdmin Security Announcement
9-
(PMASA) and it get's assigned a CVE ID as well. We might group similar
9+
(PMASA) and it gets assigned a CVE ID as well. We might group similar
1010
vulnerabilities to one PMASA (eg. multiple XSS vulnerabilities can be announced
1111
under one PMASA).
1212

@@ -15,8 +15,8 @@ If you think you've found a vulnerability, please see :ref:`reporting-security`.
1515
Typical vulnerabilities
1616
-----------------------
1717

18-
In this section, we will describe typical vulnerabilities, which can appear in
19-
our code base. This list is by no means complete, it is intended to show
18+
In this section, we will describe typical vulnerabilities which can appear in
19+
our code base. This list is by no means complete; it is intended to show
2020
typical attack surface.
2121

2222
Cross-site scripting (XSS)
@@ -29,7 +29,7 @@ content to trick an other user of that database into executing something. This
2929
could for example be a piece of JavaScript code that would do any number of
3030
nasty things.
3131

32-
phpMyAdmin tries to escape all userdata before it is rendered into html for the
32+
phpMyAdmin tries to escape all user data before it is rendered into html for the
3333
browser.
3434

3535
.. seealso::
@@ -42,14 +42,14 @@ Cross-site request forgery (CSRF)
4242
An attacker would trick a phpMyAdmin user into clicking on a link to provoke
4343
some action in phpMyAdmin. This link could either be sent via email or some
4444
random website. If successful this the attacker would be able to perform some
45-
action with the users privileges.
45+
action with the user's privileges.
4646

47-
To mitigate this phpMyAdmin requires a token to be sent on sensitive requests.
47+
To mitigate this, phpMyAdmin requires a token to be sent on sensitive requests.
4848
The idea is that an attacker does not poses the currently valid token to
4949
include in the presented link.
5050

5151
The token is regenerated for every login, so it's generally valid only for
52-
limited time, what makes it harder for attacker to obtain valid one.
52+
limited time, which makes it harder for attacker to obtain valid one.
5353

5454
.. seealso::
5555

@@ -58,9 +58,9 @@ limited time, what makes it harder for attacker to obtain valid one.
5858
SQL injection
5959
+++++++++++++
6060

61-
As the whole purpose of phpMyAdmin is to preform sql queries, this is not our
61+
As the whole purpose of phpMyAdmin is to preform SQL queries, this is not our
6262
first concern. SQL injection is sensitive to us though when it concerns the
63-
mysql control connection. This controlconnection can have additional privileges
63+
mysql control connection. This control connection can have additional privileges
6464
which the logged in user does not poses. E.g. access the :ref:`linked-tables`.
6565

6666
User data that is included in (administrative) queries should always be run
@@ -78,7 +78,7 @@ This is caused by need to work in stateless environment, where there is no way
7878
to protect against such kind of things.
7979

8080
To mitigate this, you can use Captcha or utilize external tools such as
81-
fail2ban, this is more details described in :ref:`securing`.
81+
fail2ban, this is described in more detail in :ref:`securing`.
8282

8383
.. seealso::
8484

docs/settings.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ The global settings can be configured in :file:`config.inc.php` as described in
1010
system wide settings.
1111

1212
On top of this there are user settings which can be persistently stored in
13-
:ref:`linked-tables`, possibly automatically configured through
14-
:ref:`zeroconf`. If the :ref:`linked-tables` are not configured, the settings
13+
:ref:`linked-tables`, which could automatically be configured through
14+
:ref:`zeroconf`. If the :ref:`linked-tables` are not configured and
15+
zeroconf fails or is disabled, the settings
1516
are temporarily stored in the session data; these are valid only until you
1617
logout.
1718

docs/setup.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -964,7 +964,7 @@ If you already had this infrastructure and:
964964
and then create new tables by importing :file:`resources/sql/create_tables.sql`.
965965

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

@@ -976,9 +976,9 @@ You will also need to have a controluser
976976
(:config:option:`$cfg['Servers'][$i]['controluser']` and
977977
:config:option:`$cfg['Servers'][$i]['controlpass']` settings)
978978
with the proper rights to those tables. For example you can create it
979-
using following statement:
979+
using the following statement:
980980

981-
And for any MariaDB version:
981+
For any MariaDB version:
982982

983983
.. code-block:: mysql
984984
@@ -1055,17 +1055,16 @@ Using authentication modes
10551055

10561056
:term:`HTTP` and cookie authentication modes are recommended in a **multi-user
10571057
environment** where you want to give users access to their own database and
1058-
don't want them to play around with others. Nevertheless, be aware that MS
1059-
Internet Explorer seems to be really buggy about cookies, at least till version
1060-
6. Even in a **single-user environment**, you might prefer to use :term:`HTTP`
1058+
don't want them to play around with others.
1059+
Even in a **single-user environment**, you might prefer to use :term:`HTTP`
10611060
or cookie mode so that your user/password pair are not in clear in the
10621061
configuration file.
10631062

10641063
:term:`HTTP` and cookie authentication
10651064
modes are more secure: the MySQL login information does not need to be
10661065
set in the phpMyAdmin configuration file (except possibly for the
10671066
:config:option:`$cfg['Servers'][$i]['controluser']`).
1068-
However, keep in mind that the password travels in plain text unless
1067+
However, keep in mind that the password travels in plain text between your browser and the server unless
10691068
you are using the HTTPS protocol. In cookie mode, the password is
10701069
stored, encrypted with the AES algorithm, in a temporary cookie.
10711070

@@ -1130,6 +1129,7 @@ HTTP authentication mode
11301129
Cookie authentication mode
11311130
--------------------------
11321131

1132+
* The recommended and most popular authentication type.
11331133
* Username and password are stored in cookies during the session and password
11341134
is deleted when it ends.
11351135
* With this mode, the user can truly log out of phpMyAdmin and log
@@ -1208,9 +1208,7 @@ Config authentication mode
12081208
loading the phpMyAdmin site. This is by design but could allow any
12091209
user to access your installation. Use of some restriction method is
12101210
suggested, perhaps a :term:`.htaccess` file with the HTTP-AUTH directive or disallowing
1211-
incoming HTTP requests at one’s router or firewall will suffice (both
1212-
of which are beyond the scope of this manual but easily searchable
1213-
with Google).
1211+
incoming HTTP requests at one's router or firewall.
12141212

12151213
.. _securing:
12161214

@@ -1227,13 +1225,13 @@ are always ways to make your installation more secure:
12271225
* Ensure your PHP setup follows recommendations for production sites, for example
12281226
`display_errors <https://www.php.net/manual/en/errorfunc.configuration.php#ini.display-errors>`_
12291227
should be disabled.
1230-
* Remove the ``tests`` directory from phpMyAdmin, unless you are developing and need a test suite.
1231-
* Remove the ``setup`` directory from phpMyAdmin, you will probably not
1228+
* Remove the :file:`tests/` directory from phpMyAdmin, unless you are developing and need a test suite.
1229+
* Remove the :file:`public/setup/` directory from phpMyAdmin, you will probably not
12321230
use it after the initial setup.
12331231
* Properly choose an authentication method - :ref:`cookie`
12341232
is probably the best choice for shared hosting.
1235-
* Deny access to auxiliary files in :file:`./libraries/` or
1236-
:file:`./templates/` subfolders in your webserver configuration.
1233+
* Deny access to auxiliary files in :file:`libraries/` or
1234+
:file:`resources/templates/` subfolders in your webserver configuration.
12371235
Such configuration prevents from possible path exposure and cross side
12381236
scripting vulnerabilities that might happen to be found in that code. For the
12391237
Apache webserver, this is often accomplished with a :term:`.htaccess` file in
@@ -1248,6 +1246,8 @@ are always ways to make your installation more secure:
12481246
phpMyAdmin, you can use :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` to limit them
12491247
or :config:option:`$cfg['Servers'][$i]['AllowRoot']` to deny root user access.
12501248
* Enable :ref:`2fa` for your account.
1249+
* Consider hiding connection errors from the login page by setting
1250+
:config:option:`$cfg['Servers'][$i]['hide_connection_errors']` to ``true``.
12511251
* Consider hiding phpMyAdmin behind an authentication proxy, so that
12521252
users need to authenticate prior to providing MySQL credentials
12531253
to phpMyAdmin. You can achieve this by configuring your web server to request

docs/transformations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Introduction
1414
++++++++++++
1515

1616
To enable transformations, you have to set up the ``column_info``
17-
table and the proper directives. Please see the :ref:`config` on how to do so.
17+
table and the proper configuration directives. Please see the :ref:`config` on how to do so.
1818

1919
phpMyAdmin has two different types of transformations: browser display
2020
transformations, which affect only how the data is shown when browsing

0 commit comments

Comments
 (0)