J'écris une courte documentation pour les admins des forums Discourse que j'ai aidé à configurer. Est-ce que j'oublie quelque chose ?

J’ai configuré des forums Discourse pour plusieurs amis/associations. J’aimerais qu’ils soient plus autonomes dans l’administration, de sorte que j’aie moins de chances d’intervenir moi-même.

Ils utilisent Discourse en tant qu’utilisateurs et co-administrateurs depuis des mois, voire des années. Ce ne sont pas des « nouveaux administrateurs », mais ils manquent de connaissances approfondies sur la façon de maintenir Discourse au quotidien (au-delà des bases de la modération) et sur ce qu’il faut savoir en tant qu’administrateur, et en cas de problèmes techniques, car j’étais toujours là pour m’occuper de ces choses.

Je serai toujours disponible à l’avenir, mais l’objectif est de leur permettre de suivre et de résoudre eux-mêmes les problèmes les plus courants.

Voici ce que j’ai écrit jusqu’à présent (traduit automatiquement en anglais car mon texte sera rédigé en français, donc ne faites pas attention si certaines phrases sont étranges) :


Mises à jour

Via l’interface web

Effectuez les mises à jour lorsqu’un smiley rouge mécontent apparaît dans le panneau d’administration (cela signifie qu’une mise à jour importante doit être appliquée).
Les mises à jour se font via :
https://tonforum.fr/admin/upgrade

Elles se font parfois en deux étapes : vous devez d’abord mettre à jour « Docker_Manager » avant de pouvoir mettre à jour le reste :

Via la ligne de commande

Parfois, une mise à jour doit être effectuée via la ligne de commande (la page d’administration de Discourse l’indiquera explicitement si nécessaire).

  1. Connectez-vous au serveur via SSH
  2. Reconstruisez le forum (une reconstruction met toujours à jour Discourse) en utilisant la commande suivante :
  3. /var/discourse/launcher rebuild app
    
  4. De temps en temps, une fois que vous avez confirmé que le forum fonctionne correctement, il peut être utile de supprimer les images Docker inutilisées (restes des mises à jour précédentes) pour libérer de l’espace disque :
    /var/discourse/launcher cleanup
    

Emplacement des fichiers importants sur le serveur

app.yml

Contient la configuration du serveur et la liste des plugins installés. Très utile si vous avez besoin de migrer le forum vers un autre serveur ou d’appliquer certaines configurations (par exemple, déplacer les téléchargements et les sauvegardes vers un autre disque). Il est situé ici :

/var/discourse/containers/app.yml

mail-receiver.yml

Contient la configuration du logiciel qui permet de recevoir les réponses par e-mail et de les publier sur le forum. Il est situé ici :

/var/discourse/containers/mail-receiver.yml

Sauvegardes (Backups)

Les fichiers de sauvegarde sont stockés ici :

/var/discourse/shared/standalone/backups/default

Pages importantes dans l’administration du forum

Quelques pages qui peuvent être utiles :robot:

Thèmes et composants

Ils incluent le CSS et le HTML personnalisés :

https://tonforum.fr/admin/config/customize/themes

Journaux (Logs)

E-mail

Utile pour le débogage :

https://tonforum.fr/admin/email-logs

Actions du personnel (Staff actions)

Très utile. Il conserve un enregistrement de (presque) toutes les modifications des paramètres du site et des autres actions effectuées par les modérateurs et les administrateurs.

https://tonforum.fr/admin/logs/staff_action_logs

Journaux d’erreurs (Error logs)

Peut fournir des indices lorsqu’un problème n’est pas évident :

https://tonforum.fr/logs/

Sauvegardes (Backups)

Pour modifier la fréquence des sauvegardes et le nombre maximal de sauvegardes, les visualiser ou les télécharger :

https://tonforum.fr/admin/backups

Ressources

https://meta.discourse.org
Support officiel. N’hésitez pas à y publier ; les membres de la communauté et les développeurs sont généralement très serviables.


Voyez-vous des choses qui pourraient être ajoutées/supprimées ? Je pense que je peux supprimer la partie /logs/, car elle est très, très rarement utile. Je ne suis même pas sûr d’y avoir trouvé des informations utiles en de nombreuses années d’administration de quelques instances.

10 « J'aime »

Quelques points que je voudrais clarifier.

L’un est, au moment d’essayer une mise à jour via l’interface web, sachez que la mise à jour peut échouer et que votre forum peut être hors service. Soyez prêt.

L’autre est, si votre hôte devient inaccessible ou corrompu, vous aurez besoin des fichiers de sauvegarde et des fichiers yml. Vous devrez les avoir déjà mis en lieu sûr sur un système séparé.

Pour combiner les deux : faites toujours une sauvegarde et téléchargez la sauvegarde avant d’essayer une mise à jour.

3 « J'aime »

Bonjour Ed, points très valables. Un membre a créé un script pour sauvegarder sur un autre système il y a quelque temps, si je me souviens bien. Il faudra faire une recherche et vérifier.

Voici un extrait du message initial. Canapin a une bonne réponse avec un lien vers la sauvegarde sur Google Drive/Dropbox également.

