WikiBR - Contributions [fr]

Tuto pour le déploiement des sites Django

2018-04-05T07:36:50Z

Wilson.jallet : /* Avec Git (recommzndé) */

== Connexion ==

Assurez vous tout d'abord d'être administrateur de votre binet. Il faut attendre au moins une heure pour que les modifications soient prises en compte.

Ensuite vous ouvrez votre terminal et vous vous connectez sur le serveur avec la commande ssh.
ssh prenom.nom@129.104.201.52

Une fois que vous avez tapé votre mot de passe frankiz, vous arrivez sur le serveur dans un dossier à votre nom. Il y a un fichier {{c|README.txt}} qui devrait donner un certain nombre d'informations sur le fonctionnement de kevarzh ou encore sur certaines modifs à faire sur le code de votre site. Vous pouvez vous diriger sur le serveur par les commandes habituelles. Votre dossier personnel se trouve dans {{c|/hosting/user/prenom.nom}}.

Si jamais vous voulez lancer une commande ayant besoin d'internet (par exemple des commandes git) n'oubliez pas de mettre {{c|proxychains}} devant votre commande.

== Copie des fichiers ==

=== En FTP ===

Le dossier {{c|/hosting/www/nom_binet}} contient (au moins) un dossier par site. Si vous n'avez qu'un site, le dossier par défaut est {{c|htdocs}}. C'est dans un de ces dossiers que vous allez devoir copier le code de votre site.
scp -r /code_site prenom.nom@129.104.201.52:/hosting/wwww/nom_binet/version_site

=== Avec Git (recommandé) ===

'''Prérequis: ''Vous devez avoir une clef SSH activée sur votre compte sur Ostizan'''''

Naviguez au dossier où vous voulez mettre votre site, par exemple {{c|htdocs}} :
cd /hosting/www/nom_binet/htdocs
et initialisez un dépôt Git
git init

Si cela a fonctionné, le terminal répondra
Initialized empty Git repository in /hosting/www/nom_binet/htdocs/.git

Ajoutez maintenant une ''remote'' qui pointera vers là où vous hébergez votre code, par exemple
git remote add origin git@gitlab.binets.fr:domaine/site.git
pour un site dont le code est hébergé sur [//gitlab.binets.fr le GitLab], ou
git remote add origin git@github.com:domaine/site.git
pour un site dont le code est sur [//github.com GitHub].

== Quotas ==

Attention ! L'espace réservé à chaque binet est limité. Il faut se méfier quand on fait une copie, notamment a l'environnement virtuel. D'abord il pèse lourd, en plus il faudra que vous le remplaciez de toute façon. Autant ne pas le copier dès le départ...
Pour savoir si vous avez dépassé votre quota :
quota -sg
Cette commande affiche, pour chaque binet, l'espace utilisé, une «soft limit» et la vraie («hard») limit.

== Environnement virtuel ==

Une fois que le code du site est en place, il créer un environnement virtuel, c'est-à-dire une copie locale de l'interpréteur Python correspondant à la version que vous utilisez pour votre site :
virtualenv -p /usr/bin/python3.6 venv
Il est important que vous nommiez le dossier {{c|venv}}.

À partir de là, '''toutes''' les commandes utilisant python doivent être exécutées dans le virtualenv. Pour rentrer dans le virtualenv, vous devez lancer :
source venv/bin/activate

Si cela a fonctionné, vous aurez {{c|(venv)}} en préfixe dans votre terminal :
(venv) prenom.nom@ostizan:/hosting/www/site_binet/htdocs

Une fois dans le venv, vous pouvez installer les dépendances nécessaires :
pip install -r requirements.txt

== Adaptations ==
Certaines adaptations sont nécessaires pour faire fonctionner le site. La documentation officielle de Django fournit une bonne [https://docs.djangoproject.com/fr/1.10/howto/deployment/checklist/ checklist]. Là, pas besoin de se casser la tête il suffit de suivre la liste, des liens sont là pour expliquer en détails ce que l'on fait à chaque fois. Les points essentiels à ne surtout pas sauter sont :
* Mettre {{c|DEBUG}} à {{False}}
* {{c|SECRET_KEY}}:
Si vous utilisez un repo git, il ne faut pas mettre cette clef dans le code.
Un snippet possible est le suivant:
keyfile = os.path.join(BASE_DIR, "secret.key")
if not os.path.exists(keyfile):
with open(keyfile, "wb") as f:
f.write(base64.b64_encode(os.urandom(30)))
with open(keyfile, "r") as f:
SECRET_KEY = f.read().strip()

La clef est contenue dans le fichier {{c|secret.key}} (généré automatiquement s'il n'existe pas) qu'il suffit de mettre dans le {{c|.gitignore}}.

* Mettre {{c|ALLOWED_HOST}} à {{c|["*"]}}, le filtrage a lieu avant Django
* STATIC_ROOT, STATIC_URL, MEDIA_ROOT et MEDIA_URL:
STATIC_URL = '/assets/static/'
STATIC_ROOT = os.path.join(BASE_DIR, "assets/static/")
MEDIA_ROOT = os.path.join(BASE_DIR, "assets/media/")
MEDIA_URL = '/assets/media/'

* emails (indispensable pour être averti des erreurs 500)
DEFAULT_FROM_EMAIL = "nom_du_binet@binets.polytechnique.fr"
# voir https://portail.polytechnique.edu/dsi/eleves/mail-binets
SERVER_EMAIL = DEFAULT_FROM_EMAIL
ADMINS = [("Webmaster", DEFAULT_FROM_EMAIL)]

* base de donnée : n'utilisez pas sqlite ! Nous avons eu des problèmes par le passé, et les bases de données sql sont sauvegardées toutes les semaines.
Un snippet utilisable est :
if DEBUG:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
else:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'OPTIONS': {
'read_default_file': os.path.join(BASE_DIR, 'my.cnf'),
},
}
}

Placer les mots de passe dans le fichier {{c|my.cnf}}:
[client]
database = NAME
user = USER
password = PASSWORD
default-character-set = utf8

Bien sûr il faut ajouter ce fichier dans le gitignore.

== Mise en place de l'authentification par CAS sous Django ==

* Demander sur [https://panix.binets.fr Panix] à utiliser cette authentification. Préciser les éventuels attributs supplémentaires nécessaires (promo, section, ...).
* Installer le paquet django-cas-ng :
pip install django-cas-ng
* Ajouter ce paquet à la liste des applications :
INSTALLED_APPS = [
...
'django_cas_ng',
...
]
* Configurer la connection au serveur CAS du BR :
AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend',
'django_cas_ng.backends.CASBackend',
)
CAS_SERVER_URL = "https://cas.binets.fr/"
* Renseigner les pages de connexion (dans {{c|my_project/urls.py}} par exemple):
from django_cas_ng.views import login, logout

urlpatterns = [
...
url(r'^login$', login, name='cas_ng_login'),
url(r'^logout$', logout, name='cas_ng_logout'),
...
]
* Ajouter l'URL d'entrée :
LOGIN_URL = "login"

* Attention à forcer l'authentification pour les pages concernées :
from django.contrib.auth.decorators import login_required

@login_required
def my_awesome_view(request):
...

À noter :
* le nom de l'utilisateur connecté se trouve dans : request.user.username (accessible dans n'importe quelle vue).
* les attributs du [[LDAP]] peuvent être disponibles (demander les attributs nécessaires lors de la mise en place du CAS). Ils sont alors disponibles dans request.session['attributes'] .
* plus d'option de configuration sont présentés [https://github.com/mingchen/django-cas-ng/tree/master/django_cas_ng ici]

