Utilisation des paramètres cachés du site

Documentation Auto-hébergement
, ,
1

:bookmark: Ceci est un guide #comment faire sur les paramètres de site cachés, comment les activer et pourquoi vous pourriez vouloir les ajuster.

:person_raising_hand: Niveau d’utilisateur requis : Administrateur
:warning: Important : L’accès à la console est requis pour certaines étapes.

Dans Discourse, les paramètres de site cachés font référence aux options de configuration qui ne sont pas facilement visibles ou accessibles via l’interface standard du tableau de bord d’administration. Ces paramètres font partie de la configuration backend qui peut contrôler diverses fonctionnalités avancées ou potentiellement impactantes du site.

Ces paramètres cachés sont livrés avec des valeurs par défaut préconfigurées, qui sont définies pour garantir des performances et une sécurité optimales basées sur des cas d’utilisation courants et les meilleures pratiques.

Les paramètres cachés sont dissimulés de l’interface de paramètres par défaut pour éviter une mauvaise configuration accidentelle par les administrateurs qui ne comprendraient pas pleinement leurs implications. Ils sont destinés aux :

  • Administrateurs qui ont une compréhension approfondie du fonctionnement interne de Discourse.
  • Cas spécifiques où une configuration de site inhabituelle ou très spécifique est nécessaire.
  • Fonctionnalités de test ou expérimentales qui ne sont pas encore prêtes pour une utilisation générale.

Les administrateurs qui souhaitent modifier les paramètres cachés le font généralement parce que la configuration par défaut ne correspond pas parfaitement à leurs besoins.

:warning: Notes importantes sur les paramètres cachés :

L’ajustement des paramètres de site cachés dans Discourse peut entraîner divers problèmes tels que des vulnérabilités de sécurité, un impact négatif sur les performances, une dégradation de l’expérience utilisateur ou une perte de données si cela n’est pas fait avec soin !

Les paramètres de site cachés ne doivent être modifiés que par des administrateurs Discourse compétents. Avant de modifier un paramètre, assurez-vous de comprendre ce qu’il fait et les implications du changement. Dans la mesure du possible, mettez en œuvre des changements de configuration importants dans un environnement de staging ou de développement. Avant d’apporter des changements généraux ou critiques, assurez-vous que les sauvegardes sont à jour pour restaurer l’état du forum en cas de problème.

Comment modifier les paramètres de site cachés

Option 1 : Console Rails

Pour modifier les paramètres de site cachés, vous devez généralement utiliser la console Rails, un outil en ligne de commande qui vous permet d’interagir directement avec le backend de votre installation Discourse. Pour ajuster les paramètres via la console Rails, vous pouvez suivre ces étapes :

  1. Accéder à la console Rails :

    cd /var/discourse
./launcher enter app
rails c

  2. Modifier un paramètre :

    SiteSetting.nom_de_votre_parametre = nouvelle_valeur

Remplacez nom_de_votre_parametre par le nom du paramètre que vous souhaitez modifier, et nouvelle_valeur par la valeur que vous souhaitez définir.

  1. Quitter la console :

    exit

Option 2 : Configuration des variables d’environnement dans app.yml

Vous pouvez également utiliser des variables d’environnement pour ajuster les paramètres de site cachés. Le fichier app.yml est un fichier de configuration utilisé dans les déploiements basés sur Docker de Discourse. Il est généralement situé dans le répertoire /containers de votre installation Discourse. Voici comment ajouter ou modifier des variables d’environnement :

  1. Accéder au fichier app.yml :
    Ouvrez le fichier app.yml dans votre éditeur de texte préféré :

    nano /var/discourse/containers/app.yml

  2. Ajouter des variables d’environnement :
    Les variables d’environnement peuvent être configurées dans la section env du fichier app.yml. Elles suivent le modèle DISCOURSE_NOM_DU_PARAMETRE: valeur. Par exemple, pour définir le paramètre max_category_nesting sur 3 via une variable d’environnement, vous utiliseriez :

    env:
  DISCOURSE_MAX_CATEGORY_NESTING: 3

  3. Reconstruire le conteneur :
    Après avoir enregistré les modifications dans le fichier app.yml, reconstruisez le conteneur Docker de Discourse pour appliquer les changements :

    cd /var/discourse
