README - modification de la section "Installation" pour ajouter PIP

master
Olivier DOSSMANN 2017-08-24 20:56:11 +02:00
parent 5820bdc63a
commit 00afb10702
2 changed files with 42 additions and 15 deletions

View File

@ -16,14 +16,50 @@ Logiciel web permettant de :
# Installation # Installation
En s'appuyant sur [Docker](https://www.docker.com/), l'installation se déroule en plusieurs étapes : Choisissez l'une des méthodes suivantes :
* la création d'une image Docker * en utilisant **pip**, le gestionnaire de paquets Python. À utiliser en local ou en utilisant les [fameux environnements virtuels Python](http://sametmax.com/les-environnement-virtuels-python-virtualenv-et-virtualenvwrapper/)
* la création d'un dossier pour la base de données et la génération de cette dernière * ou en s'appuyant sur [Docker](https://www.docker.com/)
* la création d'un utilisateur administrateur de la base de données (l'utilisateur principal)
* le lancement d'un conteneur Docker permettant d'accéder à l'interface Web de l'application
## Création de l'image Docker ## En utilisant pip
Vous devez disposer de **pip** sur votre machine, par exemple sur Debian/Ubuntu, il suffit de lancer la commande suivante :
```bash
sudo apt install python3-pip
```
Ensuite on utilise les dépendances Python propres au projet :
```bash
cd openbackloggery
pip install -r requirements.txt
```
On génère la base de données et on la rempli :
```bash
cd collection
python3 manage.py migrate
python3 manage.py loaddata initial
python3 manage.py createsuperuser --user=superadmin --email=superadmin@domaine.tld
```
Remplacez **superadmin** par un identifiant que vous souhaiteriez avoir. Et mettez l'adresse courriel que vous voulez (car pour l'instant l'application n'utilise pas le courriel).
Il ne vous reste plus qu'à lancer l'application :
```bash
python3 manage.py runserver
```
et d'y accéder à l'adresse suivante : http://127.0.0.1:8000/admin/.
Pensez à jouer quand même ! ^_^
## En utilisant Docker
Avec Docker nous allons procéder en plusieurs étapes :
Nous appelerons notre image Docker **openbackloggery**. Nous considéréons que l'application se trouver dans un dossier nommé **openbackloggery** dans lequel se trouve un fichier *Dockerfile*. Nous appelerons notre image Docker **openbackloggery**. Nous considéréons que l'application se trouver dans un dossier nommé **openbackloggery** dans lequel se trouve un fichier *Dockerfile*.
@ -32,8 +68,6 @@ cd openbackloggery
docker build -t openbackloggery:0.1 . docker build -t openbackloggery:0.1 .
``` ```
## Base de données
Actuellement nous utilisons SQLite3 comme base de données car les fonctionnalités et la quantité de données ne requièrent pas un gestionnaire de base de données plus conséquent. Actuellement nous utilisons SQLite3 comme base de données car les fonctionnalités et la quantité de données ne requièrent pas un gestionnaire de base de données plus conséquent.
```bash ```bash
@ -44,16 +78,12 @@ docker run -it --rm -v /openbackloggery_db:/opt/apps/db openbackloggery:0.1 pyth
*loaddata initial* permet de charger quelques données initiales comme une liste de consoles par exemple. *loaddata initial* permet de charger quelques données initiales comme une liste de consoles par exemple.
## Création d'un utilisateur admin
Adaptez la ligne en remplaçant **admin** par le nom d'utilisateur que vous voulez et **admin@domaine.tld** par l'adresse courriel de votre choix (qu'elle existe ou non importe peu pour l'instant car elle n'est pas utilisée). Adaptez la ligne en remplaçant **admin** par le nom d'utilisateur que vous voulez et **admin@domaine.tld** par l'adresse courriel de votre choix (qu'elle existe ou non importe peu pour l'instant car elle n'est pas utilisée).
```bash ```bash
docker run -it --rm -v /openbackloggery_db:/opt/apps/db openbackloggery:0.1 python3 manage.py createsuperuser --user=admin --email=admin@domaine.tld docker run -it --rm -v /openbackloggery_db:/opt/apps/db openbackloggery:0.1 python3 manage.py createsuperuser --user=admin --email=admin@domaine.tld
``` ```
## Lancement du conteneur Docker
Le service se lancera sur le **port 8282** et aura pour clé secrète **abcdefghijk** : Le service se lancera sur le **port 8282** et aura pour clé secrète **abcdefghijk** :
```bash ```bash
@ -62,8 +92,6 @@ docker run -d -e SECRET_KEY='abcdefghijk' -v /openbackloggery_db:/opt/apps/db -p
Veillez à modifier la clé secrète par une chaîne de caractère aléatoire assez longue et parsemée de majuscules, minuscules, ponctuation, etc. Veillez à modifier la clé secrète par une chaîne de caractère aléatoire assez longue et parsemée de majuscules, minuscules, ponctuation, etc.
## Accès à l'application
Une fois le conteneur Docker lancé, il suffit d'ouvrir un navigateur Internet et d'y taper l'adresse suivante : http://127.0.0.1:8282/admin/. Une fois le conteneur Docker lancé, il suffit d'ouvrir un navigateur Internet et d'y taper l'adresse suivante : http://127.0.0.1:8282/admin/.
# Licence # Licence

1
TODO
View File

@ -7,7 +7,6 @@
## Dépôt / code ## Dépôt / code
* README : Déplacer les informations d'installation de Docker dans une documentation autre * README : Déplacer les informations d'installation de Docker dans une documentation autre
* README: Remplacer l'installation Docker par une installation pip basique (avec dépendances + commandes pip). Dire qu'on peut utiliser un environnement virtuel
* ajouter un fichier CHANGELOG * ajouter un fichier CHANGELOG
## Fonctionnalités ## Fonctionnalités