== À chaque modification... ==

* du code python quel qu'il soit :
touch /var/run/please/restart
* du schéma SQL (sous Django):
python manage.py migrate
* des fichiers statiques (sous Django):
python manage.py collectstatic
Il faut attendre 1 ou deux minutes que le système enregistre la modification, quand c'est fait il affiche un message dans le terminal.

== Tester ==
=== Erreurs python ===
La commande
python manage.py runserver
permet de vérifier qu'il n'y a pas d'{{c|ImportError}} ou autres. Pensez à le faire dans le virtualenv.
=== Erreurs web ===
Pour checker les changements il suffit de taper l'url du site pour constater en direct les changements. Si jamais il y a un souci il y a deux emplacements pour les logs : {{c|/var/log/uwsgi/nom_binet}} ou {{c|/hosting/log/nom_binet}}.
=== Troubleshooting ===
* Toutes les pages affichent {{c|Internal Server Error}} pas en gras : c'est une erreur de {{c|uwsgi}} qui n'arrive pas à :
** trouver ton site
** trouver le virtualenv
** une exception est levée au démarrage du serveur ({{c|ImportError}} notamment).

Tu peux lire les logs dans {{c|/var/log/uwsgi/<ton binet>/<ton site>.log}} et vérifier où {{c|uwsgi}} va chercher ton site dans {{c|/etc/uwsgi.d/<ton site>.json}}. S'il faut modifier ce dernier fichier, demande-le au BR, tu ne peux pas le faire toi même.
* Toutes les pages affichent {{c|Internal Server Error(500)}} en gras : c'est django. Actives les mails pour avoir des détails, mais tu as probablement oublié de lancer les migrations sur une base sql vide.

Tuto pour le déploiement des sites Django

2018-04-05T07:29:01Z

Wilson.jallet : /* Avec Git (recommndé) */

== Connexion ==

Assurez vous tout d'abord d'être administrateur de votre binet. Il faut attendre au moins une heure pour que les modifications soient prises en compte.

Ensuite vous ouvrez votre terminal et vous vous connectez sur le serveur avec la commande ssh.
ssh prenom.nom@129.104.201.52

Une fois que vous avez tapé votre mot de passe frankiz, vous arrivez sur le serveur dans un dossier à votre nom. Il y a un fichier {{c|README.txt}} qui devrait donner un certain nombre d'informations sur le fonctionnement de kevarzh ou encore sur certaines modifs à faire sur le code de votre site. Vous pouvez vous diriger sur le serveur par les commandes habituelles. Votre dossier personnel se trouve dans {{c|/hosting/user/prenom.nom}}.

Si jamais vous voulez lancer une commande ayant besoin d'internet (par exemple des commandes git) n'oubliez pas de mettre {{c|proxychains}} devant votre commande.

== Copie des fichiers ==

=== En FTP ===

Le dossier {{c|/hosting/www/nom_binet}} contient (au moins) un dossier par site. Si vous n'avez qu'un site, le dossier par défaut est {{c|htdocs}}. C'est dans un de ces dossiers que vous allez devoir copier le code de votre site.
scp -r /code_site prenom.nom@129.104.201.52:/hosting/wwww/nom_binet/version_site

=== Avec Git (recommzndé) ===

'''Prérequis: ''Vous devez avoir une clef SSH activée sur votre compte sur Ostizan'''''

Naviguez au dossier où vous voulez mettre votre site, par exemple {{c|htdocs}} :
cd /hosting/www/nom_binet/htdocs
et initialisez un dépôt Git
git init

Si cela a fonctionné, le terminal répondra
Initialized empty Git repository in /hosting/www/nom_binet/htdocs/.git

Ajoutez maintenant une ''remote'' qui pointera vers là où vous hébergez votre code, par exemple
git remote add origin git@gitlab.binets.fr:domaine/site.git
pour un site dont le code est hébergé sur [//gitlab.binets.fr le GitLab], ou
git remote add origin git@github.com:domaine/site.git
pour un site dont le code est sur [//github.com GitHub].

== Quotas ==

Attention ! L'espace réservé à chaque binet est limité. Il faut se méfier quand on fait une copie, notamment a l'environnement virtuel. D'abord il pèse lourd, en plus il faudra que vous le remplaciez de toute façon. Autant ne pas le copier dès le départ...
Pour savoir si vous avez dépassé votre quota :
quota -sg
Cette commande affiche, pour chaque binet, l'espace utilisé, une «soft limit» et la vraie («hard») limit.

== Environnement virtuel ==

Une fois que le code du site est en place, il créer un environnement virtuel, c'est-à-dire une copie locale de l'interpréteur Python correspondant à la version que vous utilisez pour votre site :
virtualenv -p /usr/bin/python3.6 venv
Il est important que vous nommiez le dossier {{c|venv}}.

À partir de là, '''toutes''' les commandes utilisant python doivent être exécutées dans le virtualenv. Pour rentrer dans le virtualenv, vous devez lancer :
source venv/bin/activate

Si cela a fonctionné, vous aurez {{c|(venv)}} en préfixe dans votre terminal :
(venv) prenom.nom@ostizan:/hosting/www/site_binet/htdocs

Une fois dans le venv, vous pouvez installer les dépendances nécessaires :
pip install -r requirements.txt

== Adaptations ==
Certaines adaptations sont nécessaires pour faire fonctionner le site. La documentation officielle de Django fournit une bonne [https://docs.djangoproject.com/fr/1.10/howto/deployment/checklist/ checklist]. Là, pas besoin de se casser la tête il suffit de suivre la liste, des liens sont là pour expliquer en détails ce que l'on fait à chaque fois. Les points essentiels à ne surtout pas sauter sont :
* Mettre {{c|DEBUG}} à {{False}}
* {{c|SECRET_KEY}}:
Si vous utilisez un repo git, il ne faut pas mettre cette clef dans le code.
Un snippet possible est le suivant:
keyfile = os.path.join(BASE_DIR, "secret.key")
if not os.path.exists(keyfile):
with open(keyfile, "wb") as f:
f.write(base64.b64_encode(os.urandom(30)))
with open(keyfile, "r") as f:
SECRET_KEY = f.read().strip()

La clef est contenue dans le fichier {{c|secret.key}} (généré automatiquement s'il n'existe pas) qu'il suffit de mettre dans le {{c|.gitignore}}.

* Mettre {{c|ALLOWED_HOST}} à {{c|["*"]}}, le filtrage a lieu avant Django
* STATIC_ROOT, STATIC_URL, MEDIA_ROOT et MEDIA_URL:
STATIC_URL = '/assets/static/'
STATIC_ROOT = os.path.join(BASE_DIR, "assets/static/")
MEDIA_ROOT = os.path.join(BASE_DIR, "assets/media/")
MEDIA_URL = '/assets/media/'

* emails (indispensable pour être averti des erreurs 500)
DEFAULT_FROM_EMAIL = "nom_du_binet@binets.polytechnique.fr"
# voir https://portail.polytechnique.edu/dsi/eleves/mail-binets
SERVER_EMAIL = DEFAULT_FROM_EMAIL
ADMINS = [("Webmaster", DEFAULT_FROM_EMAIL)]

* base de donnée : n'utilisez pas sqlite ! Nous avons eu des problèmes par le passé, et les bases de données sql sont sauvegardées toutes les semaines.
Un snippet utilisable est :
if DEBUG:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
else:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'OPTIONS': {
'read_default_file': os.path.join(BASE_DIR, 'my.cnf'),
},
}
}

Placer les mots de passe dans le fichier {{c|my.cnf}}:
[client]
database = NAME
user = USER
password = PASSWORD
default-character-set = utf8

Bien sûr il faut ajouter ce fichier dans le gitignore.

== Mise en place de l'authentification par CAS sous Django ==

* Demander sur [https://panix.binets.fr Panix] à utiliser cette authentification. Préciser les éventuels attributs supplémentaires nécessaires (promo, section, ...).
* Installer le paquet django-cas-ng :
pip install django-cas-ng
* Ajouter ce paquet à la liste des applications :
INSTALLED_APPS = [
...
'django_cas_ng',
...
]
* Configurer la connection au serveur CAS du BR :
AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend',
'django_cas_ng.backends.CASBackend',
)
CAS_SERVER_URL = "https://cas.binets.fr/"
* Renseigner les pages de connexion (dans {{c|my_project/urls.py}} par exemple):
from django_cas_ng.views import login, logout

urlpatterns = [
...
url(r'^login$', login, name='cas_ng_login'),
url(r'^logout$', logout, name='cas_ng_logout'),
...
]
* Ajouter l'URL d'entrée :
LOGIN_URL = "login"

* Attention à forcer l'authentification pour les pages concernées :
from django.contrib.auth.decorators import login_required

@login_required
def my_awesome_view(request):
...

À noter :
* le nom de l'utilisateur connecté se trouve dans : request.user.username (accessible dans n'importe quelle vue).
* les attributs du [[LDAP]] peuvent être disponibles (demander les attributs nécessaires lors de la mise en place du CAS). Ils sont alors disponibles dans request.session['attributes'] .
* plus d'option de configuration sont présentés [https://github.com/mingchen/django-cas-ng/tree/master/django_cas_ng ici]

