Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 3.53 KB

README.md

File metadata and controls

87 lines (59 loc) · 3.53 KB
Raw

Hosting Proxmox

Contributeurs :

Présentation

Hosting est la plateforme d'hébergement cloud proposée gratuitement par l'Association MiNET à ses adhérents.

Ce code open source reprend la totalité du code de l'application web hosting.minet.net.

Prérequis

Global

  • Avoir installé mysql, angular et flask

Backend

Se placer dans backend/

  • Créer un environment virtuel python3 -m venv venv et l'activer source venv/bin/activate
  • Lancer la commande pip3 install -r requirements.txt dans le dépot pour installer les packages requis.

Définir les différents secrets

Dans .env, à la racine du projet :

export KEYRING_DNS_SECRET=<KEYRING_DNS_SECRET>
export PROXMOX_API_KEY_NAME=<PROXMOX_API_KEY_NAME>
export PROXMOX_API_KEY=<PROXMOX_API_KEY>
export PROXMOX_BACK_DB=<PROXMOX_BACK_DB>
export ADH6_API_KEY=<ADH6_API_KEY>
export PROXMOX_BACK_DB_DEV=<PROXMOX_BACK_DB_DEV>
export ENVIRONMENT="DEV"

Ces valeurs doivent vous êtes fournies par les maintainers actuels et dépendent de l'infrastructure.

L'environnement conditionne certains composants de l'application.

  1. PROD est réservé à l'execution de l'application dans un environnement de production. C'est par exemple au sein de cet environment que les cron jobs s'executeront. Il est impératif que seul l'env de PROD soit en charge de ce genre d'opérations
  2. DEV désactive certaines fonctionnalités réservées à la prod, comme les cron jobs. Mais il utilise la même pas de données la production. C'est l'environment à utiliser en local ou sur hosting-dev
  3. TEST est l'environment utilisé pour effectuer les tests unitaires et d'intégrations du backend. Il déploie un base de donnée particulière réservée aux tests.

Lancer le site en local

Makefile

Un makefile permet de lancer le site aisément :

  • make pour lancer le serveur web et l'API
  • make run_server pour lancer l'API seulement
  • make run_frontend pour lancer le frontend

Le backend/API à la main:

  1. Charger les variables d'environnement source .env

  2. Rendez vous dans backend/ et chargez l'environnement virtuel python : source venv/bin/activate

  3. Exécutez la commande python3 -m proxmox_api. Le serveur se lance alors. Assurez vous qu'il est joignable via le port 8080 de votre machine pour qu'il puisse être joint par le frontend

Le frontend

Le frontend calcule l'adresse du backend en fonction de l'URL à partir de laquelle il s'execute. En local, l'URL doit être hosting-local.minet.net:<angular port> (tout autre URL entrainera l'utilisation du backend de prod).

Vous devez donc

  1. Créer l'entrée DNS locale (/etc/host) :

127.0.0.1 hosting-local.minet.net

  1. Lancer dans le dossier frontend

npm install

  1. Puis

ng serve --host=127.0.0.1 --disable-host-check.

Licence

La totalité du code source est régis par la Licence AGPL-3.0.

Il est écrit par et pour l'Association 1901 : MiNET.

Ce service est hébergé par MiNET sur ses serveurs en France.

Contact et sécurité

Pour tout report de vulnérabilité ou demande légale, merci de s'adresser à l'adresse mail webmaster[at]minet.net.

Une clé PGP pourra vous être fournie en cas de vulnérabilité trouvée.

Mentions légales

Voir les mentions légales