docs: improve dotenv file explanation#7498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenjis merged 6 commits into from
May 16, 2023
Merged

docs: improve dotenv file explanation #7498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2d574c3
docs: add section titles
kenjis May 13, 2023
c9b62d8
docs: fix section level
kenjis May 13, 2023
f647602
docs: add empty line
kenjis May 13, 2023
4a5030d
docs: change important to warning
kenjis May 13, 2023
6c33a3c
docs: add spaces before and after `=`
kenjis May 13, 2023
075fa7d
docs: add link to dotenv file explanation
kenjis May 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 25 additions & 13 deletions user_guide_src/source/general/configuration.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,19 +65,26 @@ Environment Variables should also be used for anything private such as passwords

.. _dotenv-file:

Environment Variables and CodeIgniter
=====================================
Dotenv File
===========

CodeIgniter makes it simple and painless to set Environment Variables by using a "dotenv" file. The term comes from the file name, which starts with a dot before the text "env".

CodeIgniter expects **.env** to be at the root of your project alongside the
``app`` directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (**.**) at the start?).
Creating Dotenv File
--------------------

CodeIgniter expects the **.env** file to be at the root of your project alongside the
**app** directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (``.``) at the start?).

It has a large collection of variables your project might use that have been assigned
empty, dummy, or default values. You can use this file as a starting place for your
application by either renaming the template to **.env**, or by making a copy of it named **.env**.

.. important:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.
.. warning:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.

Setting Variables
-----------------

Settings are stored in **.env** files as a simple a collection of name/value pairs separated by an equal sign.
::
Expand All@@ -88,27 +95,32 @@ Settings are stored in **.env** files as a simple a collection of name/value pai

When your application runs, **.env** will be loaded automatically, and the variables put
into the environment. If a variable already exists in the environment, it will NOT be
overwritten. The loaded Environment variables are accessed using any of the following:
overwritten.

Getting Variables
-----------------

The loaded environment variables are accessed using any of the following:
``getenv()``, ``$_SERVER``, or ``$_ENV``.

.. literalinclude:: configuration/005.php

.. warning:: Note that your settings from the **.env** file are added to Environment Variables. As a side effect, this means that if your CodeIgniter application is (for example) generating a ``var_dump($_ENV)`` or ``phpinfo()`` (for debugging or other valid reasons) **your secure credentials are publicly exposed**.

Nesting Variables
=================
-----------------

To save on typing, you can reuse variables that you've already specified in the file by wrapping the
variable name within ``${...}``:

::

BASE_DIR="/var/webroot/project-root"
CACHE_DIR="${BASE_DIR}/cache"
TMP_DIR="${BASE_DIR}/tmp"
BASE_DIR = "/var/webroot/project-root"
CACHE_DIR = "${BASE_DIR}/cache"
TMP_DIR = "${BASE_DIR}/tmp"

Namespaced Variables
====================
--------------------

There will be times when you will have several variables with the same name.
The system needs a way of knowing what the correct setting should be.
Expand All@@ -122,7 +134,7 @@ prefix followed by a dot (.), and then the variable name itself.

// not namespaced variables
name = "George"
db=my_db
db = my_db

// namespaced variables
address.city = "Berlin"
Expand Down
2 changes: 1 addition & 1 deletion user_guide_src/source/installation/running.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ Initial Configuration

#. Open the **app/Config/App.php** file with a text editor and
set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
be set within the **.env** file as ``app.baseURL = 'http://example.com/'``.
be set within the :ref:`.env <dotenv-file>` file as ``app.baseURL = 'http://example.com/'``.
(Always use a trailing slash on your base URL!)

.. note:: If you don't set the ``baseURL`` correctly, in development mode,
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
docs: improve dotenv file explanation#7498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

May 16, 2023
 Merged


docs: improve dotenv file explanation
#7498
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2d574c3

docs: add section titles


kenjis May 13, 2023
c9b62d8

docs: fix section level


kenjis May 13, 2023
f647602

docs: add empty line


kenjis May 13, 2023
4a5030d

docs: change important to warning


kenjis May 13, 2023
6c33a3c

docs: add spaces before and after `=`


