Skip to content

Commit e460bb4

Browse files
committed
feat: add configuration info
1 parent a65556d commit e460bb4

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ All you have to do is change the file fields and you've got encrypted files
8888
pass
8989
9090
91+
.. code:: python
92+
9193
# my_app/urls.py
9294
9395
from django_encrypted_filefield.constants import FETCH_URL_NAME
@@ -104,7 +106,21 @@ All you have to do is change the file fields and you've got encrypted files
104106
]
105107
106108
107-
How do I Run the Tests?
109+
How Do I Configure It?
110+
----------------------
111+
112+
Configuration of the package requires setting three values in either the
113+
environment (recommended) or in your ``settings.py``. These values are:
114+
115+
* ``DEFF_SALT``: The salt value use for generating the synchronous encryption
116+
* ``DEFF_PASSWORD``: The password value for the same thing
117+
* ``DEFF_FETCH_URL_NAME``: The named URL you intend to use to download the
118+
files as they're decrypted on-the-fly.
119+
120+
Outside of that, follow the above and you should be good to go.
121+
122+
123+
How Do I Run the Tests?
108124
-----------------------
109125

110126
As this project depends on the setting of three environment variables, you have
@@ -156,4 +172,3 @@ What's the Status of the Project?
156172
Stable. I'm actively using it in a production environment now and have been
157173
for some time without issue. This isn't a guarantee that it'll work for
158174
everyone in every case of course, but it's enough for me to use that word :-)
159-

0 commit comments

Comments
 (0)