./launcher rebuild app

Pourquoi activer les paramètres cachés

L’activation ou l’ajustement des paramètres de site cachés dans Discourse permet aux administrateurs de personnaliser en profondeur leur configuration de forum pour répondre à des exigences techniques spécifiques, améliorer les performances ou garantir la sécurité et la conformité, soutenant ainsi une expérience utilisateur et une efficacité opérationnelle finement ajustées.

Exemples de paramètres de site cachés :

  • SQL de badges : L’activation de enable badge sql permet aux administrateurs de site de créer des requêtes SQL personnalisées pour les critères de badges, offrant une flexibilité dans l’attribution des badges basée sur des conditions complexes.
  • Suppression permanente de messages : L’activation de can permanently delete permet la suppression permanente des messages pour des raisons de conformité ou de confidentialité.
  • Paramètres de sauvegarde S3 : L’inclusion des téléchargements S3 dans les sauvegardes avec include_s3_uploads_in_backups peut être utilisée pour des stratégies de sauvegarde améliorées.
  • Limites de débit de recherche : L’ajustement des limites de débit de recherche avec des paramètres tels que rate_limit_search_user pour éviter le ralentissement dans les scénarios d’utilisation intensive.

FAQ

Q : Les paramètres cachés peuvent-ils être rendus visibles dans l’interface utilisateur ?
R : Les paramètres cachés dans Discourse ne sont pas directement configurables via l’interface utilisateur pour des raisons de sécurité et de complexité.

Q : Où puis-je trouver des informations sur chaque paramètre caché ?
R : Des informations détaillées sur chaque paramètre peuvent être trouvées dans le Guide de référence des paramètres de site cachés et le code source de Discourse, spécifiquement dans le fichier site_settings.yml sur le dépôt GitHub. Des informations supplémentaires sur certains paramètres sont également disponibles sur les forums Discourse Meta.

Q : Les modifications apportées via les variables d’environnement persistent-elles lors des mises à jour ?
R : Oui, si elles sont définies dans app.yml ou dans le profil permanent du système, ces paramètres persisteront lors des mises à jour, sauf s’ils sont remplacés par d’autres configurations.

Q : Comment savoir quels paramètres peuvent être contrôlés via les variables d’environnement ?
R : En règle générale, tout paramètre de site Discourse peut être préfixé par DISCOURSE_ et défini comme variable d’environnement.

Q : Est-il sûr de configurer des informations sensibles via des variables d’environnement ?
R : Les variables d’environnement sont généralement considérées comme sûres pour la gestion de la configuration. Cependant, assurez-vous qu’elles ne sont pas exposées dans des environnements partagés ou non sécurisés.

Q : Dois-je reconstruire si je bascule un paramètre de site ?
R : Dans la plupart des cas, le basculement d’un paramètre de site via la console Rails ne nécessite pas de reconstruire votre configuration Discourse. Ces changements prennent généralement effet immédiatement ou lors d’un rafraîchissement de votre instance. Cependant, certains paramètres spécifiques, en particulier ceux qui influencent les aspects fondamentaux du système, peuvent nécessiter un redémarrage ou une reconstruction pour que les changements prennent effet. Pour les modifications apportées dans le fichier app.yml, une reconstruction de votre conteneur Discourse est nécessaire pour que ces modifications prennent effet.

Q : Puis-je annuler facilement une modification de paramètre ?
R : Oui, la plupart des paramètres peuvent être annulés, sauf s’ils impliquent la suppression de données.

Ressources supplémentaires

8 « J'aime »