kenjis May 13, 2023
075fa7d

docs: add link to dotenv file explanation


kenjis May 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 25 additions & 13 deletions
user_guide_src/source/general/configuration.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,19 +65,26 @@ Environment Variables should also be used for anything private such as passwords

.. _dotenv-file:

Environment Variables and CodeIgniter
=====================================
Dotenv File
===========

CodeIgniter makes it simple and painless to set Environment Variables by using a "dotenv" file. The term comes from the file name, which starts with a dot before the text "env".

CodeIgniter expects **.env** to be at the root of your project alongside the
``app`` directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (**.**) at the start?).
Creating Dotenv File
--------------------

CodeIgniter expects the **.env** file to be at the root of your project alongside the
**app** directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (``.``) at the start?).

It has a large collection of variables your project might use that have been assigned
empty, dummy, or default values. You can use this file as a starting place for your
application by either renaming the template to **.env**, or by making a copy of it named **.env**.

.. important:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.
.. warning:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.

Setting Variables
-----------------

Settings are stored in **.env** files as a simple a collection of name/value pairs separated by an equal sign.
::
Expand All@@ -88,27 +95,32 @@ Settings are stored in **.env** files as a simple a collection of name/value pai

When your application runs, **.env** will be loaded automatically, and the variables put
into the environment. If a variable already exists in the environment, it will NOT be
overwritten. The loaded Environment variables are accessed using any of the following:
overwritten.

Getting Variables
-----------------

The loaded environment variables are accessed using any of the following:
``getenv()``, ``$_SERVER``, or ``$_ENV``.

.. literalinclude:: configuration/005.php

.. warning:: Note that your settings from the **.env** file are added to Environment Variables. As a side effect, this means that if your CodeIgniter application is (for example) generating a ``var_dump($_ENV)`` or ``phpinfo()`` (for debugging or other valid reasons) **your secure credentials are publicly exposed**.

Nesting Variables
=================
-----------------

To save on typing, you can reuse variables that you've already specified in the file by wrapping the
variable name within ``${...}``:

::

 BASE_DIR="/var/webroot/project-root"
 CACHE_DIR="${BASE_DIR}/cache"
 TMP_DIR="${BASE_DIR}/tmp"
 BASE_DIR = "/var/webroot/project-root"
 CACHE_DIR = "${BASE_DIR}/cache"
 TMP_DIR = "${BASE_DIR}/tmp"

Namespaced Variables
====================
--------------------

There will be times when you will have several variables with the same name.
The system needs a way of knowing what the correct setting should be.
Expand All@@ -122,7 +134,7 @@ prefix followed by a dot (.), and then the variable name itself.

 // not namespaced variables
 name = "George"
 db=my_db
 db = my_db

 // namespaced variables
 address.city = "Berlin"
Expand Down

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ Initial Configuration

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
 be set within the **.env** file as ``app.baseURL = 'http://example.com/'``.
 be set within the :ref:`.env <dotenv-file>` file as ``app.baseURL = 'http://example.com/'``.
 (Always use a trailing slash on your base URL!)

 .. note:: If you don't set the ``baseURL`` correctly, in development mode,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: improve dotenv file explanation#7498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

May 16, 2023
 Merged


docs: improve dotenv file explanation
#7498
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2d574c3

docs: add section titles


kenjis May 13, 2023
c9b62d8

docs: fix section level


kenjis May 13, 2023
f647602

docs: add empty line


kenjis May 13, 2023
4a5030d

docs: change important to warning


kenjis May 13, 2023
6c33a3c

docs: add spaces before and after `=`


kenjis May 13, 2023
075fa7d

docs: add link to dotenv file explanation


kenjis May 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 25 additions & 13 deletions
user_guide_src/source/general/configuration.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,19 +65,26 @@ Environment Variables should also be used for anything private such as passwords

.. _dotenv-file:

Environment Variables and CodeIgniter
=====================================
Dotenv File
===========

CodeIgniter makes it simple and painless to set Environment Variables by using a "dotenv" file. The term comes from the file name, which starts with a dot before the text "env".

CodeIgniter expects **.env** to be at the root of your project alongside the
``app`` directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (**.**) at the start?).
Creating Dotenv File
--------------------

