Skip to content

Commit 3dc07e9

Browse files
committed
Fix typos
1 parent 526e6ec commit 3dc07e9

File tree

2 files changed

+40
-40
lines changed

2 files changed

+40
-40
lines changed

best_practices/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ To override these variables with machine-specific or sensitive values, create a
4646

4747
.. seealso::
4848

49-
You can also encrypt sensitive informations like passwords, tokens, api key,
49+
You can also encrypt sensitive information like passwords, tokens, API key,
5050
secrets, etc... See :doc:`/configuration/secrets`.
5151

5252
.. caution::

configuration/secrets.rst

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
.. index::
22
single: Secrets
33

4-
How to Keep Sensitive Informations Secret
5-
=========================================
4+
How to Keep Sensitive Information Secret
5+
========================================
66

77
In :doc:`/configuration` and :doc:`/configuration/environment_variables`, you
88
learned how to manage your application configuration. In this article you'll
9-
learn how to easily anbd saftly configure your application with sensitive
10-
information such as credentials, passwords, tokens, api keys without exposing
9+
learn how to easily and saftely configure your application with sensitive
10+
information such as credentials, passwords, tokens, API keys without exposing
1111
them.
1212

1313
.. _secrets-configuration:
@@ -16,8 +16,8 @@ Configuration
1616
-------------
1717

1818
In order to use secrets you have to enable the feature in the framework's
19-
2019
configuration:
20+
2121
.. configuration-block::
2222

2323
.. code-block:: yaml
@@ -52,29 +52,29 @@ configuration:
5252
5353
.. tip::
5454

55-
the ``encryption_key`` configuration parameter accept both a path to an
56-
encription key or the content of the itself. It allows you, for instance,
57-
to store the content of the key in an environement variable and refer it
58-
with ``%env(PRIVATE_KEY)%``.
55+
The ``encryption_key`` configuration parameter accept both a path to an
56+
**encryption key** or the content of the key itself. It allows you, for
57+
instance, to store the content of the key in an environment variable and
58+
refer it with ``%env(PRIVATE_KEY)%``.
5959

6060
.. _secrets-generate-key:
6161

6262
Generate an Encryption Key
6363
--------------------------
6464

65-
Before creating a new ``secret``, you need to create ann ``encryption key``.
66-
This can be done with the provided commande ``secrets:generate-key``.
65+
Before creating a new **secret**, you need to create an **encryption key**.
66+
This can be done with the provided command ``secrets:generate-key``.
6767

6868
.. code-block:: terminal
6969
7070
$ APP_ENV=prod php bin/console secrets:generate-key
7171
72-
This command will generate a new ``encryption key`` in.
72+
This command generates a new **encryption key** in
7373
``%kernel.project_dir%/config/secrets/encryption_%kernel.environment%.key``
7474

7575
.. note::
7676

77-
In order to use Symfony's built-in Secret storage, you will need the
77+
In order to use Symfony's built-in secret storage, you will need the
7878
`libsodium`_ PHP extension or use the `sodium_compat`_ package.
7979

8080
Symfony generates a key with a symetrics algorithm, meaning that this key could
@@ -83,41 +83,41 @@ possess this key should be as small as possible.
8383

8484
.. caution::
8585

86-
This file is sensitive and **must not** be commited nor publicly shared. Every
87-
developpers and CI don't need that key. If the encryption key have been
88-
exposed (ex-employee leaving for instance)you should consider regenerating a
89-
new one.
86+
This file is sensitive and **must not** be commited nor publicly shared.
87+
Every developpers and CI don't need that key. If the **encryption key**
88+
have been exposed (ex-employee leaving for instance), you should
89+
consider regenerating a new one.
9090

9191
.. _secrets-add:
9292

9393
Create a Secret
9494
---------------
9595

