ajustement aux derniers changement au SDK
[auf_skeleton_django.git] / README
1 Création d'un nouveau projet
2 ============================
3
4 Après avoir fait l'installation de Django::
5
6   sudo apt-get install python-django
7
8 Vous pouvez créer un projet depuis le template Django de l'AUF::
9
10 FIXME
11
12   django-admin.py startproject --template=auf-skeleton-django <nom_de_nom_projet>
13
14 Ensuite, pour suivre les versions de votre site, vous pouvez utiliser Git
15 et faire votre commit initiale comme ceci::
16
17   git init
18   git add .
19   git commit -m "version initiale"
20
21 Documentation
22 -------------
23
24 Vous devez d'abord installer sphinx-doc::
25
26   sudo apt-get install python-sphinx
27
28 Pour construire la documentation en version HTML::
29
30   cd docs/
31   make html
32
33 Puis pour voir le résutat finale avec Firefox::
34
35   firefox build/index.html
36
37
38 Git
39 ---
40
41 Une branche par site (production, test, etc)
42 Un tags par version majeur ou déploiement (v1.0, jan.2015, etc)
43
44
45 Déploiement en production
46 -------------------------
47
48 Installation du SDK::
49
50   sudo apt-get install auf-django-sdk
51
52
53 Téléchargement du code source::
54
55   git clone ...
56
57 Par la suite, les nouvelles versions seront téléchargeable avec la commande::
58
59   git pull
60
61 Configuration
62 -------------
63
64 MySQL::
65
66     DATABASES = {
67         'default': {
68             'ENGINE': 'django.db.backends.sqlite3',
69             'NAME': 'db.sqlite',
70             'USER': '',
71             'PASSWORD': '',
72             'HOST': '',
73             'PORT': '',
74         }
75     }
76
77
78 SECRET_KEY::
79
80   SECRET_KEY = '...'
81
82 Piwik::
83
84   PIWIK_TOKEN = '...'
85
86 Sentry/Raven::
87
88   RAVEN_CONFIG = {
89       'dsn': '...',
90   }
91
92 Fichier static
93
94 ::
95   chgrp www-data sitestatic media -R
96   chmod g+rw sitestatic media -R
97
98 Apache
99 ------
100
101 Installation du mod-wsgi::
102
103   sudo apt-get install libapache2-mod-wsgi
104   sudo a2enmod wsgi
105
106 Exemple de la configuration d'un site Django::
107
108   <VirtualHost *:80>
109     ServerAdmin webmaster@localhost
110     ServerName mon_site.com
111
112     Alias /media/ /var/www/mon_site/media/
113     Alias /static/ /var/www/mon_site/sitestatic/
114
115     WSGIScriptAlias / /var/www/mon_site/wsgi.py
116
117     ErrorLog /var/log/apache2/mon_site.log
118   </VirtualHost>
119
120
121
122
123 Développement
124 -------------
125
126 Les dépendances qui ne sont pas dans le SDK doivent être mise dans le
127 dossier::
128
129   external_apps/
130
131