CodeIgniter expects the **.env** file to be at the root of your project alongside the
**app** directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (``.``) at the start?).

It has a large collection of variables your project might use that have been assigned
empty, dummy, or default values. You can use this file as a starting place for your
application by either renaming the template to **.env**, or by making a copy of it named **.env**.

.. important:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.
.. warning:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.

Setting Variables
-----------------

Settings are stored in **.env** files as a simple a collection of name/value pairs separated by an equal sign.
::
Expand All@@ -88,27 +95,32 @@ Settings are stored in **.env** files as a simple a collection of name/value pai

When your application runs, **.env** will be loaded automatically, and the variables put
into the environment. If a variable already exists in the environment, it will NOT be
overwritten. The loaded Environment variables are accessed using any of the following:
overwritten.

Getting Variables
-----------------

The loaded environment variables are accessed using any of the following:
``getenv()``, ``$_SERVER``, or ``$_ENV``.

.. literalinclude:: configuration/005.php

.. warning:: Note that your settings from the **.env** file are added to Environment Variables. As a side effect, this means that if your CodeIgniter application is (for example) generating a ``var_dump($_ENV)`` or ``phpinfo()`` (for debugging or other valid reasons) **your secure credentials are publicly exposed**.

Nesting Variables
=================
-----------------

To save on typing, you can reuse variables that you've already specified in the file by wrapping the
variable name within ``${...}``:

::

 BASE_DIR="/var/webroot/project-root"
 CACHE_DIR="${BASE_DIR}/cache"
 TMP_DIR="${BASE_DIR}/tmp"
 BASE_DIR = "/var/webroot/project-root"
 CACHE_DIR = "${BASE_DIR}/cache"
 TMP_DIR = "${BASE_DIR}/tmp"

Namespaced Variables
====================
--------------------

There will be times when you will have several variables with the same name.
The system needs a way of knowing what the correct setting should be.
Expand All@@ -122,7 +134,7 @@ prefix followed by a dot (.), and then the variable name itself.

 // not namespaced variables
 name = "George"
 db=my_db
 db = my_db

 // namespaced variables
 address.city = "Berlin"
Expand Down

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ Initial Configuration

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
 be set within the **.env** file as ``app.baseURL = 'http://example.com/'``.
 be set within the :ref:`.env <dotenv-file>` file as ``app.baseURL = 'http://example.com/'``.
 (Always use a trailing slash on your base URL!)

 .. note:: If you don't set the ``baseURL`` correctly, in development mode,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: improve dotenv file explanation#7498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

May 16, 2023
 Merged


docs: improve dotenv file explanation
#7498
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2d574c3

docs: add section titles


kenjis May 13, 2023
c9b62d8

docs: fix section level


kenjis May 13, 2023
f647602

docs: add empty line


kenjis May 13, 2023
4a5030d

docs: change important to warning


kenjis May 13, 2023
6c33a3c

docs: add spaces before and after `=`


kenjis May 13, 2023
075fa7d

docs: add link to dotenv file explanation


kenjis May 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 25 additions & 13 deletions
user_guide_src/source/general/configuration.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,19 +65,26 @@ Environment Variables should also be used for anything private such as passwords

.. _dotenv-file:

Environment Variables and CodeIgniter
=====================================
Dotenv File
===========

CodeIgniter makes it simple and painless to set Environment Variables by using a "dotenv" file. The term comes from the file name, which starts with a dot before the text "env".

CodeIgniter expects **.env** to be at the root of your project alongside the
``app`` directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (**.**) at the start?).
Creating Dotenv File
--------------------

CodeIgniter expects the **.env** file to be at the root of your project alongside the
**app** directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (``.``) at the start?).

It has a large collection of variables your project might use that have been assigned
empty, dummy, or default values. You can use this file as a starting place for your
application by either renaming the template to **.env**, or by making a copy of it named **.env**.

.. important:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.
.. warning:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.

Setting Variables
-----------------

Settings are stored in **.env** files as a simple a collection of name/value pairs separated by an equal sign.
::
Expand All@@ -88,27 +95,32 @@ Settings are stored in **.env** files as a simple a collection of name/value pai