@Canapin avec l’application de reconstruction du lanceur, ne doit-elle pas être exécutée comme

./launcher r build app

C’est juste la façon dont j’ai l’habitude de l’exécuter à partir d’autres documents ici sur le site. Comme j’ai appris, il y a souvent plusieurs façons de faire les choses. Lol

Bonne rédaction, pratique.

1 « J'aime »

Mais puisque vous feriez cd /var/discourse avant cela, ./ ferait référence à ce répertoire, donc le chemin de launcher est essentiellement /var/discourse/launcher, non ?

Je n’étais pas au courant de cela. Je l’ai juste utilisé conformément à d’autres tutoriels sur Discourse. Mais cela a du sens. Merci.

Je me demande s’il vaut la peine d’ajouter quelques conseils d’escalade ? Si la personne qui lit le document ne sait pas comment se connecter en ssh à l’hôte, pour enquêter ou réparer, qui le peut ? Peut-être un conseil sur la façon de poser des questions ici sur meta, peut-être aussi un conseil sur l’utilisation de ask.

4 « J'aime »

C’est bon à savoir. Je ne connaissais que le téléchargement de la sauvegarde créée par le forum lui-même.

1 « J'aime »

Merci pour votre aide !

J’ai ajouté ceci au début de mon guide :

Assurez-vous d’être préparé à toute situation

Il est fortement recommandé, en plus des sauvegardes locales (enregistrées sur le même serveur que le forum), d’avoir une copie de ces sauvegardes sur un autre serveur ou dans le cloud[1].
[1:1] : Si j’ai installé votre forum, vos sauvegardes sont automatiquement copiées sur mon Google Drive, mais idéalement à l’avenir elles devraient être sauvegardées sur un espace dont vous êtes responsable. On en parlera un jour :smile:

Il est également utile de conserver une copie du fichier /var/discourse/containers/app.yml dans un endroit sûr[2]. Ce fichier optionnel sert en cas de réinstallation du forum ou de migration vers un autre serveur.

[2:1] : Il contient le nom d’utilisateur et le mot de passe du serveur de messagerie ainsi que l’email de l’administrateur (le mien, en fait).

En cas de doute sérieux sur quoi que ce soit, contactez-moi (canapin@gmail.com).

Ajouté ceci dans la section mise à jour :

:information_source: Avant de faire une mise à jour, il est fortement recommandé de télécharger la dernière sauvegarde de votre forum.

Ajouté ceci :

Que faire si le forum ne fonctionne plus ?

Reconstruire le forum résout beaucoup de problèmes et se fait avec la même commande qu’une mise à jour en ligne de commande :

/var/discourse/launcher rebuild app

Et si le forum ne fonctionne toujours pas après une reconstruction ?

Demandez-moi (canapin@gmail.com) ou postez sur le forum de support officiel.

J’ai aussi mentionné ask.discourse.org à la fin du guide.

Ressources

https://meta.discourse.org : support officiel, n’hésitez pas à y poster — les membres de la communauté et les développeurs sont très serviables
https://ask.discourse.com : un chatbot entraîné sur le support et les données de Discourse, étonnamment efficace pour répondre aux questions (oui, vraiment)

Texte intégral

Make sure you’re prepared for any situation

It is strongly recommended, in addition to local backups (saved on the same server as the forum), to have a copy of these backups on another server or in the cloud[1:2].

It is also useful to keep a copy of the file /var/discourse/containers/app.yml in a secure place[2:2]. This optional file is used in case of a forum reinstallation or a migration to another server.

If there is any serious doubt about anything, contact me (canapin@gmail.com).

Updates

:information_source: Before doing an update, it is strongly recommended to download the latest backup of your forum.

Via the interface

Do updates when there is an unhappy red smiley in the admin (it means there is an important update to do).
Updates are done via https://yourforum.com/admin/upgrade

They are sometimes done in two steps: you first need to update “Docker_Manager” before being able to upgrade the rest:

Via the command line

Sometimes, an update must be done via the command line (the Discourse admin page will say so if needed).

  1. Connect to the server via SSH
  2. Rebuild the forum (a rebuild always updates Discourse) using the following command:
  3. /var/discourse/launcher rebuild app
    
  4. From time to time, after making sure the forum works correctly, it can be useful to remove unused Docker images (leftovers from previous upgrades) to free disk space:
    /var/discourse/launcher cleanup
    

What to do if the forum no longer works?

Rebuilding the forum fixes many problems and is done with the same command as a command-line update:

/var/discourse/launcher rebuild app

Je pense que c’est assez bien maintenant et que je n’oublie rien d’important :slight_smile:


  1. If I installed your forum, your backups are automatically copied to my Google Drive, but ideally in the future they should be saved on a space you are responsible for. We’ll talk about it one day :smile: ↩︎ ↩︎ ↩︎

  2. It contains the mail server username and password as well as the top-level administrator email (mine, actually). ↩︎ ↩︎ ↩︎

3 « J'aime »

