Jak připojit Confluence
ChatbotIQ čte Confluence Cloud přes rozhraní Atlassian API, ne procházením v prohlížeči. To má dva důvody:
- SSO není překážka. API tokeny Atlassian obcházejí SAML, takže funguje i wiki s vypnutým anonymním přístupem. Toto je doporučený způsob, jak indexovat Confluence.
- Synchronizace zůstává levná. Confluence u každé stránky hlásí číslo verze, takže opakovaná synchronizace načte jen stránky, které někdo skutečně upravil.
Pokud jste wiki dříve přidali jako webový zdroj, přepněte ji na zdroj typu Confluence. Získáte čistší obsah, hierarchii stránek ve vyhledávání a výrazně rychlejší aktualizace.
Než začnete
Sekce “Než začnete”Budete potřebovat:
- Web Confluence Cloud (
vas-web.atlassian.net). Self-hosted Data Center zatím podporován není. - Účet Atlassian, který vidí prostory, jež chcete indexovat.
- Roli administrátora nebo vlastníka ve workspace ChatbotIQ.
Nejprve si vytvořte servisní účet
Sekce “Nejprve si vytvořte servisní účet”Přečtěte si to dřív, než vytvoříte token. Je to rozdíl mezi bezpečným nastavením a takovým, které tiše vynáší interní stránky.
API token Atlassian dědí všechna oprávnění účtu, který ho vytvořil. Pokud token vytvoříte na svém administrátorském účtu, ChatbotIQ může číst každou stránku, kterou vidíte vy, včetně HR, právních a omezených prostorů. Pokud je bot veřejný, mohou se tyto stránky objevit v odpovědích.
Proto:
- Vytvořte vyhrazený účet Atlassian pro ChatbotIQ (například
chatbotiq@vase-firma.cz). - Dejte mu přístup pouze k prostorům, které chcete indexovat.
- Vytvořte API token na tomto účtu, ne na svém.
Krok 1: Vytvořte token s omezeným rozsahem
Sekce “Krok 1: Vytvořte token s omezeným rozsahem”Atlassian podporuje tokeny s omezeným rozsahem (scoped), které udělují jen vyjmenovaná oprávnění místo všeho, co účet umí. Použijte je.
-
Přejděte na API tokeny Atlassian.
-
Zvolte Create API token with scopes.
-
Vyberte svůj web Confluence.
-
Vyberte přesně tyto tři rozsahy a nic dalšího:
Rozsah K čemu je potřeba read:space:confluenceVýpis prostorů, abyste mohli vybrat, které indexovat read:page:confluenceVýpis stránek ve vybraných prostorech read:content-details:confluenceČtení obsahu stránek -
Nastavte datum expirace a poznamenejte si ho. Budete ho potřebovat v kroku 2.
-
Zkopírujte token. Atlassian ho zobrazí jen jednou.
Každý token Atlassian vyprší. Maximální životnost je 365 dní a trvalý token vytvořit nelze. Po expiraci se synchronizace zastaví. Zadejte datum expirace v dalším kroku a my vám dáme vědět, než k tomu dojde.
Krok 2: Připojte web
Sekce “Krok 2: Připojte web”- V ChatbotIQ otevřete Znalostní bázi a klikněte na Přidat zdroj.
- Zvolte Confluence.
- Vyplňte:
- Web Confluence:
https://vas-web.atlassian.net(nebo jen název webu) - E-mail účtu Atlassian: e-mail servisního účtu
- API token: token z kroku 1
- Datum expirace tokenu: z kroku 1
- Web Confluence:
- Klikněte na Připojit.
ChatbotIQ přihlašovací údaje okamžitě ověří. Pokud jsou špatné nebo rozsahy nestačí, uvidíte chybu hned, ne až prázdnou synchronizaci později.
Token se před uložením zašifruje a žádná obrazovka ani odpověď API ho už nikdy nezobrazí. Uvidíte pouze poslední čtyři znaky.
Krok 3: Vyberte prostory a spusťte synchronizaci
Sekce “Krok 3: Vyberte prostory a spusťte synchronizaci”Po připojení uvidíte všechny prostory, které token dokáže přečíst.
Vyberte jen ty prostory, ze kterých má bot odpovídat. Tento seznam je hlavní pojistka proti tomu, abyste zaindexovali víc, než jste chtěli. ChatbotIQ nečte nic mimo něj a omezení se vynucuje na serveru, ne jen v rozhraní.
Pojmenujte zdroj a klikněte na Spustit synchronizaci.
První synchronizace načte všechny stránky ve vybraných prostorech. U velkých wiki to chvíli trvá; průvodce můžete zavřít a synchronizace poběží na pozadí.
Co se indexuje
Sekce “Co se indexuje”U každé stránky ChatbotIQ ukládá název, obsah a její místo ve wiki:
- Hierarchie stránek se převede na drobečkovou navigaci (
Provoz > Runbooky > Runbook nasazení), což zlepšuje párování otázek se stránkami. - Skutečné URL stránek, takže odpovědi citují klikatelný odkaz na wiki.
- Datum poslední úpravy z Confluence, ne čas synchronizace.
Tabulky, bloky kódu a seznamy zůstávají zachovány. Přílohy a obrázky se zatím neindexují.
Udržování obsahu aktuálního
Sekce “Udržování obsahu aktuálního”Synchronizaci spusťte, kdykoli chcete načíst změny. Opakované synchronizace jsou levné: ChatbotIQ porovná číslo verze každé stránky v Confluence a znovu načte jen změněné stránky. Synchronizace nezměněné wiki nespotřebuje žádné indexovací kredity.
Stránky smazané, archivované nebo přesunuté mimo vybraný prostor se při další synchronizaci z odpovědí bota odstraní.
Řešení potíží
Sekce “Řešení potíží”„Confluence odmítlo přihlašovací údaje” Token vypršel nebo byl odvolán. Vytvořte nový a připojte se znovu. Pamatujte na maximum 365 dní.
„Tokenu chybí požadovaný rozsah” Tokenu chybí jeden ze tří rozsahů z kroku 1. Rozsahy nelze po vytvoření upravit, vytvořte proto nový token.
„Tento token nevidí žádné prostory” Servisní účet nemá přístup k žádnému prostoru. Přidejte ho v Confluence do oprávnění prostorů, které chcete indexovat.
V seznamu chybí prostor Servisní účet ho nevidí. Udělte mu v Confluence oprávnění k zobrazení daného prostoru.
Po synchronizaci chybí některé stránky Omezení stránek v Confluence platí i pro servisní účet. Stránka omezená pro tento účet je pro ChatbotIQ neviditelná, což je obvykle žádoucí.
„Podporovány jsou pouze weby Confluence Cloud”
Zadali jste něco jiného než adresu *.atlassian.net. Self-hosted Confluence Data Center zatím podporován není.