When your application runs, **.env** will be loaded automatically, and the variables put
into the environment. If a variable already exists in the environment, it will NOT be
overwritten. The loaded Environment variables are accessed using any of the following:
overwritten.

Getting Variables
-----------------

The loaded environment variables are accessed using any of the following:
``getenv()``, ``$_SERVER``, or ``$_ENV``.

.. literalinclude:: configuration/005.php

.. warning:: Note that your settings from the **.env** file are added to Environment Variables. As a side effect, this means that if your CodeIgniter application is (for example) generating a ``var_dump($_ENV)`` or ``phpinfo()`` (for debugging or other valid reasons) **your secure credentials are publicly exposed**.

Nesting Variables
=================
-----------------

To save on typing, you can reuse variables that you've already specified in the file by wrapping the
variable name within ``${...}``:

::

 BASE_DIR="/var/webroot/project-root"
 CACHE_DIR="${BASE_DIR}/cache"
 TMP_DIR="${BASE_DIR}/tmp"
 BASE_DIR = "/var/webroot/project-root"
 CACHE_DIR = "${BASE_DIR}/cache"
 TMP_DIR = "${BASE_DIR}/tmp"

Namespaced Variables
====================
--------------------

There will be times when you will have several variables with the same name.
The system needs a way of knowing what the correct setting should be.
Expand All@@ -122,7 +134,7 @@ prefix followed by a dot (.), and then the variable name itself.

 // not namespaced variables
 name = "George"
 db=my_db
 db = my_db

 // namespaced variables
 address.city = "Berlin"
Expand Down

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ Initial Configuration

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
 be set within the **.env** file as ``app.baseURL = 'http://example.com/'``.
 be set within the :ref:`.env <dotenv-file>` file as ``app.baseURL = 'http://example.com/'``.
 (Always use a trailing slash on your base URL!)

 .. note:: If you don't set the ``baseURL`` correctly, in development mode,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
docs: improve dotenv file explanation#7498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

May 16, 2023
 Merged


docs: improve dotenv file explanation
#7498
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2d574c3

docs: add section titles


kenjis May 13, 2023
c9b62d8

docs: fix section level


kenjis May 13, 2023
f647602

docs: add empty line


kenjis May 13, 2023
4a5030d

docs: change important to warning


kenjis May 13, 2023
6c33a3c

docs: add spaces before and after `=`


kenjis May 13, 2023
075fa7d

docs: add link to dotenv file explanation


kenjis May 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 25 additions & 13 deletions
user_guide_src/source/general/configuration.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,19 +65,26 @@ Environment Variables should also be used for anything private such as passwords

.. _dotenv-file:

Environment Variables and CodeIgniter
=====================================
Dotenv File
===========

CodeIgniter makes it simple and painless to set Environment Variables by using a "dotenv" file. The term comes from the file name, which starts with a dot before the text "env".

CodeIgniter expects **.env** to be at the root of your project alongside the
``app`` directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (**.**) at the start?).
Creating Dotenv File
--------------------

CodeIgniter expects the **.env** file to be at the root of your project alongside the
**app** directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (``.``) at the start?).

It has a large collection of variables your project might use that have been assigned
empty, dummy, or default values. You can use this file as a starting place for your
application by either renaming the template to **.env**, or by making a copy of it named **.env**.

.. important:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.
.. warning:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.

Setting Variables
-----------------

Settings are stored in **.env** files as a simple a collection of name/value pairs separated by an equal sign.
::
Expand All@@ -88,27 +95,32 @@ Settings are stored in **.env** files as a simple a collection of name/value pai

When your application runs, **.env** will be loaded automatically, and the variables put
into the environment. If a variable already exists in the environment, it will NOT be
overwritten. The loaded Environment variables are accessed using any of the following:
overwritten.

Getting Variables
-----------------

The loaded environment variables are accessed using any of the following:
``getenv()``, ``$_SERVER``, or ``$_ENV``.

.. literalinclude:: configuration/005.php

.. warning:: Note that your settings from the **.env** file are added to Environment Variables. As a side effect, this means that if your CodeIgniter application is (for example) generating a ``var_dump($_ENV)`` or ``phpinfo()`` (for debugging or other valid reasons) **your secure credentials are publicly exposed**.

