From 42960ce08eca8ee4904770f8e6876e8243976bc9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maur=C3=ADcio=20Meneghini=20Fauth?= Date: Tue, 26 Dec 2017 19:10:00 -0200 Subject: [PATCH] Remove trailing whitespace in docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Maurício Meneghini Fauth --- doc/bookmarks.rst | 2 +- doc/charts.rst | 8 +-- doc/config.rst | 42 +++++++------- doc/credits.rst | 1 - doc/faq.rst | 15 +++-- doc/glossary.rst | 126 +++++++++++++++++++++--------------------- doc/import_export.rst | 15 +++-- doc/privileges.rst | 2 +- doc/relations.rst | 2 +- doc/setup.rst | 52 ++++++++--------- doc/vendors.rst | 2 +- 11 files changed, 131 insertions(+), 136 deletions(-) diff --git a/doc/bookmarks.rst b/doc/bookmarks.rst index 45da0fe790..bdab3a83a8 100644 --- a/doc/bookmarks.rst +++ b/doc/bookmarks.rst @@ -3,7 +3,7 @@ Bookmarks ========= -.. note:: +.. note:: You need to have configured the :ref:`linked-tables` for using bookmarks feature. diff --git a/doc/charts.rst b/doc/charts.rst index eaa3706b1f..e94bdaed4a 100644 --- a/doc/charts.rst +++ b/doc/charts.rst @@ -36,7 +36,7 @@ Query results for a simple pie chart can be generated with: .. code-block:: mysql - SELECT 'Food' AS 'expense', + SELECT 'Food' AS 'expense', 1250 AS 'amount' UNION SELECT 'Accommodation', 500 UNION SELECT 'Travel', 720 UNION @@ -69,7 +69,7 @@ Query results for a simple bar or column chart can be generated with: .. code-block:: mysql - SELECT + SELECT 'ACADEMY DINOSAUR' AS 'title', 0.99 AS 'rental_rate', 20.99 AS 'replacement_cost' UNION @@ -116,8 +116,8 @@ Query results for a simple line, spline or timeline chart can be generated with: .. code-block:: mysql - SELECT - DATE('2006-01-08') AS 'date', + SELECT + DATE('2006-01-08') AS 'date', 2056 AS 'revenue', 1378 AS 'cost' UNION SELECT DATE('2006-01-09'), 1898, 2301 UNION diff --git a/doc/config.rst b/doc/config.rst index bae5269621..095ba2e0f4 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -47,7 +47,7 @@ Basic settings :default: ``''`` .. versionchanged:: 4.6.5 - + This setting was not available in phpMyAdmin 4.6.0 - 4.6.4. Sets here the complete :term:`URL` (with full path) to your phpMyAdmin @@ -456,7 +456,7 @@ Server connection settings Since PHP 5.6.0 it also verifies whether server name matches CN of its certificate. There is currently no way to disable just this check without disabling complete SSL verification. - + .. warning:: Disabling the certificate verification defeats purpose of using SSL. @@ -541,19 +541,19 @@ Server connection settings :type: string :default: ``''`` - This special account is used to access :ref:`linked-tables`. + This special account is used to access :ref:`linked-tables`. You don't need it in single user case, but if phpMyAdmin is shared it is recommended to give access to :ref:`linked-tables` only to this user - and configure phpMyAdmin to use it. All users will then be able to use + and configure phpMyAdmin to use it. All users will then be able to use the features without need to have direct access to :ref:`linked-tables`. .. versionchanged:: 2.2.5 those were called ``stduser`` and ``stdpass`` - .. seealso:: - - :ref:`setup`, - :ref:`authentication_modes`, + .. seealso:: + + :ref:`setup`, + :ref:`authentication_modes`, :ref:`linked-tables`, :config:option:`$cfg['Servers'][$i]['pmadb']`, :config:option:`$cfg['Servers'][$i]['controlhost']`, @@ -989,7 +989,7 @@ Server connection settings the need to select the database, and then select the table. When you select a table from the list, it will jump to the page specified in :config:option:`$cfg['NavigationTreeDefaultTabTable']`. - + You can add tables to this list or remove tables from it in database structure page by clicking on the star icons next to table names. Using :config:option:`$cfg['NumFavoriteTables']` you can configure the maximum @@ -1385,7 +1385,7 @@ Server connection settings Disable using ``INFORMATION_SCHEMA`` to retrieve information (use ``SHOW`` commands instead), because of speed issues when many - databases are present. + databases are present. .. note:: @@ -1578,7 +1578,7 @@ Generic settings :default: false .. deprecated:: 4.6.0 - + This setting is no longer available since phpMyAdmin 4.6.0. Please adjust your webserver instead. @@ -1730,8 +1730,8 @@ Cookie authentication options The "cookie" auth\_type uses AES algorithm to encrypt the password. If you are using the "cookie" auth\_type, enter here a random passphrase of your choice. It will be used internally by the AES algorithm: you won’t be - prompted for this passphrase. - + prompted for this passphrase. + The secret should be 32 characters long. Using shorter will lead to weaker security of encrypted cookies, using longer will cause no harm. @@ -1822,7 +1822,7 @@ Cookie authentication options .. code-block:: php // Allow connection to three listed servers: - $cfg['ArbitraryServerRegexp'] = '/^(server|another|yetdifferent)$/'; + $cfg['ArbitraryServerRegexp'] = '/^(server|another|yetdifferent)$/'; // Allow connection to range of IP addresses: $cfg['ArbitraryServerRegexp'] = '@^192\.168\.0\.[0-9]{1,}$@'; @@ -2417,7 +2417,7 @@ Export and import settings identify what they mean. .. config:option:: $cfg['Export']['format'] - + :type: string :default: ``'sql'`` @@ -3336,42 +3336,42 @@ Console settings :default: false Show query history at start - + .. config:option:: $cfg['Console']['AlwaysExpand'] :type: boolean :default: false Always expand query messages - + .. config:option:: $cfg['Console']['CurrentQuery'] :type: boolean :default: true Show current browsing query - + .. config:option:: $cfg['Console']['EnterExecutes'] :type: boolean :default: false Execute queries on Enter and insert new line with Shift + Enter - + .. config:option:: $cfg['Console']['DarkTheme'] :type: boolean :default: false Switch to dark theme - + .. config:option:: $cfg['Console']['Mode'] :type: string :default: 'info' Console mode - + .. config:option:: $cfg['Console']['Height'] :type: integer diff --git a/doc/credits.rst b/doc/credits.rst index 64e01e2864..49ba524dac 100644 --- a/doc/credits.rst +++ b/doc/credits.rst @@ -1105,4 +1105,3 @@ Jannis Hermanns, G. Wieggers. And thanks to everyone else who sent me email with suggestions, bug- reports and or just some feedback. - diff --git a/doc/faq.rst b/doc/faq.rst index 160d57e038..e23c87adb5 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -194,8 +194,8 @@ big or your hosting provider is unwilling to change the settings: 1.17 Which Database versions does phpMyAdmin support? ----------------------------------------------------- -For `MySQL `_, versions 5.5 and newer are supported. -For older MySQL versions, our `Downloads `_ page offers older phpMyAdmin versions +For `MySQL `_, versions 5.5 and newer are supported. +For older MySQL versions, our `Downloads `_ page offers older phpMyAdmin versions (which may have become unsupported). For `MariaDB `_, versions 5.5 and newer are supported. @@ -313,7 +313,7 @@ directory and add the following line to the group [mysqld]: set-variable = lower_case_table_names=0 .. note:: - + Forcing this variable to 0 with --lower-case-table-names=0 on a case-insensitive filesystem and access MyISAM tablenames using different lettercases, index corruption may result. @@ -927,7 +927,7 @@ TableSeparator or disabling that feature. Your table neither have a :term:`primary key` nor an :term:`unique key`, so we must use a long expression to identify this row. This causes problems to -parse\_url function. The workaround is to create a :term:`primary key` +parse\_url function. The workaround is to create a :term:`primary key` or :term:`unique key`. .. _faq3_8: @@ -1387,7 +1387,7 @@ If you see errors like: A potentially unsafe operation has been detected in your request to this site. This is usually caused by web application firewall doing requests filtering. It -tries to prevent SQL injection, however phpMyAdmin is tool designed to execute +tries to prevent SQL injection, however phpMyAdmin is tool designed to execute SQL queries, thus it makes it unusable. Please whitelist phpMyAdmin scripts from the web application firewall settings @@ -1581,7 +1581,7 @@ schema layout. Which tables will go on which pages? Browsers on other operating systems, and other browsers on Windows, do not have this problem. -.. seealso:: +.. seealso:: :ref:`relations` @@ -2065,7 +2065,7 @@ PetType depends on PetBreed. .. _faq6_38: -6.38 How can I reassign auto-incremented values? +6.38 How can I reassign auto-incremented values? ------------------------------------------------ Some users prefer their AUTO_INCREMENT values to be consecutive; this is not @@ -2273,4 +2273,3 @@ Synchronization 9.2 (withdrawn). ---------------- - diff --git a/doc/glossary.rst b/doc/glossary.rst index 196ebce41f..cdad7ac01b 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -8,7 +8,7 @@ From Wikipedia, the free encyclopedia .. glossary:: .htaccess - the default name of Apache's directory-level configuration file. + the default name of Apache's directory-level configuration file. .. seealso:: @@ -16,49 +16,49 @@ From Wikipedia, the free encyclopedia Access Contol List Blowfish - a keyed, symmetric block cipher, designed in 1993 by Bruce Schneier. + a keyed, symmetric block cipher, designed in 1993 by Bruce Schneier. .. seealso:: Browser - a software application that enables a user to display and interact with text, images, and other information typically located on a web page at a website on the World Wide Web. + a software application that enables a user to display and interact with text, images, and other information typically located on a web page at a website on the World Wide Web. .. seealso:: bzip2 - a free software/open source data compression algorithm and program developed by Julian Seward. + a free software/open source data compression algorithm and program developed by Julian Seward. .. seealso:: CGI Common Gateway Interface is an important World Wide Web technology that enables a client web browser to request data from a program executed on - the Web server. + the Web server. .. seealso:: Changelog - a log or record of changes made to a project. + a log or record of changes made to a project. .. seealso:: Client - a computer system that accesses a (remote) service on another computer by some kind of network. + a computer system that accesses a (remote) service on another computer by some kind of network. .. seealso:: column - a set of data values of a particular simple type, one for each row of the table. + a set of data values of a particular simple type, one for each row of the table. .. seealso:: Cookie - a packet of information sent by a server to a World Wide Web browser and then sent back by the browser each time it accesses that server. + a packet of information sent by a server to a World Wide Web browser and then sent back by the browser each time it accesses that server. .. seealso:: CSV - Comma- separated values + Comma- separated values .. seealso:: @@ -66,7 +66,7 @@ From Wikipedia, the free encyclopedia look at :term:`database` database - an organized collection of data. + an organized collection of data. .. seealso:: @@ -74,30 +74,30 @@ From Wikipedia, the free encyclopedia look at :term:`storage engines` extension - a PHP module that extends PHP with additional functionality. + a PHP module that extends PHP with additional functionality. .. seealso:: FAQ Frequently Asked Questions is a list of commonly asked question and there - answers. + answers. .. seealso:: Field - one part of divided data/columns. + one part of divided data/columns. .. seealso:: foreign key a column or group of columns in a database row that point to a key column or group of columns forming a key of another database row in some - (usually different) table. + (usually different) table. .. seealso:: GD - Graphics Library by Thomas Boutell and others for dynamically manipulating images. + Graphics Library by Thomas Boutell and others for dynamically manipulating images. .. seealso:: @@ -105,28 +105,28 @@ From Wikipedia, the free encyclopedia look at :term:`gd` gzip - gzip is short for GNU zip, a GNU free software file compression program. + gzip is short for GNU zip, a GNU free software file compression program. .. seealso:: host - any machine connected to a computer network, a node that has a hostname. + any machine connected to a computer network, a node that has a hostname. .. seealso:: hostname - the unique name by which a network attached device is known on a network. + the unique name by which a network attached device is known on a network. .. seealso:: HTTP HyperText Transfer Protocol is the primary method used to transfer or - convey information on the World Wide Web. + convey information on the World Wide Web. .. seealso:: https - a :term:`HTTP`-connection with additional security measures. + a :term:`HTTP`-connection with additional security measures. .. seealso:: @@ -135,24 +135,24 @@ From Wikipedia, the free encyclopedia IIS Internet Information Services is a set of Internet-based services for - servers using Microsoft Windows. + servers using Microsoft Windows. .. seealso:: Index - a feature that allows quick access to the rows in a table. + a feature that allows quick access to the rows in a table. .. seealso:: IP Internet Protocol is a data-oriented protocol used by source and destination hosts for communicating data across a packet-switched - internetwork. + internetwork. .. seealso:: IP Address - a unique number that devices use in order to identify and communicate with each other on a network utilizing the Internet Protocol standard. + a unique number that devices use in order to identify and communicate with each other on a network utilizing the Internet Protocol standard. .. seealso:: @@ -164,13 +164,13 @@ From Wikipedia, the free encyclopedia .. seealso:: ISAPI - Internet Server Application Programming Interface is the API of Internet Information Services (IIS). + Internet Server Application Programming Interface is the API of Internet Information Services (IIS). .. seealso:: ISP Internet service provider is a business or organization that offers users - access to the Internet and related services. + access to the Internet and related services. .. seealso:: @@ -178,7 +178,7 @@ From Wikipedia, the free encyclopedia International Standards Organisation JPEG - a most commonly used standard method of lossy compression for photographic images. + a most commonly used standard method of lossy compression for photographic images. .. seealso:: @@ -189,17 +189,17 @@ From Wikipedia, the free encyclopedia look at :term:`index` LATEX - a document preparation system for the TEX typesetting program. + a document preparation system for the TEX typesetting program. .. seealso:: Mac - Apple Macintosh is line of personal computers is designed, developed, manufactured, and marketed by Apple Computer. + Apple Macintosh is line of personal computers is designed, developed, manufactured, and marketed by Apple Computer. .. seealso:: Mac OS X - the operating system which is included with all currently shipping Apple Macintosh computers in the consumer and professional markets. + the operating system which is included with all currently shipping Apple Macintosh computers in the consumer and professional markets. .. seealso:: @@ -207,27 +207,27 @@ From Wikipedia, the free encyclopedia The PHP `mbstring` functions provide support for languages represented by multi-byte character sets, most notably UTF-8. If you have troubles installing this extension, please follow :ref:`faqmysql`, it provides useful hints. - + .. seealso:: MCrypt - a cryptographic library. + a cryptographic library. .. seealso:: mcrypt - the MCrypt PHP extension. + the MCrypt PHP extension. .. seealso:: MIME Multipurpose Internet Mail Extensions is - an Internet Standard for the format of e-mail. + an Internet Standard for the format of e-mail. .. seealso:: module - some sort of extension for the Apache Webserver. + some sort of extension for the Apache Webserver. .. seealso:: @@ -236,22 +236,22 @@ From Wikipedia, the free encyclopedia directly as an Apache module. MySQL - a multithreaded, multi-user, SQL (Structured Query Language) Database Management System (DBMS). + a multithreaded, multi-user, SQL (Structured Query Language) Database Management System (DBMS). .. seealso:: mysqli - the improved MySQL client PHP extension. + the improved MySQL client PHP extension. .. seealso:: mysql - the MySQL client PHP extension. + the MySQL client PHP extension. .. seealso:: OpenDocument - open standard for office documents. + open standard for office documents. .. seealso:: @@ -263,18 +263,18 @@ From Wikipedia, the free encyclopedia PDF Portable Document Format is a file format developed by Adobe Systems for representing two dimensional documents in a device independent and - resolution independent format. + resolution independent format. .. seealso:: PEAR - the PHP Extension and Application Repository. + the PHP Extension and Application Repository. .. seealso:: PCRE Perl Compatible Regular Expressions is the perl-compatible regular - expression functions for PHP + expression functions for PHP .. seealso:: @@ -282,12 +282,12 @@ From Wikipedia, the free encyclopedia short for "PHP: Hypertext Preprocessor", is an open-source, reflective programming language used mainly for developing server-side applications and dynamic web content, and more recently, a broader range of software - applications. + applications. .. seealso:: port - a connection through which data is sent and received. + a connection through which data is sent and received. .. seealso:: @@ -311,7 +311,7 @@ From Wikipedia, the free encyclopedia RFC Request for Comments (RFC) documents are a series of memoranda encompassing new research, innovations, and methodologies applicable to - Internet technologies. + Internet technologies. .. seealso:: @@ -321,12 +321,12 @@ From Wikipedia, the free encyclopedia .. seealso:: :rfc:`1952` Row (record, tuple) - represents a single, implicitly structured data item in a table. + represents a single, implicitly structured data item in a table. .. seealso:: Server - a computer system that provides services to other computing systems over a network. + a computer system that provides services to other computing systems over a network. .. seealso:: @@ -342,23 +342,23 @@ From Wikipedia, the free encyclopedia .. seealso:: socket - a form of inter-process communication. + a form of inter-process communication. .. seealso:: SSL Secure Sockets Layer is a cryptographic protocol which provides secure - communication on the Internet. + communication on the Internet. .. seealso:: Stored procedure - a subroutine available to applications accessing a relational database system + a subroutine available to applications accessing a relational database system .. seealso:: SQL - Structured Query Language + Structured Query Language .. seealso:: @@ -366,18 +366,18 @@ From Wikipedia, the free encyclopedia a set of data elements (cells) that is organized, defined and stored as horizontal rows and vertical columns where each item can be uniquely identified by a label or key or by it?s position in relation to other - items. + items. .. seealso:: tar - a type of archive file format: the Tape ARchive format. + a type of archive file format: the Tape ARchive format. .. seealso:: TCP Transmission Control Protocol is one of the core protocols of the - Internet protocol suite. + Internet protocol suite. .. seealso:: @@ -387,7 +387,7 @@ From Wikipedia, the free encyclopedia .. seealso:: trigger - a procedural code that is automatically executed in response to certain events on a particular table or view in a database + a procedural code that is automatically executed in response to certain events on a particular table or view in a database .. seealso:: @@ -395,34 +395,32 @@ From Wikipedia, the free encyclopedia An unique key is an index over one or more fields in a table which has a unique value for each row. The first unique key will be treated as :term:`primary key` if there is no *primary key* defined. - + URL Uniform Resource Locator is a sequence of characters, conforming to a standardized format, that is used for referring to resources, such as - documents and images on the Internet, by their location. + documents and images on the Internet, by their location. .. seealso:: Webserver - A computer (program) that is responsible for accepting HTTP requests from clients and serving them Web pages. + A computer (program) that is responsible for accepting HTTP requests from clients and serving them Web pages. .. seealso:: XML Extensible Markup Language is a W3C-recommended general- purpose markup language for creating special-purpose markup languages, capable of - describing many different kinds of data. + describing many different kinds of data. .. seealso:: ZIP - a popular data compression and archival format. + a popular data compression and archival format. .. seealso:: zlib - an open-source, cross- platform data compression library by Jean-loup Gailly and Mark Adler. + an open-source, cross- platform data compression library by Jean-loup Gailly and Mark Adler. .. seealso:: - - diff --git a/doc/import_export.rst b/doc/import_export.rst index e005be09e7..04d0757e7d 100644 --- a/doc/import_export.rst +++ b/doc/import_export.rst @@ -37,7 +37,7 @@ CSV Comma separated values format which is often used by spreadsheets or various other programs for export/import. .. note:: - + When importing data into a table from a CSV file where the table has an 'auto_increment' field, make the 'auto_increment' value for each record in the CSV field to be '0' (zero). This allows the 'auto_increment' field to @@ -92,7 +92,7 @@ checkbox for "The first line of the file contains the table column names;" this data will go to the proper columns. .. note:: - + Formulas and calculations will NOT be evaluated, rather, their value from the most recent save will be loaded. Please ensure that all values in the spreadsheet are as needed before importing it. @@ -231,7 +231,7 @@ Sample output: "name": "makes", "type": "table" } - ] + ] LaTeX @@ -312,10 +312,10 @@ The option 'Maximal length of created query' seems to be undocumented. But experiments has shown that it splits large extended INSERTS so each one is no bigger than the given number of bytes (or characters?). Thus when importing the file, for large tables you avoid the error "Got a packet bigger than -'max_allowed_packet' bytes". +'max_allowed_packet' bytes". + +.. seealso:: -.. seealso:: - https://dev.mysql.com/doc/refman/5.7/en/packet-too-large.html Data Options @@ -331,7 +331,7 @@ This will significantly decrease filesize for large SQL dumps, increases the INSERT speed when imported, and is generally recommended. .. seealso:: - + http://www.scriptalicious.com/blog/2009/04/complete-inserts-or-extended-inserts-in-phpmyadmin/ Texy! @@ -354,4 +354,3 @@ YAML YAML is a data serialization format which is both human readable and computationally powerful ( ). - diff --git a/doc/privileges.rst b/doc/privileges.rst index 6a7b8c37d1..008276889f 100644 --- a/doc/privileges.rst +++ b/doc/privileges.rst @@ -64,7 +64,7 @@ will see in the phpMyAdmin navigation. functions. So this can not be considered as a security limitation. Should you want to limit what users can do, use MySQL privileges to achieve that. -With this feature enabled, the :guilabel:`User accounts` management interface gains +With this feature enabled, the :guilabel:`User accounts` management interface gains a second tab for managing :guilabel:`User groups`, where you can define what each group will view (see image below) and you can then assign each user to one of these groups. Users will be presented with a simplified user interface, which might be diff --git a/doc/relations.rst b/doc/relations.rst index 609765bd36..cf07aff7e5 100644 --- a/doc/relations.rst +++ b/doc/relations.rst @@ -9,7 +9,7 @@ features when needed. There are two ways of editing these relations, with the *relation view* and the drag-and-drop *designer* -- both of which are explained on this page. -.. note:: +.. note:: You need to have configured the :ref:`linked-tables` for using phpMyAdmin only relations. diff --git a/doc/setup.rst b/doc/setup.rst index cec3fffe18..80df17b59d 100644 --- a/doc/setup.rst +++ b/doc/setup.rst @@ -183,53 +183,53 @@ You can configure several phpMyAdmin features using environment variables: .. envvar:: PMA_ARBITRARY Allows you to enter a database server hostname on login form. - + .. seealso:: :config:option:`$cfg['AllowArbitraryServer']` .. envvar:: PMA_HOST - + Host name or IP address of the database server to use. .. seealso:: :config:option:`$cfg['Servers'][$i]['host']` .. envvar:: PMA_HOSTS - + Comma-separated host names or IP addresses of the database servers to use. .. note:: Used only if :envvar:`PMA_HOST` is empty. .. envvar:: PMA_VERBOSE - + Verbose name of the database server. .. seealso:: :config:option:`$cfg['Servers'][$i]['verbose']` .. envvar:: PMA_VERBOSES - + Comma-separated verbose name of the database servers. .. note:: Used only if :envvar:`PMA_VERBOSE` is empty. .. envvar:: PMA_USER - + User name to use for :ref:`auth_config`. .. envvar:: PMA_PASSWORD - + Password to use for :ref:`auth_config`. .. envvar:: PMA_PORT - + Port of the database server to use. .. envvar:: PMA_PORTS - + Comma-separated ports of the database server to use. .. note:: Used only if :envvar:`PMA_PORT` is empty. .. envvar:: PMA_ABSOLUTE_URI - + The fully-qualified path (``https://pma.example.net/``) where the reverse proxy makes phpMyAdmin available. @@ -242,7 +242,7 @@ By default, :ref:`cookie` is used, but if :envvar:`PMA_USER` and The credentials you need to log in are stored in the MySQL server, in case of Docker image there are various ways to set it (for example - :samp:`MYSQL_ROOT_PASSWORD` when starting the MySQL container). Please check + :samp:`MYSQL_ROOT_PASSWORD` when starting the MySQL container). Please check documentation for `MariaDB container `_ or `MySQL container `_. @@ -254,7 +254,7 @@ Customizing configuration Additionally configuration can be tweaked by :file:`/etc/phpmyadmin/config.user.inc.php`. If this file exists, it will be loaded after configuration is generated from above environment variables, so you can override any configuration variable. This -configuration can be added as a volume when invoking docker using +configuration can be added as a volume when invoking docker using `-v /some/local/directory/config.user.inc.php:/etc/phpmyadmin/config.user.inc.php` parameters. Note that the supplied configuration file is applied after :ref:`docker-vars`, @@ -291,8 +291,8 @@ environment variables listed in :ref:`docker-vars`: ], ]; -.. seealso:: - +.. seealso:: + See :ref:`config` for detailed description of configuration options. Docker Volumes @@ -306,7 +306,7 @@ You can use following volumes to customize image behavior: :file:`/sessions/` - Directory where PHP sessions are stored. You might want to share this + Directory where PHP sessions are stored. You might want to share this for example when using :ref:`auth_signon`. :file:`/www/themes/` @@ -393,7 +393,7 @@ Running behind haproxy in a subdirectory When you want to expose phpMyAdmin running in a Docker container in a subdirectory, you need to rewrite the request path in the server proxying the -requests. +requests. For example using haproxy it can be done as: @@ -409,15 +409,15 @@ For example using haproxy it can be done as: # /phpmyadmin acl phpmyadmin path_dir /phpmyadmin - use_backend phpmyadmin if phpmyadmin LOCALNET + use_backend phpmyadmin if phpmyadmin LOCALNET backend phpmyadmin mode http - reqirep ^(GET|POST|HEAD)\ /phpmyadmin/(.*) \1\ /\2 + reqirep ^(GET|POST|HEAD)\ /phpmyadmin/(.*) \1\ /\2 # phpMyAdmin container IP - server localhost 172.30.21.21:80 + server localhost 172.30.21.21:80 When using traefik, something like following should work: @@ -550,13 +550,13 @@ For a full explanation of possible configuration values, see the Using Setup script ------------------ -Instead of manually editing :file:`config.inc.php`, you can use phpMyAdmin's -setup feature. The file can be generated using the setup and you can download it +Instead of manually editing :file:`config.inc.php`, you can use phpMyAdmin's +setup feature. The file can be generated using the setup and you can download it for upload to the server. Next, open your browser and visit the location where you installed phpMyAdmin, -with the ``/setup`` suffix. The changes are not saved to the server, you need to -use the :guilabel:`Download` button to save them to your computer and then upload +with the ``/setup`` suffix. The changes are not saved to the server, you need to +use the :guilabel:`Download` button to save them to your computer and then upload to the server. Now the file is ready to be used. You can choose to review or edit the @@ -592,7 +592,7 @@ To allow editing configuration invoke: To block editing configuration invoke: .. code-block:: sh - + /usr/sbin/pma-secure Setup script on openSUSE @@ -1030,7 +1030,7 @@ are always ways to make your installation more secure: * Serve phpMyAdmin on HTTPS only. Preferably, you should use HSTS as well, so that you're protected from protocol downgrade attacks. * Ensure your PHP setup follows recommendations for production sites, for example - `display_errors `_ + `display_errors `_ should be disabled. * Remove the ``test`` directory from phpMyAdmin, unless you are developing and need test suite. * Remove the ``setup`` directory from phpMyAdmin, you will probably not @@ -1057,7 +1057,7 @@ are always ways to make your installation more secure: users need to authenticate prior to providing MySQL credentials to phpMyAdmin. You can achieve this by configuring your web server to request HTTP authentication. For example in Apache this can be done with: - + .. code-block:: apache AuthType Basic diff --git a/doc/vendors.rst b/doc/vendors.rst index b7ef2a066f..aaceee344e 100644 --- a/doc/vendors.rst +++ b/doc/vendors.rst @@ -28,5 +28,5 @@ js/jquery jQuery js framework and various jQuery based libraries. vendor/ - The download kit includes various Composer packages as + The download kit includes various Composer packages as dependencies.