Distribuer des projets Django avec des SECRET_KEYs uniques

Question

J'ai un projet Django que j'aimerais distribuer sur un dépôt public comme bitbucket ou github. J'aimerais qu'il soit aussi facile à installer que possible, c'est pourquoi j'inclus le projet complet, et pas seulement les applications enfichables. Cela signifie que le settings.py sera également inclus.

Comment puis-je éviter le problème de settings.SECRET_KEY étant la même pour chaque installation ?

Est le seul simple solution pour que l'utilisateur modifie manuellement settings.py ?

Devrais-je stocker la clé dans la base de données par défaut et avoir settings.py l'initialiser s'il n'existe pas ? Cela résoudrait le problème, mais je me demande s'il existe déjà un moyen standard de le faire.

Gracias.

Answer 1

Pour ajouter à ce que Carles Barrobés dit, vous pouvez générer une nouvelle clé en utilisant la méthode que Django utilise dans startproject :

from django.utils.crypto import get_random_string

chars = 'abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)'
get_random_string(50, chars)

---

Pour Django 1.10 et les versions ultérieures, le bout de code ci-dessus est joliment enveloppé dans une fonction.

from django.core.management.utils import get_random_secret_key
get_random_secret_key()

Lien vers le dépôt GitHub

Answer 2

Je m'y prendrais de cette façon :

Avoir la clé secrète dans un fichier séparé "secret_key.py". Ce fichier n'existe pas pour une installation vierge. Dans votre settings.py incluez quelque chose comme :

try:
    from .secret_key import SECRET_KEY
except ImportError:
    SETTINGS_DIR = os.path.abspath(os.path.dirname(__file__))
    generate_secret_key(os.path.join(SETTINGS_DIR, 'secret_key.py'))
    from .secret_key import SECRET_KEY

La fonction generate_secret_key(filename) que vous allez écrire génère un fichier appelé filename (qui, comme nous l'appelons, sera secret_key.py dans le même répertoire que settings.py ) avec le contenu :

SECRET_KEY = '....random string....'

Où la chaîne aléatoire est la clé générée sur la base d'un nombre aléatoire.

Pour la génération de clés, vous pouvez utiliser la suggestion d'Umang. https://stackoverflow.com/a/16630719/166761 .

Answer 3

D'une manière générale, vous pouvez diviser la configuration de Django en deux catégories : les éléments spécifiques à l'application et les éléments spécifiques au serveur. Ceci tombe dans la dernière catégorie.

Il existe un certain nombre de façons d'aborder le problème de la configuration spécifique du serveur, qui est abordé plus en détail dans la section cette question .

Dans ce cas particulier, en utilisant l'approche que j'ai décrite dans ma réponse à l'autre question, je mettrais un espace réservé dans le fichier settings_local.py.sample pour la distribution, et pendant l'installation, j'ai copié cela sur settings_local.py et modifiez-le à votre guise.

Answer 4

Je résoudrais le problème de la façon suivante :

• Fournir une clé secrète factice comme : I_AM_A_DUMMY_KEY_CHANGE_ME
• Créez une commande de gestion pour en générer une nouvelle : ./manage.py gen_secret_key
• Dans la documentation, il est fortement conseillé aux utilisateurs d'exécuter la commande dès que possible.

Answer 5

Dans mon code, j'ai trois niveaux de fichiers de paramètres inspirés par Two Scoops of Django, donc le niveau intermédiaire est le suivant : BASE_PRIVATE_DIR est configuré dans le modèle de base. Dans mon cas, il s'agit du répertoire django ../../mysite_private mais quelque part à côté des fichiers normaux sous l'application git.. :

from .base import *

ALLOWED_HOSTS = ['staging.django.site'] 
#Allow local override which is per deployment instance.  There should probably then be
#  an instance git for version control of the production data
try:
    import sys
    private_path = BASE_PRIVATE_DIR.child('production')
    sys.path.append(private_path)
    from private_settings import *
except ImportError:
    print(" No production overide private_settings.py found.  This is probably an error  = {}".format(private_path))
    # If it doesnt' exist that is fine and just use system and environment defaults