Nesting Variables
=================
-----------------

To save on typing, you can reuse variables that you've already specified in the file by wrapping the
variable name within ``${...}``:

::

 BASE_DIR="/var/webroot/project-root"
 CACHE_DIR="${BASE_DIR}/cache"
 TMP_DIR="${BASE_DIR}/tmp"
 BASE_DIR = "/var/webroot/project-root"
 CACHE_DIR = "${BASE_DIR}/cache"
 TMP_DIR = "${BASE_DIR}/tmp"

Namespaced Variables
====================
--------------------

There will be times when you will have several variables with the same name.
The system needs a way of knowing what the correct setting should be.
Expand All@@ -122,7 +134,7 @@ prefix followed by a dot (.), and then the variable name itself.

 // not namespaced variables
 name = "George"
 db=my_db
 db = my_db

 // namespaced variables
 address.city = "Berlin"
Expand Down

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ Initial Configuration

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
 be set within the **.env** file as ``app.baseURL = 'http://example.com/'``.
 be set within the :ref:`.env <dotenv-file>` file as ``app.baseURL = 'http://example.com/'``.
 (Always use a trailing slash on your base URL!)

 .. note:: If you don't set the ``baseURL`` correctly, in development mode,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: improve dotenv file explanation#7498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

May 16, 2023
 Merged


docs: improve dotenv file explanation
#7498
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2d574c3

docs: add section titles


kenjis May 13, 2023
c9b62d8

docs: fix section level


kenjis May 13, 2023
f647602

docs: add empty line


kenjis May 13, 2023
4a5030d

docs: change important to warning


kenjis May 13, 2023
6c33a3c

docs: add spaces before and after `=`


kenjis May 13, 2023
075fa7d

docs: add link to dotenv file explanation


kenjis May 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 25 additions & 13 deletions
user_guide_src/source/general/configuration.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,19 +65,26 @@ Environment Variables should also be used for anything private such as passwords

.. _dotenv-file:

Environment Variables and CodeIgniter
=====================================
Dotenv File
===========

CodeIgniter makes it simple and painless to set Environment Variables by using a "dotenv" file. The term comes from the file name, which starts with a dot before the text "env".

CodeIgniter expects **.env** to be at the root of your project alongside the
``app`` directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (**.**) at the start?).
Creating Dotenv File
--------------------

CodeIgniter expects the **.env** file to be at the root of your project alongside the
**app** directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (``.``) at the start?).

It has a large collection of variables your project might use that have been assigned
empty, dummy, or default values. You can use this file as a starting place for your
application by either renaming the template to **.env**, or by making a copy of it named **.env**.

.. important:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.
.. warning:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.

Setting Variables
-----------------

Settings are stored in **.env** files as a simple a collection of name/value pairs separated by an equal sign.
::
Expand All@@ -88,27 +95,32 @@ Settings are stored in **.env** files as a simple a collection of name/value pai

When your application runs, **.env** will be loaded automatically, and the variables put
into the environment. If a variable already exists in the environment, it will NOT be
overwritten. The loaded Environment variables are accessed using any of the following:
overwritten.

Getting Variables
-----------------

The loaded environment variables are accessed using any of the following:
``getenv()``, ``$_SERVER``, or ``$_ENV``.

.. literalinclude:: configuration/005.php

.. warning:: Note that your settings from the **.env** file are added to Environment Variables. As a side effect, this means that if your CodeIgniter application is (for example) generating a ``var_dump($_ENV)`` or ``phpinfo()`` (for debugging or other valid reasons) **your secure credentials are publicly exposed**.

Nesting Variables
=================
-----------------

To save on typing, you can reuse variables that you've already specified in the file by wrapping the
variable name within ``${...}``:

::

 BASE_DIR="/var/webroot/project-root"
 CACHE_DIR="${BASE_DIR}/cache"
 TMP_DIR="${BASE_DIR}/tmp"
 BASE_DIR = "/var/webroot/project-root"
 CACHE_DIR = "${BASE_DIR}/cache"
 TMP_DIR = "${BASE_DIR}/tmp"

