diff --git a/README.md b/Ancien protocole.md similarity index 100% rename from README.md rename to Ancien protocole.md diff --git a/Bug_et_problemes.md b/Bug_et_problemes.md deleted file mode 100644 index 4d01a5d5d34cae3928a6f1819146cfbb30f74d1d..0000000000000000000000000000000000000000 --- a/Bug_et_problemes.md +++ /dev/null @@ -1,15 +0,0 @@ -- Interface web pas responsive -- Clignotement du "Back to Home" -- Joueur parfois kické des quiz de manière random après une question (quand plusieurs ont la même bonne réponse en même temps, on dirait) -- Logo sous licence -- Pas de média -- Une note beaucoup trop haute pour un projet à moitié terminé -- L'interface pour rejoindre est nulle (aucun style CSS) -- Sign-up : si jamais on crée un compte avec un nom déjà utilisé, ça nous dit juste "Création du compte impossible" ou "Invalid credentials" -- Il n'y a pas de média -- QR code envoie vers localhost -- Parfois, l'application fail de manière aléatoire -- Le style de la modal pour rejoindre est affreux, c'est du natif HTML sans CSS -- Modes multi ont une connexion instable -- Modes multi sont affreusement lents (problème d'ergonomie, long à redévelopper) -- Dans la CI/CD les tests et le lint ne marche pas, dans le sens où il est mal configuré, il manque des dépendances diff --git a/Compte_rendu.md b/Compte_rendu.md new file mode 100644 index 0000000000000000000000000000000000000000..a4e916ee83e73c032d0f8c3148c04ef6c0f2b399 --- /dev/null +++ b/Compte_rendu.md @@ -0,0 +1,90 @@ +# Procédure d'installation + +### Accès au projet + +Générez une clé ssh sur la machine qui sera votre serveur via la commande `ssh-keygen`. Installez-la, au besoin, via la procédure indiqué sur internet pour votre OS. + +Rendez-vous suir gitlab. Allez dans votre profile, onglet "SSH keys". + +Ajoutez votre clé publique avec le bouton associé. + +### Clonage du projet + +Rendez-vous sur la machine qui sera votre serveur, dans le dossier de votre choix + +Clonez les deux repo git dans ce dossier, via + +```bash +git clone git@git.unistra.fr:jagermasters/gyokeres-web-rebirth.git +git clone git@git.unistra.fr:jagermasters/gyokeres-api-rebirth.git +``` + +### Installation de docker + +Via la documentation officielle, installez [Docker engine](https://docs.docker.com/engine/install/) et [Docker compose](https://docs.docker.com/compose/install/) + +### Création du réseau inter-services + +Créez le network permettant à tous les services et le proxy de communiquer ensemble, via + +```bash +docker network create the_all_knowing` +``` + +### Initialisation du proxy (optionnel) + +Si vous souhaitez choisir le nom de domaine à utuiliser et/ou simplement sécuriser l'accès à votre machine par les utilisateuers du site, récuperez le fichier `compose.yml` sur le [repo git d'aide au déploiement](https://git.unistra.fr/jagermasters/gyokeres-deploy-assistance). + +Rangez le dans le dossier de votre choix, puis lancez le nginx proxy manager (NPM) via + +```bash +docker compose up -d +``` + +Rendez vous sur [l'interface de NPM](localhost:81) + +Par défaut, l'email est `admin@example.com` et le mot de passe est `changeme`. Vous pouvez ensuite choisir celui que vous voulez. + +Cliquez sur "Proxy host" puis "Add proxy host" et entrez les informations suivantes : . _Les noms de domaines demandez peuvent sit être votre IP (si vous possédez une IP privée ou que vous ne voulez pas de nom de domaine) ou le nom que vous avez acheté au préalable (à OVH, cloudflare ou autre)_ + +Si vous possédez une IP publique, vous pouvez aussi demander un nginx la création d'un certificat SSL (crypte les échanges sur le réseau pour plus de sécurité), aussi parfois nommé "le petit cadena sur google", via : + + + +### Initialisation du projet + +Dernière ligne droite ! + +Rendez vous là où vous avez cloné le projet (web et api) et, dans chacun des dossier, lancez les containers via + +```bash +docker-compose -f docker-compose.prod.yml up -d +``` + +# FAQ + +# Prise en main + +## Ancien protocole d'installation + +Au besoin, les rares anciennes documentations et info transmise par l'ancien groupe en charge du développement de Gyokerske sont disponibles ici. + +## Problèmes repérés + +- Interface web pas responsive +- Clignotement du "Back to Home" +- Joueur parfois kické des quiz de manière random après une question (quand plusieurs ont la même bonne réponse en même temps, on dirait) +- Logo sous licence +- Pas de média +- Une note beaucoup trop haute pour un projet à moitié terminé +- L'interface pour rejoindre est nulle (aucun style CSS) +- Sign-up : si jamais on crée un compte avec un nom déjà utilisé, ça nous dit juste "Création du compte impossible" ou "Invalid credentials" +- Il n'y a pas de média +- QR code envoie vers localhost +- Parfois, l'application fail de manière aléatoire +- Le style de la modal pour rejoindre est affreux, c'est du natif HTML sans CSS +- Modes multi ont une connexion instable +- Modes multi sont affreusement lents (problème d'ergonomie, long à redévelopper) +- Dans la CI/CD les tests et le lint ne marche pas, dans le sens où il est mal configuré, il manque des dépendances + +# Notes complémentaires diff --git a/Consignes/Moodle.png b/Consignes/Moodle.png new file mode 100644 index 0000000000000000000000000000000000000000..df8d3d57915f9b5e928a62a680a6ab4f75fc380e Binary files /dev/null and b/Consignes/Moodle.png differ diff --git a/S6_consignes.md b/Consignes/Prise de notes.md similarity index 100% rename from S6_consignes.md rename to Consignes/Prise de notes.md diff --git a/complementaire.md b/complementaire.md index 13e8c967e2ea28df59ea64b33767877594cabd11..681a6dd692f1d183d294224eba5524185cf567ad 100644 --- a/complementaire.md +++ b/complementaire.md @@ -1,7 +1,10 @@ # guide de déploiement -Créer le network `docker network create the_all_knowing` (il permet à tous les services et le proxy de communiquer ensemble) PUIS lancer le docker # rapport on a modifié la ci/cd pour plus de simpliciter. fonctionnelle dès le départ, mais sur le server de l'ancien grp, elle vise mtn notre serveur proxmox. D'ailleurs leur pipeline affichait en clair leur utilisateur et adresse ip -- pas très sécurisé ! + +# interaction + +on nous a reproché de ne pas avoir de script pour lancer facilement l'application entière (ex un init.sh)... oui car nous avons suivi la logique de docker compose qui le fait déjà à votre place en une seule commande simple, à la fois dispo sur notre doc, celle officielle (et ayant été vu en cours si on sort du rp). diff --git a/compose.yml b/compose.yml new file mode 100644 index 0000000000000000000000000000000000000000..ead1f2dccb513e96b420e5c2ca816fe5a3794c6e --- /dev/null +++ b/compose.yml @@ -0,0 +1,19 @@ +# use nginx proxy manager to reverse proxy to other services + +networks: + gyokeres_network: + external: true + name: the_all_knowing + +services: + app: + image: 'jc21/nginx-proxy-manager:latest' + restart: unless-stopped + ports: + - '80:80' + - '81:81' + - '443:443' + volumes: + - ./data:/data + - ./letsencrypt:/etc/letsencrypt + container_name: rev-prox diff --git a/config_proxy_host.png b/config_proxy_host.png new file mode 100644 index 0000000000000000000000000000000000000000..88d9f10af9acc3178ae787e6b6c6f14945a201aa Binary files /dev/null and b/config_proxy_host.png differ diff --git a/ssl.png b/ssl.png new file mode 100644 index 0000000000000000000000000000000000000000..3cd31826bd73567e5b7c2b61c2d75e4c70e46e5e Binary files /dev/null and b/ssl.png differ diff --git a/todo.md b/todo.md index 80760dcdb4475dcb0aab05fd5b134d9a20b243e0..ff2bdbd36f551c734e7089c19d1d66b7f06e45c9 100644 --- a/todo.md +++ b/todo.md @@ -1,3 +1,6 @@ - dans prochaine etape du projet : doit changer les valeurs de CI/CD ! (genre user et ip) et les mettre dans jogurmand tester de cloner les deux repo, lancer les containers, mettre ufw + + +- ecrire les Readme (car faut rendre un git propre)