== À chaque modification... ==

* du code python quel qu'il soit :
touch /var/run/please/restart
* du schéma SQL (sous Django):
python manage.py migrate
* des fichiers statiques (sous Django):
python manage.py collectstatic
Il faut attendre 1 ou deux minutes que le système enregistre la modification, quand c'est fait il affiche un message dans le terminal.

== Tester ==
=== Erreurs python ===
La commande
python manage.py runserver
permet de vérifier qu'il n'y a pas d'{{c|ImportError}} ou autres. Pensez à le faire dans le virtualenv.
=== Erreurs web ===
Pour checker les changements il suffit de taper l'url du site pour constater en direct les changements. Si jamais il y a un souci il y a deux emplacements pour les logs : {{c|/var/log/uwsgi/nom_binet}} ou {{c|/hosting/log/nom_binet}}.
=== Troubleshooting ===
* Toutes les pages affichent {{c|Internal Server Error}} pas en gras : c'est une erreur de {{c|uwsgi}} qui n'arrive pas à :
** trouver ton site
** trouver le virtualenv
** une exception est levée au démarrage du serveur ({{c|ImportError}} notamment).

Tu peux lire les logs dans {{c|/var/log/uwsgi/<ton binet>/<ton site>.log}} et vérifier où {{c|uwsgi}} va chercher ton site dans {{c|/etc/uwsgi.d/<ton site>.json}}. S'il faut modifier ce dernier fichier, demande-le au BR, tu ne peux pas le faire toi même.
* Toutes les pages affichent {{c|Internal Server Error(500)}} en gras : c'est django. Actives les mails pour avoir des détails, mais tu as probablement oublié de lancer les migrations sur une base sql vide.

Tuto pour le déploiement des sites Django

2018-04-05T07:28:48Z

Wilson.jallet : /* Copie des fichiers */

== Connexion ==

Assurez vous tout d'abord d'être administrateur de votre binet. Il faut attendre au moins une heure pour que les modifications soient prises en compte.

Ensuite vous ouvrez votre terminal et vous vous connectez sur le serveur avec la commande ssh.
ssh prenom.nom@129.104.201.52

Une fois que vous avez tapé votre mot de passe frankiz, vous arrivez sur le serveur dans un dossier à votre nom. Il y a un fichier {{c|README.txt}} qui devrait donner un certain nombre d'informations sur le fonctionnement de kevarzh ou encore sur certaines modifs à faire sur le code de votre site. Vous pouvez vous diriger sur le serveur par les commandes habituelles. Votre dossier personnel se trouve dans {{c|/hosting/user/prenom.nom}}.

Si jamais vous voulez lancer une commande ayant besoin d'internet (par exemple des commandes git) n'oubliez pas de mettre {{c|proxychains}} devant votre commande.

== Copie des fichiers ==

=== En FTP ===

Le dossier {{c|/hosting/www/nom_binet}} contient (au moins) un dossier par site. Si vous n'avez qu'un site, le dossier par défaut est {{c|htdocs}}. C'est dans un de ces dossiers que vous allez devoir copier le code de votre site.
scp -r /code_site prenom.nom@129.104.201.52:/hosting/wwww/nom_binet/version_site

=== Avec Git (recommndé) ===

