Installer GradePush

Hébergez GradePush Core pour votre établissement avec Docker Compose. L’installation comprend GradePush, PostgreSQL et Caddy pour le HTTPS automatique.

#Avant de commencer

• Un serveur Linux avec Docker et Docker Compose 2.32 ou plus récent.
• Un domaine public, par exemple grades.example.org, pointant vers ce serveur.
• Les ports 80 et 443 accessibles depuis Internet et disponibles sur le serveur.
• Un compte GitHub pour créer la GitHub App de l’installation.

#1. Préparer les fichiers Compose

Choisissez l’une des méthodes suivantes.

#Option 1 : script de préparation (recommandé)

Pour préparer les fichiers automatiquement, exécutez le script de configuration sur votre serveur Linux. Cette méthode nécessite curl et OpenSSL.

curl -fsSLO https://raw.githubusercontent.com/gradepush/gradepush/main/scripts/install.sh
sh install.sh

Indiquez le domaine sans https:// ni chemin. Le script crée le dossier gradepush avec ses fichiers de configuration et affiche votre lien de configuration privé.

Gardez le lien de configuration et le fichier .env privés.

#Option 2 : configuration manuelle avec Compose

Créez un dossier gradepush sur le serveur et enregistrez-y le fichier Compose autonome sous le nom compose.yaml.

Créez un fichier .env dans le même dossier :

PHX_HOST=grades.example.org
DB_PASSWORD=REPLACE_WITH_A_UNIQUE_RANDOM_PASSWORD

Remplacez le domaine par le vôtre, sans https:// ni chemin. Remplacez la valeur d’exemple du mot de passe par un mot de passe aléatoire unique provenant de votre gestionnaire de mots de passe, avec au moins 32 lettres et chiffres. Gardez .env privé.

#2. Démarrer les services

cd gradepush
docker compose pull
docker compose up -d --wait

Caddy obtient et renouvelle le certificat HTTPS. Vérifiez que votre domaine s’ouvre de façon sécurisée avant de configurer GitHub. Au besoin, consultez docker compose logs caddy.

#3. Configurer votre établissement

Récupérez votre lien de configuration privé depuis le serveur :

docker compose exec app gradepush-setup

Ouvrez ce lien dans votre navigateur. Si vous avez utilisé le script de préparation, vous pouvez aussi utiliser le lien qu’il a affiché. Gardez ce lien privé.

Indiquez le nom de l’établissement, créez la GitHub App avec l’assistant, puis connectez-vous avec GitHub. Ce premier utilisateur devient administrateur de l’établissement et opérateur de l’instance.

Poursuivez avec Connecter GitHub, puis créez votre première classe.

#Préserver votre installation

Conservez le fichier .env et les volumes PostgreSQL, GradePush et Caddy. Ne supprimez jamais les volumes lors d’un redémarrage ou d’une mise à jour habituelle.

Configurez les sauvegardes avant d’inviter de vrais étudiants. Utilisez une installation par établissement.