Si cela fonctionne, ce serait une meilleure recommandation (plus simple) que la version habituelle en deux lignes (qui en comptait trois auparavant, nous pouvons donc continuer la tendance).

Les deux fonctionnent.

Si vous êtes dans le répertoire ./ C’est nécessaire car l’emplacement du lanceur n’est pas dans le chemin (path).

Linux exige que si une commande n’est pas dans le chemin (path), vous donniez son chemin complet afin qu’il n’y ait aucune erreur sur le fichier que vous vouliez exécuter.

3 « J'aime »

Oui, mais souvent vous pourriez faire plusieurs choses, par exemple un nettoyage d’abord. Auquel cas, se placer d’abord avec cd pourrait être plus bref.

3 « J'aime »

Je suis d’accord et j’ai mis le sujet en favori pour une utilisation future, merci

Voici donc le guide complet traduit automatiquement :

S’assurer que vous êtes préparé à toute éventualité

Il est fortement recommandé, en plus des sauvegardes locales (stockées sur le même serveur que le forum), d’avoir une copie de ces sauvegardes sur un autre serveur ou dans le cloud[1].

Il est également utile de conserver une copie du fichier /var/discourse/containers/app.yml dans un endroit sûr[2]. Ce fichier optionnel est utile en cas de réinstallation du forum ou de migration vers un autre serveur.

Si vous avez des doutes sérieux sur quoi que ce soit, contactez-moi.

Mises à jour

:information_source: Avant de faire une mise à jour, il est fortement recommandé de télécharger la dernière sauvegarde de votre forum.

Via l’interface

Faites les mises à jour lorsqu’il y a un smiley rouge mécontent dans l’administration (cela signifie qu’il y a une mise à jour importante à faire).
Les mises à jour se font via https://tonforum.fr/admin/upgrade

Elles se font parfois en deux étapes : il faut d’abord mettre à jour “Docker_Manager” avant de pouvoir mettre à jour le reste :

Via la ligne de commande

Parfois une mise à jour doit se faire via la ligne de commande (la page d’administration de Discourse le signalera si c’est nécessaire).

  1. Connectez-vous au serveur via SSH
  2. Reconstruisez le forum (une reconstruction met toujours à jour Discourse) avec la commande suivante :
  3. /var/discourse/launcher rebuild app
    
  4. De temps en temps, après vous être assuré que le forum fonctionne correctement, il peut être utile de supprimer les images Docker inutilisées (les restes des mises à jour précédentes) pour libérer de l’espace disque :
    /var/discourse/launcher cleanup
    

Que faire si le forum ne fonctionne plus ?

Reconstruire le forum règle beaucoup de problèmes et se fait avec la même commande qu’une mise à jour via la ligne de commande :

/var/discourse/launcher rebuild app

Et si le forum ne fonctionne toujours pas après une reconstruction ?

Demandez-moi ou postez sur le forum de support officiel.

Emplacement des fichiers importants sur le serveur

app.yml

Il contient la configuration du serveur et la liste des plugins installés. Très utile si le forum doit être déplacé sur un autre serveur, ou pour certaines configurations (déplacer les uploads et les sauvegardes sur un autre disque, par exemple). Il se trouve ici :

/var/discourse/containers/app.yml

mail-receiver.yml

Il contient la configuration du logiciel qui permet de recevoir et publier sur le forum les réponses par email. Il se trouve ici :

/var/discourse/containers/mail-receiver.yml

Sauvegardes (Backups)

Les fichiers de sauvegarde se trouvent ici :

/var/discourse/shared/standalone/backups/default

Pages importantes dans l’administration du forum :

Pages qui peuvent être utiles :technologist:

Thèmes et composants

Ils contiennent, entre autres, du CSS et du HTML personnalisé :

https://tonforum.fr/admin/config/customize/themes

Journaux (Logs)

Email

Utile pour le débogage :

https://tonforum.fr/admin/email-logs

Actions du personnel (Staff actions)

Très utile. Il garde une trace de (presque) tous les changements de paramètres du site et des autres actions des modérateurs et administrateurs.

https://tonforum.fr/admin/logs/staff_action_logs

Journaux d’erreurs (Error logs)

Peut donner des indices lorsqu’il y a un problème dont la cause n’est pas évidente.

https://tonforum.fr/logs/

Sauvegardes (Backups)

Pour modifier la fréquence et le nombre maximum de sauvegardes, les visualiser, ou les télécharger :

https://tonforum.fr/admin/backups

Ressources

https://meta.discourse.org : support officiel, n’hésitez pas à y poster, les membres et les développeurs sont heureux d’aider
https://ask.discourse.com : un agent conversationnel entraîné sur le support et les données de Discourse, étonnamment efficace pour répondre aux questions (oui, vraiment)


  1. Si j’ai installé votre forum, vos sauvegardes sont automatiquement copiées sur mon Google Drive, mais idéalement à l’avenir elles devraient être sauvegardées sur un espace dont vous êtes responsable. On en parlera un jour :smile: ↩︎

  2. Il contient l’identifiant et le mot de passe du serveur mail, ainsi que l’email administrateur (le mien, en fait). ↩︎

3 « J'aime »