96-
Once the ``encryption key`` generated, you can add new secret with the command
97-
``secrets:add``. Symfony'll ask you to enter the text to encrypt and generate
98-
a new file contains the ciphered text in a file stored by default in the folder
99-
%kernel.project_dir%/config/secrets/%kernel.environment%/. This file should be
100-
commited allongside the other project's files.
96+
Once the **encryption key** generated, you can add new secret with the command
97+
``secrets:add``. Symfony will ask you to enter the text to encrypt and generate
98+
a new file containing the ciphered text in a file stored by default in the
99+
folder ``%kernel.project_dir%/config/secrets/%kernel.environment%/``. This file
100+
should be commited along side the other project's files.
101101

102102
.. code-block:: terminal
103103
104104
$ APP_ENV=prod php bin/console secrets:add DATABASE_PASSWORD
105105
106106
.. tip::
107107

108-
If the ``encryption key`` is compromized, you can regenerate a new key with
109-
the command ``secrets:generate-key``. Symfony will decrypt the previous
110-
secret with the old key, adn re-encrypt theme with the new one.
108+
If the **encryption key** is compromized, you can regenerate a new key with
109+
the command ``secrets:generate-key``. Symfony will decrypt previous secrets
110+
with the old key, and re-encrypt them with the new one.
111111

112112
.. _secrets-reference:
113113

114114
Referencing Secrets in Configuration Files
115115
------------------------------------------
116116

117-
You can reference those secrets in any configuration option enclosing their
118-
names using the ``secret`` :ref:`environment variable processors <env-var-processors>`.
117+
You can reference the secrets in any configuration option enclosing their names
118+
using the **secret** :ref:`environment variable processors <env-var-processors>`.
119119
Their actual values will be resolved at runtime (once per request), so that
120-
container compilation and cache warmup don't need the ``encryption key``.
120+
container compilation and cache warmup don't need the **encryption key**.
121121

122122
.. configuration-block::
123123

@@ -159,10 +159,10 @@ container compilation and cache warmup don't need the ``encryption key``.
159159
]
160160
]);
161161
162-
This bellow configuration requires that every environment use secrets. each
163-
environment would have it own ``encryption key`` and encŷpted secrets.
162+
This configuration requires that all environments uses secrets. Each
163+
environment would have its own **encryption key** and encrypted secrets.
164164

165-
You can also use parameters to configure diffrent strategy per environnement:
165+
You can also use parameters to configure different strategies per environnement:
166166
By defining a default plaintext secret:
167167

168168
.. configuration-block::
@@ -213,7 +213,7 @@ By defining a default plaintext secret:
213213
]);
214214
$container->setParameter('database_password', 'not a secret');
215215
216-
Then overriding it in production environement:
216+
Then overriding it in production environment:
217217

218218
.. configuration-block::
219219

@@ -251,9 +251,9 @@ Then overriding it in production environement:
251251
List existing secrets
252252
---------------------
253253

254-
Every body is allowed to list the secret's name with the command ``secrets:list``.
255-
If you have the ``encryption key`` you can also reveal the plain text value by
256-
passing the optoin ``--reveal`` to the command
254+
Everybody is allowed to list the secret's name with the command ``secrets:list``.
255+
If you have the **encryption key** you can also reveal the plain text value by
256+
passing the option ``--reveal`` to the command
257257

258258
.. code-block:: terminal
259259
@@ -267,11 +267,11 @@ passing the optoin ``--reveal`` to the command
267267
268268
.. _secrets-deploy
269269
270-
Deploy secret to production
271-
---------------------------
270+
Deploy secrets to production
271+
----------------------------
272272

273-
As the ``encryption key`` is not commited, during development, you'll have to
274-
manualy deploy the key (once for a will) at the path referenced in the
273+
As the **encryption key** is not commited, during development, you'll have to
274+
manualy deploy the key (once and for all) at the path referenced in the
275275
``encryption_key`` configuration key. Default is ``%kernel.project_dir%/config/secrets/%kernel.environment%``.
276276

277277
.. _secrets-custom-storage

0 commit comments

Comments
 (0)