Skip to content

Commit 058e3b8

Browse files
committed
Add readme stuff about CLI and setting key at runtime
1 parent f7c30bc commit 058e3b8

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**django-sqlcipher**
1+
# django-sqlcipher
22

33
SQLCipher is an SQLite extension that provides transparent 256-bit AES encryption of database files.
44

@@ -8,33 +8,40 @@ This app does it for you. You only need to specify the database key in your proj
88

99
For more about SQLCipher take a look at [http://sqlcipher.net/](http://sqlcipher.net/).
1010

11-
**Requirements**
11+
## Requirements
1212

1313
* python-sqlcipher (Python compiled with SQLCipher support)
1414

1515
For more about python-sqlcipher take a look at:
1616

1717
[https://code.launchpad.net/~jplacerda/+junk/python-sqlcipher](https://code.launchpad.net/~jplacerda/+junk/python-sqlcipher)
1818

19-
**Installation**
19+
## Installation
2020

2121
`pip install git+http://github.com/codasus/django-sqlcipher#egg=sqlcipher`
2222

2323
Or manually place it on your `PYTHON_PATH`.
2424

25-
**Configuration**
25+
## Configuration
2626

2727
Open your project's `settings.py` file and:
2828

2929
1. Append `sqlcipher` to your `INSTALLED_APPS`.
3030

3131
2. Set your database engine to `sqlcipher.backend`.
3232

33-
3. Put the following line where you want:
33+
3. Optionally, type your key into your settings file (**unsafe**):
3434

3535
`PRAGMA_KEY = "YOUR DATABASE KEY"`
3636

37-
**MIT License**
37+
You may not wish to expose your encryption key in a file.
38+
django-sqlcipher ships with custom management commands that will prompt
39+
for the key when invoking `runserver` and `migrate`, however you
40+
should consider how you want to set `django.conf.settings.PRAGMA_KEY`
41+
at runtime in your production environment.
42+
43+
44+
## MIT License
3845

3946
<pre>Copyright (c) 2011 Caio Ariede and Codasus Technologies.
4047

0 commit comments

Comments
 (0)