Namespaced Variables
====================
--------------------

There will be times when you will have several variables with the same name.
The system needs a way of knowing what the correct setting should be.
Expand All@@ -122,7 +134,7 @@ prefix followed by a dot (.), and then the variable name itself.

 // not namespaced variables
 name = "George"
 db=my_db
 db = my_db

 // namespaced variables
 address.city = "Berlin"
Expand Down

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ Initial Configuration

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
 be set within the **.env** file as ``app.baseURL = 'http://example.com/'``.
 be set within the :ref:`.env <dotenv-file>` file as ``app.baseURL = 'http://example.com/'``.
 (Always use a trailing slash on your base URL!)

 .. note:: If you don't set the ``baseURL`` correctly, in development mode,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs: improve dotenv file explanation#7498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

May 16, 2023
 Merged


docs: improve dotenv file explanation
#7498
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2d574c3

docs: add section titles


kenjis May 13, 2023
c9b62d8

docs: fix section level


kenjis May 13, 2023
f647602

docs: add empty line


kenjis May 13, 2023
4a5030d

docs: change important to warning


kenjis May 13, 2023
6c33a3c

docs: add spaces before and after `=`


kenjis May 13, 2023
075fa7d

docs: add link to dotenv file explanation


kenjis May 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 25 additions & 13 deletions
user_guide_src/source/general/configuration.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,19 +65,26 @@ Environment Variables should also be used for anything private such as passwords

.. _dotenv-file:

Environment Variables and CodeIgniter
=====================================
Dotenv File
===========

CodeIgniter makes it simple and painless to set Environment Variables by using a "dotenv" file. The term comes from the file name, which starts with a dot before the text "env".

CodeIgniter expects **.env** to be at the root of your project alongside the
``app`` directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (**.**) at the start?).
Creating Dotenv File
--------------------

CodeIgniter expects the **.env** file to be at the root of your project alongside the
**app** directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (``.``) at the start?).

It has a large collection of variables your project might use that have been assigned
empty, dummy, or default values. You can use this file as a starting place for your
application by either renaming the template to **.env**, or by making a copy of it named **.env**.

.. important:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.
.. warning:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.

Setting Variables
-----------------

Settings are stored in **.env** files as a simple a collection of name/value pairs separated by an equal sign.
::
Expand All@@ -88,27 +95,32 @@ Settings are stored in **.env** files as a simple a collection of name/value pai

When your application runs, **.env** will be loaded automatically, and the variables put
into the environment. If a variable already exists in the environment, it will NOT be
overwritten. The loaded Environment variables are accessed using any of the following:
overwritten.

Getting Variables
-----------------

The loaded environment variables are accessed using any of the following:
``getenv()``, ``$_SERVER``, or ``$_ENV``.

.. literalinclude:: configuration/005.php

.. warning:: Note that your settings from the **.env** file are added to Environment Variables. As a side effect, this means that if your CodeIgniter application is (for example) generating a ``var_dump($_ENV)`` or ``phpinfo()`` (for debugging or other valid reasons) **your secure credentials are publicly exposed**.

Nesting Variables
=================
-----------------

To save on typing, you can reuse variables that you've already specified in the file by wrapping the
variable name within ``${...}``:

::

 BASE_DIR="/var/webroot/project-root"
 CACHE_DIR="${BASE_DIR}/cache"
 TMP_DIR="${BASE_DIR}/tmp"
 BASE_DIR = "/var/webroot/project-root"
 CACHE_DIR = "${BASE_DIR}/cache"
 TMP_DIR = "${BASE_DIR}/tmp"

Namespaced Variables
====================
--------------------

There will be times when you will have several variables with the same name.
The system needs a way of knowing what the correct setting should be.
Expand All@@ -122,7 +134,7 @@ prefix followed by a dot (.), and then the variable name itself.

 // not namespaced variables
 name = "George"
 db=my_db
 db = my_db

 // namespaced variables
 address.city = "Berlin"
Expand Down

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ Initial Configuration

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
 be set within the **.env** file as ``app.baseURL = 'http://example.com/'``.
 be set within the :ref:`.env <dotenv-file>` file as ``app.baseURL = 'http://example.com/'``.
 (Always use a trailing slash on your base URL!)

 .. note:: If you don't set the ``baseURL`` correctly, in development mode,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