'''Prérequis: ''Vous devez avoir une clef SSH activée sur votre compte sur Ostizan''''''

Naviguez au dossier où vous voulez mettre votre site, par exemple {{c|htdocs}} :
cd /hosting/www/nom_binet/htdocs
et initialisez un dépôt Git
git init

Si cela a fonctionné, le terminal répondra
Initialized empty Git repository in /hosting/www/nom_binet/htdocs/.git

Ajoutez maintenant une ''remote'' qui pointera vers là où vous hébergez votre code, par exemple
git remote add origin git@gitlab.binets.fr:domaine/site.git
pour un site dont le code est hébergé sur [//gitlab.binets.fr le GitLab], ou
git remote add origin git@github.com:domaine/site.git
pour un site dont le code est sur [//github.com GitHub].

== Quotas ==

Attention ! L'espace réservé à chaque binet est limité. Il faut se méfier quand on fait une copie, notamment a l'environnement virtuel. D'abord il pèse lourd, en plus il faudra que vous le remplaciez de toute façon. Autant ne pas le copier dès le départ...
Pour savoir si vous avez dépassé votre quota :
quota -sg
Cette commande affiche, pour chaque binet, l'espace utilisé, une «soft limit» et la vraie («hard») limit.

== Environnement virtuel ==

Une fois que le code du site est en place, il créer un environnement virtuel, c'est-à-dire une copie locale de l'interpréteur Python correspondant à la version que vous utilisez pour votre site :
virtualenv -p /usr/bin/python3.6 venv
Il est important que vous nommiez le dossier {{c|venv}}.

À partir de là, '''toutes''' les commandes utilisant python doivent être exécutées dans le virtualenv. Pour rentrer dans le virtualenv, vous devez lancer :
source venv/bin/activate

Si cela a fonctionné, vous aurez {{c|(venv)}} en préfixe dans votre terminal :
(venv) prenom.nom@ostizan:/hosting/www/site_binet/htdocs

Une fois dans le venv, vous pouvez installer les dépendances nécessaires :
pip install -r requirements.txt

== Adaptations ==
Certaines adaptations sont nécessaires pour faire fonctionner le site. La documentation officielle de Django fournit une bonne [https://docs.djangoproject.com/fr/1.10/howto/deployment/checklist/ checklist]. Là, pas besoin de se casser la tête il suffit de suivre la liste, des liens sont là pour expliquer en détails ce que l'on fait à chaque fois. Les points essentiels à ne surtout pas sauter sont :
* Mettre {{c|DEBUG}} à {{False}}
* {{c|SECRET_KEY}}:
Si vous utilisez un repo git, il ne faut pas mettre cette clef dans le code.
Un snippet possible est le suivant:
keyfile = os.path.join(BASE_DIR, "secret.key")
if not os.path.exists(keyfile):
with open(keyfile, "wb") as f:
f.write(base64.b64_encode(os.urandom(30)))
with open(keyfile, "r") as f:
SECRET_KEY = f.read().strip()

La clef est contenue dans le fichier {{c|secret.key}} (généré automatiquement s'il n'existe pas) qu'il suffit de mettre dans le {{c|.gitignore}}.

* Mettre {{c|ALLOWED_HOST}} à {{c|["*"]}}, le filtrage a lieu avant Django
* STATIC_ROOT, STATIC_URL, MEDIA_ROOT et MEDIA_URL:
STATIC_URL = '/assets/static/'
STATIC_ROOT = os.path.join(BASE_DIR, "assets/static/")
MEDIA_ROOT = os.path.join(BASE_DIR, "assets/media/")
MEDIA_URL = '/assets/media/'

* emails (indispensable pour être averti des erreurs 500)
DEFAULT_FROM_EMAIL = "nom_du_binet@binets.polytechnique.fr"
# voir https://portail.polytechnique.edu/dsi/eleves/mail-binets
SERVER_EMAIL = DEFAULT_FROM_EMAIL
ADMINS = [("Webmaster", DEFAULT_FROM_EMAIL)]

* base de donnée : n'utilisez pas sqlite ! Nous avons eu des problèmes par le passé, et les bases de données sql sont sauvegardées toutes les semaines.
Un snippet utilisable est :
if DEBUG:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
else:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'OPTIONS': {
'read_default_file': os.path.join(BASE_DIR, 'my.cnf'),
},
}
}

Placer les mots de passe dans le fichier {{c|my.cnf}}:
[client]
database = NAME
user = USER
password = PASSWORD
default-character-set = utf8

Bien sûr il faut ajouter ce fichier dans le gitignore.

== Mise en place de l'authentification par CAS sous Django ==

* Demander sur [https://panix.binets.fr Panix] à utiliser cette authentification. Préciser les éventuels attributs supplémentaires nécessaires (promo, section, ...).
* Installer le paquet django-cas-ng :
pip install django-cas-ng
* Ajouter ce paquet à la liste des applications :
INSTALLED_APPS = [
...
'django_cas_ng',
...
]
* Configurer la connection au serveur CAS du BR :
AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend',
'django_cas_ng.backends.CASBackend',
)
CAS_SERVER_URL = "https://cas.binets.fr/"
* Renseigner les pages de connexion (dans {{c|my_project/urls.py}} par exemple):
from django_cas_ng.views import login, logout

urlpatterns = [
...
url(r'^login$', login, name='cas_ng_login'),
url(r'^logout$', logout, name='cas_ng_logout'),
...
]
* Ajouter l'URL d'entrée :
LOGIN_URL = "login"

* Attention à forcer l'authentification pour les pages concernées :
from django.contrib.auth.decorators import login_required

@login_required
def my_awesome_view(request):
...

À noter :
* le nom de l'utilisateur connecté se trouve dans : request.user.username (accessible dans n'importe quelle vue).
* les attributs du [[LDAP]] peuvent être disponibles (demander les attributs nécessaires lors de la mise en place du CAS). Ils sont alors disponibles dans request.session['attributes'] .
* plus d'option de configuration sont présentés [https://github.com/mingchen/django-cas-ng/tree/master/django_cas_ng ici]

== À chaque modification... ==

* du code python quel qu'il soit :
touch /var/run/please/restart
* du schéma SQL (sous Django):
python manage.py migrate
* des fichiers statiques (sous Django):
python manage.py collectstatic
Il faut attendre 1 ou deux minutes que le système enregistre la modification, quand c'est fait il affiche un message dans le terminal.

== Tester ==
=== Erreurs python ===
La commande
python manage.py runserver
permet de vérifier qu'il n'y a pas d'{{c|ImportError}} ou autres. Pensez à le faire dans le virtualenv.
=== Erreurs web ===
Pour checker les changements il suffit de taper l'url du site pour constater en direct les changements. Si jamais il y a un souci il y a deux emplacements pour les logs : {{c|/var/log/uwsgi/nom_binet}} ou {{c|/hosting/log/nom_binet}}.
=== Troubleshooting ===
* Toutes les pages affichent {{c|Internal Server Error}} pas en gras : c'est une erreur de {{c|uwsgi}} qui n'arrive pas à :
** trouver ton site
** trouver le virtualenv
** une exception est levée au démarrage du serveur ({{c|ImportError}} notamment).

Tu peux lire les logs dans {{c|/var/log/uwsgi/<ton binet>/<ton site>.log}} et vérifier où {{c|uwsgi}} va chercher ton site dans {{c|/etc/uwsgi.d/<ton site>.json}}. S'il faut modifier ce dernier fichier, demande-le au BR, tu ne peux pas le faire toi même.
* Toutes les pages affichent {{c|Internal Server Error(500)}} en gras : c'est django. Actives les mails pour avoir des détails, mais tu as probablement oublié de lancer les migrations sur une base sql vide.

Tuto pour le déploiement des sites Django

2018-04-05T07:20:54Z

Wilson.jallet : /* Environnement virtuel */

== Connexion ==

Assurez vous tout d'abord d'être administrateur de votre binet. Il faut attendre au moins une heure pour que les modifications soient prises en compte.

Ensuite vous ouvrez votre terminal et vous vous connectez sur le serveur avec la commande ssh.
ssh prenom.nom@129.104.201.52

Une fois que vous avez tapé votre mot de passe frankiz, vous arrivez sur le serveur dans un dossier à votre nom. Il y a un fichier {{c|README.txt}} qui devrait donner un certain nombre d'informations sur le fonctionnement de kevarzh ou encore sur certaines modifs à faire sur le code de votre site. Vous pouvez vous diriger sur le serveur par les commandes habituelles. Votre dossier personnel se trouve dans {{c|/hosting/user/prenom.nom}}.

Si jamais vous voulez lancer une commande ayant besoin d'internet (par exemple des commandes git) n'oubliez pas de mettre {{c|proxychains}} devant votre commande.

== Copie des fichiers ==

Le dossier {{c|/hosting/www/nom_binet}} contient (au moins) un dossier par site. Si vous n'avez qu'un site, le dossier par défaut est {{c|htdocs}}. C'est dans un de ces dossiers que vous allez devoir copier le code de votre site.
scp -r /code_site prenom.nom@129.104.201.52:/hosting/wwww/nom_binet/version_site

== Quotas ==

Attention ! L'espace réservé à chaque binet est limité. Il faut se méfier quand on fait une copie, notamment a l'environnement virtuel. D'abord il pèse lourd, en plus il faudra que vous le remplaciez de toute façon. Autant ne pas le copier dès le départ...
Pour savoir si vous avez dépassé votre quota :
quota -sg
Cette commande affiche, pour chaque binet, l'espace utilisé, une «soft limit» et la vraie («hard») limit.

== Environnement virtuel ==

Une fois que le code du site est en place, il créer un environnement virtuel, c'est-à-dire une copie locale de l'interpréteur Python correspondant à la version que vous utilisez pour votre site :
virtualenv -p /usr/bin/python3.6 venv
Il est important que vous nommiez le dossier {{c|venv}}.

À partir de là, '''toutes''' les commandes utilisant python doivent être exécutées dans le virtualenv. Pour rentrer dans le virtualenv, vous devez lancer :
source venv/bin/activate

Si cela a fonctionné, vous aurez {{c|(venv)}} en préfixe dans votre terminal :
(venv) prenom.nom@ostizan:/hosting/www/site_binet/htdocs

Une fois dans le venv, vous pouvez installer les dépendances nécessaires :
pip install -r requirements.txt

== Adaptations ==
Certaines adaptations sont nécessaires pour faire fonctionner le site. La documentation officielle de Django fournit une bonne [https://docs.djangoproject.com/fr/1.10/howto/deployment/checklist/ checklist]. Là, pas besoin de se casser la tête il suffit de suivre la liste, des liens sont là pour expliquer en détails ce que l'on fait à chaque fois. Les points essentiels à ne surtout pas sauter sont :
* Mettre {{c|DEBUG}} à {{False}}
* {{c|SECRET_KEY}}:
Si vous utilisez un repo git, il ne faut pas mettre cette clef dans le code.
Un snippet possible est le suivant:
keyfile = os.path.join(BASE_DIR, "secret.key")
if not os.path.exists(keyfile):
with open(keyfile, "wb") as f:
f.write(base64.b64_encode(os.urandom(30)))
with open(keyfile, "r") as f:
SECRET_KEY = f.read().strip()

La clef est contenue dans le fichier {{c|secret.key}} (généré automatiquement s'il n'existe pas) qu'il suffit de mettre dans le {{c|.gitignore}}.

* Mettre {{c|ALLOWED_HOST}} à {{c|["*"]}}, le filtrage a lieu avant Django
* STATIC_ROOT, STATIC_URL, MEDIA_ROOT et MEDIA_URL:
STATIC_URL = '/assets/static/'
STATIC_ROOT = os.path.join(BASE_DIR, "assets/static/")
MEDIA_ROOT = os.path.join(BASE_DIR, "assets/media/")
MEDIA_URL = '/assets/media/'

* emails (indispensable pour être averti des erreurs 500)
DEFAULT_FROM_EMAIL = "nom_du_binet@binets.polytechnique.fr"
# voir https://portail.polytechnique.edu/dsi/eleves/mail-binets
SERVER_EMAIL = DEFAULT_FROM_EMAIL
ADMINS = [("Webmaster", DEFAULT_FROM_EMAIL)]

* base de donnée : n'utilisez pas sqlite ! Nous avons eu des problèmes par le passé, et les bases de données sql sont sauvegardées toutes les semaines.
Un snippet utilisable est :
if DEBUG:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
else:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'OPTIONS': {
'read_default_file': os.path.join(BASE_DIR, 'my.cnf'),
},
}
}

Placer les mots de passe dans le fichier {{c|my.cnf}}:
[client]
database = NAME
user = USER
password = PASSWORD
default-character-set = utf8

Bien sûr il faut ajouter ce fichier dans le gitignore.

== Mise en place de l'authentification par CAS sous Django ==

* Demander sur [https://panix.binets.fr Panix] à utiliser cette authentification. Préciser les éventuels attributs supplémentaires nécessaires (promo, section, ...).
* Installer le paquet django-cas-ng :
pip install django-cas-ng
* Ajouter ce paquet à la liste des applications :
INSTALLED_APPS = [
...
'django_cas_ng',
...
]
* Configurer la connection au serveur CAS du BR :
AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend',
'django_cas_ng.backends.CASBackend',
)
CAS_SERVER_URL = "https://cas.binets.fr/"
* Renseigner les pages de connexion (dans {{c|my_project/urls.py}} par exemple):
from django_cas_ng.views import login, logout

urlpatterns = [
...
url(r'^login$', login, name='cas_ng_login'),
url(r'^logout$', logout, name='cas_ng_logout'),
...
]
* Ajouter l'URL d'entrée :
LOGIN_URL = "login"

* Attention à forcer l'authentification pour les pages concernées :
from django.contrib.auth.decorators import login_required

@login_required
def my_awesome_view(request):
...

À noter :
* le nom de l'utilisateur connecté se trouve dans : request.user.username (accessible dans n'importe quelle vue).
* les attributs du [[LDAP]] peuvent être disponibles (demander les attributs nécessaires lors de la mise en place du CAS). Ils sont alors disponibles dans request.session['attributes'] .
* plus d'option de configuration sont présentés [https://github.com/mingchen/django-cas-ng/tree/master/django_cas_ng ici]

== À chaque modification... ==

* du code python quel qu'il soit :
touch /var/run/please/restart
* du schéma SQL (sous Django):
python manage.py migrate
* des fichiers statiques (sous Django):
python manage.py collectstatic
Il faut attendre 1 ou deux minutes que le système enregistre la modification, quand c'est fait il affiche un message dans le terminal.

== Tester ==
=== Erreurs python ===
La commande
python manage.py runserver
permet de vérifier qu'il n'y a pas d'{{c|ImportError}} ou autres. Pensez à le faire dans le virtualenv.
=== Erreurs web ===
Pour checker les changements il suffit de taper l'url du site pour constater en direct les changements. Si jamais il y a un souci il y a deux emplacements pour les logs : {{c|/var/log/uwsgi/nom_binet}} ou {{c|/hosting/log/nom_binet}}.
=== Troubleshooting ===
* Toutes les pages affichent {{c|Internal Server Error}} pas en gras : c'est une erreur de {{c|uwsgi}} qui n'arrive pas à :
** trouver ton site
** trouver le virtualenv
** une exception est levée au démarrage du serveur ({{c|ImportError}} notamment).

Tu peux lire les logs dans {{c|/var/log/uwsgi/<ton binet>/<ton site>.log}} et vérifier où {{c|uwsgi}} va chercher ton site dans {{c|/etc/uwsgi.d/<ton site>.json}}. S'il faut modifier ce dernier fichier, demande-le au BR, tu ne peux pas le faire toi même.
* Toutes les pages affichent {{c|Internal Server Error(500)}} en gras : c'est django. Actives les mails pour avoir des détails, mais tu as probablement oublié de lancer les migrations sur une base sql vide.

Tuto pour le déploiement des sites Django

2018-04-05T07:19:12Z

Wilson.jallet : /* Virtual environment */

== Connexion ==

Assurez vous tout d'abord d'être administrateur de votre binet. Il faut attendre au moins une heure pour que les modifications soient prises en compte.

Ensuite vous ouvrez votre terminal et vous vous connectez sur le serveur avec la commande ssh.
ssh prenom.nom@129.104.201.52

Une fois que vous avez tapé votre mot de passe frankiz, vous arrivez sur le serveur dans un dossier à votre nom. Il y a un fichier {{c|README.txt}} qui devrait donner un certain nombre d'informations sur le fonctionnement de kevarzh ou encore sur certaines modifs à faire sur le code de votre site. Vous pouvez vous diriger sur le serveur par les commandes habituelles. Votre dossier personnel se trouve dans {{c|/hosting/user/prenom.nom}}.

Si jamais vous voulez lancer une commande ayant besoin d'internet (par exemple des commandes git) n'oubliez pas de mettre {{c|proxychains}} devant votre commande.

== Copie des fichiers ==

Le dossier {{c|/hosting/www/nom_binet}} contient (au moins) un dossier par site. Si vous n'avez qu'un site, le dossier par défaut est {{c|htdocs}}. C'est dans un de ces dossiers que vous allez devoir copier le code de votre site.
scp -r /code_site prenom.nom@129.104.201.52:/hosting/wwww/nom_binet/version_site

== Quotas ==

Attention ! L'espace réservé à chaque binet est limité. Il faut se méfier quand on fait une copie, notamment a l'environnement virtuel. D'abord il pèse lourd, en plus il faudra que vous le remplaciez de toute façon. Autant ne pas le copier dès le départ...
Pour savoir si vous avez dépassé votre quota :
quota -sg
Cette commande affiche, pour chaque binet, l'espace utilisé, une «soft limit» et la vraie («hard») limit.

== Environnement virtuel ==

Une fois que le code du site est en place, il créer un environnement virtuel, c'est-à-dire une copie locale de l'interpréteur Python correspondant à la version que vous utilisez pour votre site :
virtualenv -p /usr/bin/python3.6 venv
Il est important que vous nommiez le dossier {{c|venv}}.

À partir de là, '''toutes''' les commandes utilisant python doivent être exécutées dans le virtualenv. Pour rentrer dans le virtualenv, vous devez lancer :
source venv/bin/activate

Une fois dans le venv, vous pouvez installer les dépendances nécessaires :
pip install -r requirements.txt

== Adaptations ==
Certaines adaptations sont nécessaires pour faire fonctionner le site. La documentation officielle de Django fournit une bonne [https://docs.djangoproject.com/fr/1.10/howto/deployment/checklist/ checklist]. Là, pas besoin de se casser la tête il suffit de suivre la liste, des liens sont là pour expliquer en détails ce que l'on fait à chaque fois. Les points essentiels à ne surtout pas sauter sont :
* Mettre {{c|DEBUG}} à {{False}}
* {{c|SECRET_KEY}}:
Si vous utilisez un repo git, il ne faut pas mettre cette clef dans le code.
Un snippet possible est le suivant:
keyfile = os.path.join(BASE_DIR, "secret.key")
if not os.path.exists(keyfile):
with open(keyfile, "wb") as f:
f.write(base64.b64_encode(os.urandom(30)))
with open(keyfile, "r") as f:
SECRET_KEY = f.read().strip()

La clef est contenue dans le fichier {{c|secret.key}} (généré automatiquement s'il n'existe pas) qu'il suffit de mettre dans le {{c|.gitignore}}.

* Mettre {{c|ALLOWED_HOST}} à {{c|["*"]}}, le filtrage a lieu avant Django
* STATIC_ROOT, STATIC_URL, MEDIA_ROOT et MEDIA_URL:
STATIC_URL = '/assets/static/'
STATIC_ROOT = os.path.join(BASE_DIR, "assets/static/")
MEDIA_ROOT = os.path.join(BASE_DIR, "assets/media/")
MEDIA_URL = '/assets/media/'

* emails (indispensable pour être averti des erreurs 500)
DEFAULT_FROM_EMAIL = "nom_du_binet@binets.polytechnique.fr"
# voir https://portail.polytechnique.edu/dsi/eleves/mail-binets
SERVER_EMAIL = DEFAULT_FROM_EMAIL
ADMINS = [("Webmaster", DEFAULT_FROM_EMAIL)]

* base de donnée : n'utilisez pas sqlite ! Nous avons eu des problèmes par le passé, et les bases de données sql sont sauvegardées toutes les semaines.
Un snippet utilisable est :
if DEBUG:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
else:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'OPTIONS': {
'read_default_file': os.path.join(BASE_DIR, 'my.cnf'),
},
}
}

Placer les mots de passe dans le fichier {{c|my.cnf}}:
[client]
database = NAME
user = USER
password = PASSWORD
default-character-set = utf8

Bien sûr il faut ajouter ce fichier dans le gitignore.

== Mise en place de l'authentification par CAS sous Django ==

* Demander sur [https://panix.binets.fr Panix] à utiliser cette authentification. Préciser les éventuels attributs supplémentaires nécessaires (promo, section, ...).
* Installer le paquet django-cas-ng :
pip install django-cas-ng
* Ajouter ce paquet à la liste des applications :
INSTALLED_APPS = [
...
'django_cas_ng',
...
]
* Configurer la connection au serveur CAS du BR :
AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend',
'django_cas_ng.backends.CASBackend',
)
CAS_SERVER_URL = "https://cas.binets.fr/"
* Renseigner les pages de connexion (dans {{c|my_project/urls.py}} par exemple):
from django_cas_ng.views import login, logout

urlpatterns = [
...
url(r'^login$', login, name='cas_ng_login'),
url(r'^logout$', logout, name='cas_ng_logout'),
...
]
* Ajouter l'URL d'entrée :
LOGIN_URL = "login"

* Attention à forcer l'authentification pour les pages concernées :
from django.contrib.auth.decorators import login_required

@login_required
def my_awesome_view(request):
...

À noter :
* le nom de l'utilisateur connecté se trouve dans : request.user.username (accessible dans n'importe quelle vue).
* les attributs du [[LDAP]] peuvent être disponibles (demander les attributs nécessaires lors de la mise en place du CAS). Ils sont alors disponibles dans request.session['attributes'] .
* plus d'option de configuration sont présentés [https://github.com/mingchen/django-cas-ng/tree/master/django_cas_ng ici]

== À chaque modification... ==

* du code python quel qu'il soit :
touch /var/run/please/restart
* du schéma SQL (sous Django):
python manage.py migrate
* des fichiers statiques (sous Django):
python manage.py collectstatic
Il faut attendre 1 ou deux minutes que le système enregistre la modification, quand c'est fait il affiche un message dans le terminal.

== Tester ==
=== Erreurs python ===
La commande
python manage.py runserver
permet de vérifier qu'il n'y a pas d'{{c|ImportError}} ou autres. Pensez à le faire dans le virtualenv.
=== Erreurs web ===
Pour checker les changements il suffit de taper l'url du site pour constater en direct les changements. Si jamais il y a un souci il y a deux emplacements pour les logs : {{c|/var/log/uwsgi/nom_binet}} ou {{c|/hosting/log/nom_binet}}.
=== Troubleshooting ===
* Toutes les pages affichent {{c|Internal Server Error}} pas en gras : c'est une erreur de {{c|uwsgi}} qui n'arrive pas à :
** trouver ton site
** trouver le virtualenv
** une exception est levée au démarrage du serveur ({{c|ImportError}} notamment).

Tu peux lire les logs dans {{c|/var/log/uwsgi/<ton binet>/<ton site>.log}} et vérifier où {{c|uwsgi}} va chercher ton site dans {{c|/etc/uwsgi.d/<ton site>.json}}. S'il faut modifier ce dernier fichier, demande-le au BR, tu ne peux pas le faire toi même.
* Toutes les pages affichent {{c|Internal Server Error(500)}} en gras : c'est django. Actives les mails pour avoir des détails, mais tu as probablement oublié de lancer les migrations sur une base sql vide.

Tuto pour le déploiement des sites Django

2018-04-05T07:17:42Z

Wilson.jallet : /* Mise en place de l'authentification par CAS */

== Connexion ==

Assurez vous tout d'abord d'être administrateur de votre binet. Il faut attendre au moins une heure pour que les modifications soient prises en compte.

Ensuite vous ouvrez votre terminal et vous vous connectez sur le serveur avec la commande ssh.
ssh prenom.nom@129.104.201.52

Une fois que vous avez tapé votre mot de passe frankiz, vous arrivez sur le serveur dans un dossier à votre nom. Il y a un fichier {{c|README.txt}} qui devrait donner un certain nombre d'informations sur le fonctionnement de kevarzh ou encore sur certaines modifs à faire sur le code de votre site. Vous pouvez vous diriger sur le serveur par les commandes habituelles. Votre dossier personnel se trouve dans {{c|/hosting/user/prenom.nom}}.

Si jamais vous voulez lancer une commande ayant besoin d'internet (par exemple des commandes git) n'oubliez pas de mettre {{c|proxychains}} devant votre commande.

== Copie des fichiers ==

Le dossier {{c|/hosting/www/nom_binet}} contient (au moins) un dossier par site. Si vous n'avez qu'un site, le dossier par défaut est {{c|htdocs}}. C'est dans un de ces dossiers que vous allez devoir copier le code de votre site.
scp -r /code_site prenom.nom@129.104.201.52:/hosting/wwww/nom_binet/version_site

== Quotas ==

Attention ! L'espace réservé à chaque binet est limité. Il faut se méfier quand on fait une copie, notamment a l'environnement virtuel. D'abord il pèse lourd, en plus il faudra que vous le remplaciez de toute façon. Autant ne pas le copier dès le départ...
Pour savoir si vous avez dépassé votre quota :
quota -sg
Cette commande affiche, pour chaque binet, l'espace utilisé, une «soft limit» et la vraie («hard») limit.

== Virtual environment ==

Une fois que le code du site est en place, il faut recréer l'environnement virtuel.
virtualenv -p /usr/bin/python3 venv
Il est important que vous nommiez le dossier {{c|venv}}.

À partir de là, '''toutes''' les commandes utilisant python doivent être exécutées dans le virtualenv. Pour rentrer dans le virtualenv, vous devez lancer :
source venv/bin/activate

Une fois dans le venv, vous pouvez installer les dépendances nécessaires :
proxychains pip install -r requirements.txt

== Adaptations ==
Certaines adaptations sont nécessaires pour faire fonctionner le site. La documentation officielle de Django fournit une bonne [https://docs.djangoproject.com/fr/1.10/howto/deployment/checklist/ checklist]. Là, pas besoin de se casser la tête il suffit de suivre la liste, des liens sont là pour expliquer en détails ce que l'on fait à chaque fois. Les points essentiels à ne surtout pas sauter sont :
* Mettre {{c|DEBUG}} à {{False}}
* {{c|SECRET_KEY}}:
Si vous utilisez un repo git, il ne faut pas mettre cette clef dans le code.
Un snippet possible est le suivant:
keyfile = os.path.join(BASE_DIR, "secret.key")
if not os.path.exists(keyfile):
with open(keyfile, "wb") as f:
f.write(base64.b64_encode(os.urandom(30)))
with open(keyfile, "r") as f:
SECRET_KEY = f.read().strip()

La clef est contenue dans le fichier {{c|secret.key}} (généré automatiquement s'il n'existe pas) qu'il suffit de mettre dans le {{c|.gitignore}}.

* Mettre {{c|ALLOWED_HOST}} à {{c|["*"]}}, le filtrage a lieu avant Django
* STATIC_ROOT, STATIC_URL, MEDIA_ROOT et MEDIA_URL:
STATIC_URL = '/assets/static/'
STATIC_ROOT = os.path.join(BASE_DIR, "assets/static/")
MEDIA_ROOT = os.path.join(BASE_DIR, "assets/media/")
MEDIA_URL = '/assets/media/'

* emails (indispensable pour être averti des erreurs 500)
DEFAULT_FROM_EMAIL = "nom_du_binet@binets.polytechnique.fr"
# voir https://portail.polytechnique.edu/dsi/eleves/mail-binets
SERVER_EMAIL = DEFAULT_FROM_EMAIL
ADMINS = [("Webmaster", DEFAULT_FROM_EMAIL)]

* base de donnée : n'utilisez pas sqlite ! Nous avons eu des problèmes par le passé, et les bases de données sql sont sauvegardées toutes les semaines.
Un snippet utilisable est :
if DEBUG:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
else:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'OPTIONS': {
'read_default_file': os.path.join(BASE_DIR, 'my.cnf'),
},
}
}

Placer les mots de passe dans le fichier {{c|my.cnf}}:
[client]
database = NAME
user = USER
password = PASSWORD
default-character-set = utf8

Bien sûr il faut ajouter ce fichier dans le gitignore.

== Mise en place de l'authentification par CAS sous Django ==

* Demander sur [https://panix.binets.fr Panix] à utiliser cette authentification. Préciser les éventuels attributs supplémentaires nécessaires (promo, section, ...).
* Installer le paquet django-cas-ng :
pip install django-cas-ng
* Ajouter ce paquet à la liste des applications :
INSTALLED_APPS = [
...
'django_cas_ng',
...
]
* Configurer la connection au serveur CAS du BR :
AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend',
'django_cas_ng.backends.CASBackend',
)
CAS_SERVER_URL = "https://cas.binets.fr/"
* Renseigner les pages de connexion (dans {{c|my_project/urls.py}} par exemple):
from django_cas_ng.views import login, logout

urlpatterns = [
...
url(r'^login$', login, name='cas_ng_login'),
url(r'^logout$', logout, name='cas_ng_logout'),
...
]
* Ajouter l'URL d'entrée :
LOGIN_URL = "login"

* Attention à forcer l'authentification pour les pages concernées :
from django.contrib.auth.decorators import login_required

@login_required
def my_awesome_view(request):
...

À noter :
* le nom de l'utilisateur connecté se trouve dans : request.user.username (accessible dans n'importe quelle vue).
* les attributs du [[LDAP]] peuvent être disponibles (demander les attributs nécessaires lors de la mise en place du CAS). Ils sont alors disponibles dans request.session['attributes'] .
* plus d'option de configuration sont présentés [https://github.com/mingchen/django-cas-ng/tree/master/django_cas_ng ici]

== À chaque modification... ==

* du code python quel qu'il soit :
touch /var/run/please/restart
* du schéma SQL (sous Django):
python manage.py migrate
* des fichiers statiques (sous Django):
python manage.py collectstatic
Il faut attendre 1 ou deux minutes que le système enregistre la modification, quand c'est fait il affiche un message dans le terminal.

== Tester ==
=== Erreurs python ===
La commande
python manage.py runserver
permet de vérifier qu'il n'y a pas d'{{c|ImportError}} ou autres. Pensez à le faire dans le virtualenv.
=== Erreurs web ===
Pour checker les changements il suffit de taper l'url du site pour constater en direct les changements. Si jamais il y a un souci il y a deux emplacements pour les logs : {{c|/var/log/uwsgi/nom_binet}} ou {{c|/hosting/log/nom_binet}}.
=== Troubleshooting ===
* Toutes les pages affichent {{c|Internal Server Error}} pas en gras : c'est une erreur de {{c|uwsgi}} qui n'arrive pas à :
** trouver ton site
** trouver le virtualenv
** une exception est levée au démarrage du serveur ({{c|ImportError}} notamment).

Tu peux lire les logs dans {{c|/var/log/uwsgi/<ton binet>/<ton site>.log}} et vérifier où {{c|uwsgi}} va chercher ton site dans {{c|/etc/uwsgi.d/<ton site>.json}}. S'il faut modifier ce dernier fichier, demande-le au BR, tu ne peux pas le faire toi même.
* Toutes les pages affichent {{c|Internal Server Error(500)}} en gras : c'est django. Actives les mails pour avoir des détails, mais tu as probablement oublié de lancer les migrations sur une base sql vide.

Tuto pour le déploiement des sites Django

2018-04-05T07:17:02Z

Wilson.jallet : /* À chaque modification... */

== Connexion ==

Assurez vous tout d'abord d'être administrateur de votre binet. Il faut attendre au moins une heure pour que les modifications soient prises en compte.

Ensuite vous ouvrez votre terminal et vous vous connectez sur le serveur avec la commande ssh.
ssh prenom.nom@129.104.201.52

Une fois que vous avez tapé votre mot de passe frankiz, vous arrivez sur le serveur dans un dossier à votre nom. Il y a un fichier {{c|README.txt}} qui devrait donner un certain nombre d'informations sur le fonctionnement de kevarzh ou encore sur certaines modifs à faire sur le code de votre site. Vous pouvez vous diriger sur le serveur par les commandes habituelles. Votre dossier personnel se trouve dans {{c|/hosting/user/prenom.nom}}.

Si jamais vous voulez lancer une commande ayant besoin d'internet (par exemple des commandes git) n'oubliez pas de mettre {{c|proxychains}} devant votre commande.

== Copie des fichiers ==

Le dossier {{c|/hosting/www/nom_binet}} contient (au moins) un dossier par site. Si vous n'avez qu'un site, le dossier par défaut est {{c|htdocs}}. C'est dans un de ces dossiers que vous allez devoir copier le code de votre site.
scp -r /code_site prenom.nom@129.104.201.52:/hosting/wwww/nom_binet/version_site

== Quotas ==

Attention ! L'espace réservé à chaque binet est limité. Il faut se méfier quand on fait une copie, notamment a l'environnement virtuel. D'abord il pèse lourd, en plus il faudra que vous le remplaciez de toute façon. Autant ne pas le copier dès le départ...
Pour savoir si vous avez dépassé votre quota :
quota -sg
Cette commande affiche, pour chaque binet, l'espace utilisé, une «soft limit» et la vraie («hard») limit.

== Virtual environment ==

Une fois que le code du site est en place, il faut recréer l'environnement virtuel.
virtualenv -p /usr/bin/python3 venv
Il est important que vous nommiez le dossier {{c|venv}}.

À partir de là, '''toutes''' les commandes utilisant python doivent être exécutées dans le virtualenv. Pour rentrer dans le virtualenv, vous devez lancer :
source venv/bin/activate

Une fois dans le venv, vous pouvez installer les dépendances nécessaires :
proxychains pip install -r requirements.txt

== Adaptations ==
Certaines adaptations sont nécessaires pour faire fonctionner le site. La documentation officielle de Django fournit une bonne [https://docs.djangoproject.com/fr/1.10/howto/deployment/checklist/ checklist]. Là, pas besoin de se casser la tête il suffit de suivre la liste, des liens sont là pour expliquer en détails ce que l'on fait à chaque fois. Les points essentiels à ne surtout pas sauter sont :
* Mettre {{c|DEBUG}} à {{False}}
* {{c|SECRET_KEY}}:
Si vous utilisez un repo git, il ne faut pas mettre cette clef dans le code.
Un snippet possible est le suivant:
keyfile = os.path.join(BASE_DIR, "secret.key")
if not os.path.exists(keyfile):
with open(keyfile, "wb") as f:
f.write(base64.b64_encode(os.urandom(30)))
with open(keyfile, "r") as f:
SECRET_KEY = f.read().strip()

La clef est contenue dans le fichier {{c|secret.key}} (généré automatiquement s'il n'existe pas) qu'il suffit de mettre dans le {{c|.gitignore}}.

* Mettre {{c|ALLOWED_HOST}} à {{c|["*"]}}, le filtrage a lieu avant Django
* STATIC_ROOT, STATIC_URL, MEDIA_ROOT et MEDIA_URL:
STATIC_URL = '/assets/static/'
STATIC_ROOT = os.path.join(BASE_DIR, "assets/static/")
MEDIA_ROOT = os.path.join(BASE_DIR, "assets/media/")
MEDIA_URL = '/assets/media/'

* emails (indispensable pour être averti des erreurs 500)
DEFAULT_FROM_EMAIL = "nom_du_binet@binets.polytechnique.fr"
# voir https://portail.polytechnique.edu/dsi/eleves/mail-binets
SERVER_EMAIL = DEFAULT_FROM_EMAIL
ADMINS = [("Webmaster", DEFAULT_FROM_EMAIL)]

* base de donnée : n'utilisez pas sqlite ! Nous avons eu des problèmes par le passé, et les bases de données sql sont sauvegardées toutes les semaines.
Un snippet utilisable est :
if DEBUG:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
else:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'OPTIONS': {
'read_default_file': os.path.join(BASE_DIR, 'my.cnf'),
},
}
}

Placer les mots de passe dans le fichier {{c|my.cnf}}:
[client]
database = NAME
user = USER
password = PASSWORD
default-character-set = utf8

Bien sûr il faut ajouter ce fichier dans le gitignore.

== Mise en place de l'authentification par CAS ==

* Demander sur [https://panix.binets.fr Panix] à utiliser cette authentification. Préciser les éventuels attributs supplémentaires nécessaires (promo, section, ...).
* Installer le paquet django-cas-ng :
pip install django-cas-ng
* Ajouter ce paquet à la liste des applications :
INSTALLED_APPS = [
...
'django_cas_ng',
...
]
* Configurer la connection au serveur CAS du BR :
AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend',
'django_cas_ng.backends.CASBackend',
)
CAS_SERVER_URL = "https://cas.binets.fr/"
* Renseigner les pages de connexion (dans {{c|my_project/urls.py}} par exemple):
from django_cas_ng.views import login, logout

urlpatterns = [
...
url(r'^login$', login, name='cas_ng_login'),
url(r'^logout$', logout, name='cas_ng_logout'),
...
]
* Ajouter l'URL d'entrée :
LOGIN_URL = "login"

* Attention à forcer l'authentification pour les pages concernées :
from django.contrib.auth.decorators import login_required

@login_required
def my_awesome_view(request):
...

À noter :
* le nom de l'utilisateur connecté se trouve dans : request.user.username (accessible dans n'importe quelle vue).
* les attributs du [[LDAP]] peuvent être disponibles (demander les attributs nécessaires lors de la mise en place du CAS). Ils sont alors disponibles dans request.session['attributes'] .
* plus d'option de configuration sont présentés [https://github.com/mingchen/django-cas-ng/tree/master/django_cas_ng ici]

== À chaque modification... ==

* du code python quel qu'il soit :
touch /var/run/please/restart
* du schéma SQL (sous Django):
python manage.py migrate
* des fichiers statiques (sous Django):
python manage.py collectstatic
Il faut attendre 1 ou deux minutes que le système enregistre la modification, quand c'est fait il affiche un message dans le terminal.

== Tester ==
=== Erreurs python ===
La commande
python manage.py runserver
permet de vérifier qu'il n'y a pas d'{{c|ImportError}} ou autres. Pensez à le faire dans le virtualenv.
=== Erreurs web ===
Pour checker les changements il suffit de taper l'url du site pour constater en direct les changements. Si jamais il y a un souci il y a deux emplacements pour les logs : {{c|/var/log/uwsgi/nom_binet}} ou {{c|/hosting/log/nom_binet}}.
=== Troubleshooting ===
* Toutes les pages affichent {{c|Internal Server Error}} pas en gras : c'est une erreur de {{c|uwsgi}} qui n'arrive pas à :
** trouver ton site
** trouver le virtualenv
** une exception est levée au démarrage du serveur ({{c|ImportError}} notamment).

Tu peux lire les logs dans {{c|/var/log/uwsgi/<ton binet>/<ton site>.log}} et vérifier où {{c|uwsgi}} va chercher ton site dans {{c|/etc/uwsgi.d/<ton site>.json}}. S'il faut modifier ce dernier fichier, demande-le au BR, tu ne peux pas le faire toi même.
* Toutes les pages affichent {{c|Internal Server Error(500)}} en gras : c'est django. Actives les mails pour avoir des détails, mais tu as probablement oublié de lancer les migrations sur une base sql vide.

Fichier:Logo gitlab br.png

2018-04-02T00:19:14Z

Wilson.jallet : Logo présent sur la page d'accueil du GitLab BR https://gitlab.binets.fr

Logo présent sur la page d'accueil du GitLab BR https://gitlab.binets.fr