Ce qu’il fait
Transforme ce type de résultat :
(où votre serveur n’a pas réussi à récupérer le code source de la page et ne peut donc pas extraire les balises requises pour créer la onebox)
En ceci ! :
Il fournit simplement un chemin alternatif pour que la onebox puisse obtenir son code source de page afin de rechercher des métadonnées lorsque le serveur cible refuse votre connexion.
Il ne modifie en rien la façon dont la onebox traite ensuite le code source de la page pour trouver les métadonnées et afficher la boîte.
Il est conçu pour vous permettre de saisir les détails et les informations d’identification d’une API tierce afin de récupérer la page au lieu d’effectuer un appel HTTP normal directement vers la page cible.
Pourquoi
J’ai constaté que mes serveurs se voyaient refuser l’accès à un certain nombre de sites commerciaux, ce qui empêchait le rendu des oneboxes. Cela aide essentiellement à tirer parti de la fiabilité de l’API tierce, un peu comme un service de messagerie.
Pourquoi c’est rentable
Vous pouvez utiliser un VPS relativement peu coûteux tout en bénéficiant d’une fonctionnalité de onebox fiable, même si votre adresse IP ou votre agent utilisateur est en quelque sorte « blacklisté ».
Vous n’en avez pas besoin si
Vous générez correctement toutes vos cibles de contenu avec l’installation standard et tous les utilisateurs sont satisfaits.
Prérequis
Vous devez disposer d’un compte auprès d’une API tierce appropriée.
Paramètres
onebox assistant api base address: https://api.embed.rocks/api/
L’exemple ci-dessus utilise embed.rocks, mais à l’avenir, la prise en charge d’autres API pourrait être ajoutée. Cependant, embed.rocks offre actuellement un bon rapport qualité-prix.
onebox assistant api base query: ?url=
onebox assistant api options: &skip=article,description,oembed,imextra&include=source
onebox assistant api page source field: source
Vous devrez également saisir votre clé API fournie par embed.rocks.
Voir l’exemple ci-dessous
Ce paramètre vous permet d’ignorer la prérecherche (pour vérifier si le crawl direct retourne un résultat) et d’utiliser l’API dès le départ.
par défaut DÉSACTIVÉ
Je recommande de définir ce paramètre sur VRAI.
Bien sûr, cela est plus coûteux, mais donne souvent de meilleurs résultats, car il existe des cas où la prérecherche est redirigée vers la mauvaise page parce que vous n’êtes pas considéré comme fiable.
Informations de support
Rappelez-vous, si vous avez déjà tenté de créer une onebox pour un lien, le noyau Discourse mettra en cache le résultat.
Vous pouvez ajouter une chaîne de requête aléatoire à la fin pour contourner le cache : https://mylink.com/todaynews?random=random
Vous pouvez également vérifier que l’API répond avec, par exemple :
curl -X GET "https://api.embed.rocks/api/?url=https%3A%2F%2Fnews.bbc.co.uk%0A&skip=article,description,oembed,imextra&include=source" -H "x-api-key: %%%votre-clé-api%%%"
Vous devez encoder en URL le site que vous appelez (la valeur du paramètre url) en utilisant un site comme celui-ci (non garanti !).
Limitations connues
-
Il a été testé uniquement avec un fournisseur pour le moment et n’a pas été testé sur d’autres. Ce fournisseur est https://embed.rocks (avec qui je n’ai aucune affiliation). Je suis prêt à envisager de prendre en charge davantage de services si le travail est parrainé.
-
Le monkey patching est effectué au niveau de la méthode. Cela remplace plus de code que nécessaire, ce qui augmente le risque que le plugin se brise après une mise à jour du noyau. Cependant, je ne pense pas qu’il y ait un moyen de minimiser cela davantage ?
Comment installer les plugins
Consultez le guide ici : Install plugins on a self-hosted site
Ce dépôt est : https://github.com/merefield/discourse-onebox-assistant
https://github.com/merefield/discourse-onebox-assistant
Tous les retours sont les bienvenus. Veuillez mettre une :étoile: sur GitHub si vous le trouvez utile.