How to I hide my secret_key using virtualenv and Django?
You can create a file named secret_settings.py
and place your SECRET_KEY
inside this file. Then add this file to .gitignore
.
Then in your settings, you can remove the secret key variable and import it from there. This should ensure that SECRET_KEY
variable remains out of version control.
Create a file named secret_settings
and then place your SECRET_KEY
and other secret settings in it.
SECRET_KEY = .. # add your setting here
Then in your settings.py
file, import these settings.
from secret_settings import *
Finally, add secret_settings.py
to your .gitignore
file.
Note:
If you already have committed some sensitive data to your repo, then change it!
As per Github website in the removing sensitive data article:
If you committed a password, change it! If you committed a key, generate a new one.
Check this link on how to purge a file from your repository's history.
There's a lot of different methods to hide secrets.
Use another, non-versioned file.
Create a new file
secrets.py
or what have you and put your secrets in that. Place it alongside your settings file and place everything secret in there; then in your settings file putfrom secrets import *
at the top. Then, like Rahul said, add a.gitignore
file and addsecrets.py
to this file so that it won't be committed.The disadvantage of this approach is that there is no source control at all on that file; if you lose it you're SOL.
Use environment variables.
Use the Apache
SetEnv
orPassEnv
directives to pass environment variables to your process, then retrieve them withos.environ()
in your settings file. This has the advantage in that in development, you can set new variables (as simply asVAR1=whatever VAR2=whatever ... ./manage.py runserver ...
) or set them from whatever mechanism you use to launch your development project.The disadvantage is much the same; if you lose your Apache configs you're boned.
Use a second repository in combination with method 1.
Personally, I like the idea of having a dedicated
secrets
repository that you put all your secrets into and keep that repo under lock and key. Then as part of your deployment process, you can usegit archive
or another similar command to extract the proper keys for the place you're deploying to, and you can keep your secrets backed up and under version control easily. You can also add the appropriate files in thesecrets
repo to the.gitingore
file of your site repository so that they don't accidentally get committed.The downside of this is that you have another extra repository and another deployment step. I think that's worth it, personally, but it's really up to you.
In general, the more secure you want it, the more inconvenient it's going to be to access those secrets. That's really a rule in general, though.