docs: improve dotenv file explanation#7498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

May 16, 2023
 Merged


docs: improve dotenv file explanation
#7498
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2d574c3

docs: add section titles


kenjis May 13, 2023
c9b62d8

docs: fix section level


kenjis May 13, 2023
f647602

docs: add empty line


kenjis May 13, 2023
4a5030d

docs: change important to warning


kenjis May 13, 2023
6c33a3c

docs: add spaces before and after `=`


kenjis May 13, 2023
075fa7d

docs: add link to dotenv file explanation


kenjis May 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 25 additions & 13 deletions
user_guide_src/source/general/configuration.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,19 +65,26 @@ Environment Variables should also be used for anything private such as passwords

.. _dotenv-file:

Environment Variables and CodeIgniter
=====================================
Dotenv File
===========

CodeIgniter makes it simple and painless to set Environment Variables by using a "dotenv" file. The term comes from the file name, which starts with a dot before the text "env".

CodeIgniter expects **.env** to be at the root of your project alongside the
``app`` directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (**.**) at the start?).
Creating Dotenv File
--------------------

CodeIgniter expects the **.env** file to be at the root of your project alongside the
**app** directories. There is a template file distributed with CodeIgniter that's
located at the project root named **env** (Notice there's no dot (``.``) at the start?).

It has a large collection of variables your project might use that have been assigned
empty, dummy, or default values. You can use this file as a starting place for your
application by either renaming the template to **.env**, or by making a copy of it named **.env**.

.. important:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.
.. warning:: Make sure the **.env** file is NOT tracked by your version control system. For *git* that means adding it to **.gitignore**. Failure to do so could result in sensitive credentials being exposed to the public.

Setting Variables
-----------------

Settings are stored in **.env** files as a simple a collection of name/value pairs separated by an equal sign.
::
Expand All@@ -88,27 +95,32 @@ Settings are stored in **.env** files as a simple a collection of name/value pai

When your application runs, **.env** will be loaded automatically, and the variables put
into the environment. If a variable already exists in the environment, it will NOT be
overwritten. The loaded Environment variables are accessed using any of the following:
overwritten.

Getting Variables
-----------------

The loaded environment variables are accessed using any of the following:
``getenv()``, ``$_SERVER``, or ``$_ENV``.

.. literalinclude:: configuration/005.php

.. warning:: Note that your settings from the **.env** file are added to Environment Variables. As a side effect, this means that if your CodeIgniter application is (for example) generating a ``var_dump($_ENV)`` or ``phpinfo()`` (for debugging or other valid reasons) **your secure credentials are publicly exposed**.

Nesting Variables
=================
-----------------

To save on typing, you can reuse variables that you've already specified in the file by wrapping the
variable name within ``${...}``:

::

 BASE_DIR="/var/webroot/project-root"
 CACHE_DIR="${BASE_DIR}/cache"
 TMP_DIR="${BASE_DIR}/tmp"
 BASE_DIR = "/var/webroot/project-root"
 CACHE_DIR = "${BASE_DIR}/cache"
 TMP_DIR = "${BASE_DIR}/tmp"

Namespaced Variables
====================
--------------------

There will be times when you will have several variables with the same name.
The system needs a way of knowing what the correct setting should be.
Expand All@@ -122,7 +134,7 @@ prefix followed by a dot (.), and then the variable name itself.

 // not namespaced variables
 name = "George"
 db=my_db
 db = my_db

 // namespaced variables
 address.city = "Berlin"
Expand Down

2 changes: 1 addition & 1 deletion
user_guide_src/source/installation/running.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ Initial Configuration

#. Open the **app/Config/App.php** file with a text editor and
 set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may
 be set within the **.env** file as ``app.baseURL = 'http://example.com/'``.
 be set within the :ref:`.env <dotenv-file>` file as ``app.baseURL = 'http://example.com/'``.
 (Always use a trailing slash on your base URL!)

 .. note:: If you don't set the ``baseURL`` correctly, in development mode,
Expand Down