Skip to content

Commit

Permalink
Merge pull request #6933 from kenjis/fix-docs-supported-db
Browse files Browse the repository at this point in the history
docs: add references to supported databases
  • Loading branch information
kenjis authored Dec 3, 2022
2 parents e18cb59 + 728e86f commit 197e996
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
3 changes: 3 additions & 0 deletions user_guide_src/source/database/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ Database Configuration
:local:
:depth: 2

.. note::
See :ref:`requirements-supported-databases` for currently supported database drivers.

***********
Config File
***********
Expand Down
18 changes: 18 additions & 0 deletions user_guide_src/source/intro/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,24 @@
Server Requirements
###################

.. contents::
:local:
:depth: 2

***************************
PHP and Required Extensions
***************************

`PHP <https://www.php.net/>`_ version 7.4 or newer is required, with the following PHP extensions are enabled:

- `intl <https://www.php.net/manual/en/intl.requirements.php>`_
- `mbstring <https://www.php.net/manual/en/mbstring.requirements.php>`_
- `json <https://www.php.net/manual/en/json.requirements.php>`_

***********************
Optional PHP Extensions
***********************

The following PHP extensions should be enabled on your server:

- `mysqlnd <https://www.php.net/manual/en/mysqlnd.install.php>`_ (if you use MySQL)
Expand All @@ -28,6 +40,12 @@ The following PHP extensions are required when you use PHPUnit:
- `libxml <https://www.php.net/manual/en/libxml.requirements.php>`_ (if you use :doc:`TestResponse </testing/response>` class)
- `xdebug <https://xdebug.org/docs/install>`_ (if you use ``CIUnitTestCase::assertHeaderEmitted()``)

.. _requirements-supported-databases:

*******************
Supported Databases
*******************

A database is required for most web application programming.
Currently supported databases are:

Expand Down
4 changes: 2 additions & 2 deletions user_guide_src/source/tutorial/news_section.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Create a Database to Work with
******************************

The CodeIgniter installation assumes that you have set up an appropriate
database, as outlined in the :doc:`requirements </intro/requirements>`.
database, as outlined in the :ref:`requirements <requirements-supported-databases>`.
In this tutorial, we provide SQL code for a MySQL database, and
we also assume that you have a suitable client for issuing database
commands (mysql, MySQL Workbench, or phpMyAdmin).
Expand Down Expand Up @@ -54,7 +54,7 @@ Connect to Your Database
The local configuration file, ``.env``, that you created when you installed
CodeIgniter, should have the database property settings uncommented and
set appropriately for the database you want to use. Make sure you've configured
your database properly as described :doc:`here <../database/configuration>`::
your database properly as described in :doc:`../database/configuration`::

database.default.hostname = localhost
database.default.database = ci4tutorial
Expand Down

0 comments on commit 197e996

Please sign in to comment.