Skip to content

Commit 9d23926

Browse files
authored
Merge pull request #5248 from kenjis/fix-docs-dotenv
docs: decorate `.env` with `**`
2 parents 7ae9a8b + 568d8a9 commit 9d23926

File tree

8 files changed

+13
-13
lines changed

8 files changed

+13
-13
lines changed

user_guide_src/source/database/configuration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Database Configuration
99
CodeIgniter has a config file that lets you store your database
1010
connection values (username, password, database name, etc.). The config
1111
file is located at **app/Config/Database.php**. You can also set
12-
database connection values in the .env file. See below for more details.
12+
database connection values in the **.env** file. See below for more details.
1313

1414
The config settings are stored in a class property that is an array with this
1515
prototype::
@@ -162,7 +162,7 @@ within the class' constructor::
162162
Configuring With .env File
163163
--------------------------
164164

165-
You can also save your configuration values within a ``.env`` file with the current server's
165+
You can also save your configuration values within a **.env** file with the current server's
166166
database settings. You only need to enter the values that change from what is in the
167167
default group's configuration settings. The values should be name following this format, where
168168
``default`` is the group name::

user_guide_src/source/general/common_functions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Service Accessors
6363
or return a default value if it is not found. Will format boolean values
6464
to actual booleans instead of string representations.
6565

66-
Especially useful when used in conjunction with .env files for setting
66+
Especially useful when used in conjunction with **.env** files for setting
6767
values that are specific to the environment itself, like database
6868
settings, API keys, etc.
6969

user_guide_src/source/general/configuration.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,15 +191,15 @@ Environment Variables as Replacements for Data
191191
==============================================
192192

193193
It is very important to always remember that environment variables contained in your **.env** are
194-
**only replacements for existing data**. This means that you cannot expect to fill your ``.env`` with all
194+
**only replacements for existing data**. This means that you cannot expect to fill your **.env** with all
195195
the replacements for your configurations but have nothing to receive these replacements in the
196196
related configuration file(s).
197197

198-
The ``.env`` only serves to fill or replace the values in your configuration files. That said, your
198+
The **.env** only serves to fill or replace the values in your configuration files. That said, your
199199
configuration files should have a container or receiving property for those. Adding so many variables in
200-
your ``.env`` with nothing to contain them in the receiving end is useless.
200+
your **.env** with nothing to contain them in the receiving end is useless.
201201

202-
Simply put, you cannot just put ``app.myNewConfig = foo`` in your ``.env`` and expect your ``Config\App``
202+
Simply put, you cannot just put ``app.myNewConfig = foo`` in your **.env** and expect your ``Config\App``
203203
to magically have that property and value at run time.
204204

205205
Treating Environment Variables as Arrays

user_guide_src/source/general/errors.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Configuration
5555

5656
By default, CodeIgniter will display all errors in the ``development`` and ``testing`` environments, and will not
5757
display any errors in the ``production`` environment. You can change this by setting the ``CI_ENVIRONMENT`` variable
58-
in the ``.env`` file.
58+
in the **.env** file.
5959

6060
.. important:: Disabling error reporting DOES NOT stop logs from being written if there are errors.
6161

user_guide_src/source/installation/running.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ Initial Configuration & Set Up
1717

1818
#. Open the **app/Config/App.php** file with a text editor and
1919
set your base URL. If you need more flexibility, the baseURL may
20-
be set within the ``.env`` file as **app.baseURL="http://example.com/"**.
20+
be set within the **.env** file as ``app.baseURL="http://example.com/"``.
2121
(Always use a trailing slash on your base URL!)
2222
#. If you intend to use a database, open the
2323
**app/Config/Database.php** file with a text editor and set your
24-
database settings. Alternately, these could be set in your ``.env`` file.
24+
database settings. Alternately, these could be set in your **.env** file.
2525

2626
One additional measure to take in production environments is to disable
2727
PHP error reporting and any other development-only functionality. In

user_guide_src/source/installation/troubleshooting.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ unrecoverable error, which we don't want to show to the viewer of
6565
the webapp, for better security.
6666

6767
You can see the error in the debug toolbar display by setting your environment to
68-
"development" (in `.env`), and reloading the page.
68+
"development" (in **.env**), and reloading the page.
6969

7070
Don't forget to reset the environment to "production" once you fix the problem!
7171

user_guide_src/source/libraries/encryption.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ the library.
153153
// or
154154
public $key = 'base64:<your-base64-encoded-key>'
155155

156-
Similarly, you can use these prefixes in your ``.env`` file, too!
156+
Similarly, you can use these prefixes in your **.env** file, too!
157157
::
158158

159159
// For hex2bin

user_guide_src/source/libraries/honeypot.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Customizing Honeypot
3636
=====================
3737

3838
Honeypot can be customized. The fields below can be set either in
39-
**app/Config/Honeypot.php** or in ``.env``.
39+
**app/Config/Honeypot.php** or in **.env**.
4040

4141
* ``hidden`` - true|false to control visibility of the honeypot field; default is ``true``
4242
* ``label`` - HTML label for the honeypot field, default is 'Fill This Field'

0 commit comments

Comments
 (0)