Połącz swoją wiki Outline (self-hosted lub chmurę getoutline.com) z ReplyRabbit, aby szkice AI mogły korzystać z bazy wiedzy Twojego zespołu. Strony Outline domyślnie pozostają wewnętrzne: służą do pomocy w pisaniu odpowiedzi, ale nigdy nie są pokazywane ani linkowane klientom, chyba że wyraźnie oznaczysz strony jako widoczne dla klientów.
Użyj tego, gdy Twój zespół przechowuje wiedzę w Outline zamiast w module Bazy wiedzy FreeScout. Jeśli używasz modułu FreeScout, zobacz Jak podłączyć swoją bazę wiedzy FreeScout. Outline dobrze współpracuje z ReplyRabbit, ponieważ:
Dostępem do stron zarządzasz przez uprawnienia Outline, a ReplyRabbit odczytuje tylko to, do czego ma dostęp Twój użytkownik usługi.
Strony domyślnie pozostają poza odpowiedziami do klientów, więc Twoje wewnętrzne runbooki i informacje o dostawcach nigdy nie wyciekną do szkiców.
Jedna synchronizacja dziennie plus ręczne "Sync now" utrzymuje ReplyRabbit na bieżąco bez webhooków w czasie rzeczywistym.
Jeśli Twój Outline znajduje się za proxy SSO (Cloudflare Access, Authentik, oauth2-proxy), może być konieczne dostosowanie ustawień proxy lub użycie wewnętrznego adresu Outline.
Ścieżka konfiguracji
Utwórz użytkownika usługi
W swoim dostawcy tożsamości (systemie SSO) utwórz dedykowane konto użytkownika, takie jak replyrabbit@yourcompany.com. To konto staje się "oczami" ReplyRabbit wewnątrz Outline.
Zaloguj się raz do Outline
Niech ten użytkownik usługi zaloguje się do Outline przez Twój normalny przepływ SSO. Konto musi istnieć w Outline, zanim będzie mogło utworzyć klucz API.
Przyznaj dostęp w Outline
Udostępnij kolekcje lub strony Outline, których ReplyRabbit ma używać z tym użytkownikiem usługi. Udostępnij je w taki sam sposób, w jaki przyznajesz dostęp do dowolnego narzędzia, takiego jak Onyx lub wewnętrzne wiki. Nie nadawaj użytkownikowi uprawnień administratora; zwykły członek z dostępem do określonych kolekcji wystarczy.
Utwórz klucz API
Zaloguj się do Outline jako ten użytkownik usługi. Otwórz Ustawienia, a następnie API i dostęp w sekcji Konto i kliknij Nowy klucz API. Older self-hosted versions call this page "API" or "API and Apps".The screenshots below show Outline's English interface; labels may be translated in your Outline workspace.Osobiste klucze API znajdują się w ustawieniach Twojego konta, a nie w ustawieniach obszaru roboczego.Nazwij klucz ReplyRabbit, wpisz read w Zakresy, i ustaw Wygaśnięcie na "Bez wygaśnięcia". Domyślnie Outline ustawia 30 dni, a synchronizacja zatrzymuje się, gdy klucz wygaśnie. Kliknij Utwórz i skopiuj klucz.Zakres odczytu obejmuje wszystko, czego potrzebuje ReplyRabbit, i blokuje wszelkie zapisy.
Otwórz ustawienia ReplyRabbit
W FreeScout przejdź do ustawień skrzynki i znajdź "Źródła dokumentacji" w sekcji ReplyRabbit.
Dodaj źródło Outline
Kliknij "Dodaj źródło Outline". Wklej adres URL Outline (na przykład, https://wiki.company.com lub adres URL swojego obszaru roboczego getoutline.com) oraz klucz API, który właśnie skopiowałeś.
Wybierz, co synchronizować
Po wklejeniu adresu URL i klucza kliknij "Test connection". Pokazuje, do którego użytkownika Outline należy klucz, więc możesz sprawdzić, czy to klucz użytkownika usługi, a nie osoby. Następnie wybierz albo "Everything this key can read" (zalecane, zgodne z własnymi uprawnieniami Outline), albo "Only specific collections or pages" i zaznacz je w drzewie lub wklej link do kolekcji albo strony.
Synchronizuj i testuj
Zapisz swoje ustawienia. Zapisanie nowego źródła lub zmiana jego adresu, klucza bądź zakresu natychmiast rozpoczyna synchronizację. Następnie synchronizuje się codziennie, a opcja „Synchronizuj teraz” na źródle uruchamia ją, kiedy chcesz. Potem przetestuj szkic, aby potwierdzić, że ReplyRabbit może używać treści.
Prywatność i bezpieczeństwo
Strony Outline są domyślnie wewnętrzne. Tekst strony jest przechowywany w FreeScout i wysyłany do Twojego dostawcy AI oraz dostawcy embeddings (zwykle tego samego, którego używasz do szkiców). Strony nigdy nie są cytowane słowo w słowo ani linkowane w odpowiedziach do klientów, chyba że włączysz "Customers can see these pages" dla źródeł, w których każda wybrana strona jest bezpieczna do udostępnienia.
Włączaj "Customers can see these pages" tylko jeśli:
Każda wybrana strona otwiera się i wyświetla poprawnie bez wymagania logowania.
Treść jest odpowiednia dla klientów (bez wewnętrznych szczegółów operacyjnych, informacji o dostawcach ani instrukcji dla personelu).
Udostępniaj tylko to, co potrzebne. Jeśli udostępnisz ReplyRabbit całą przestrzeń roboczą Outline, wszystko, co użytkownik usługi może odczytać, stanie się dostępne dla AI i zostanie zapisane w FreeScout. Udostępniaj raczej konkretne kolekcje lub strony, tak samo jak ograniczałbyś dostęp dla każdego innego narzędzia.
Obsługa wewnętrznych adresów sieciowych
Jeśli Twój Outline działa na prywatnym adresie IP lub wewnętrznej nazwie hosta (takiej jak outline.internal.company.com), włącz "Outline jest w naszej sieci wewnętrznej" podczas dodawania źródła. Pozwala to ReplyRabbit na:
Osiągaj prywatne adresy IP (10.x.x.x, 192.168.x.x, 172.16.x.x do 172.31.x.x)
Rozwiązuj wewnętrzne nazwy hostów przez DNS swojej sieci
Używaj HTTP (niezaszyfrowanego) tylko na prywatnych adresach
Publiczne adresy nadal wymagają HTTPS, nawet przy włączonej tej opcji. Jeśli Twój Outline używa HTTPS z certyfikatem z Twojego wewnętrznego CA, magazyn zaufania serwera FreeScout musi zawierać ten certyfikat CA.
Obsługa proxy SSO
Własne logowanie Outline: Jeśli Twój zespół loguje się do Outline przez Google, Microsoft, Slack, OIDC lub linki e-mail zarządzane przez sam Outline, nie jest potrzebna dodatkowa konfiguracja. Klucz API omija proces logowania.
Proxy SSO przed Outline: Jeśli coś takiego jak Cloudflare Access, Authentik lub oauth2-proxy stoi przed Outline i przechwytuje żądania, ReplyRabbit nie może dotrzeć do API. Zobaczysz komunikat o błędzie "Coś przed Outline prosi o zalogowanie".
Napraw to, wybierając jedno z tych podejść:
Pomiń proxy dla /api/ tylko. Skonfiguruj proxy, aby serwer FreeScout mógł osiągnąć /api/* bezpośrednio, z pominięciem sprawdzania logowania. Większość proxy obsługuje reguły obejścia oparte na ścieżce lub adresie IP. Sprawdź dokumentację swojego proxy, aby znaleźć to ustawienie.
Użyj wewnętrznego adresu Outline. Jeśli Twój Outline ma prywatny adres IP lub wewnętrzną nazwę hosta, która omija proxy, użyj jej w ReplyRabbit. Będziesz musiał włączyć "Outline jest w naszej sieci wewnętrznej" dla prywatnych adresów.
Jeśli nie możesz ominąć proxy, skontaktuj się z administratorem, aby włączył jedną z tych opcji dla serwera ReplyRabbit.
Rozwiązywanie problemów
"Outline ogranicza liczbę żądań. Ponowna próba nastąpi przy następnym zaplanowanym uruchomieniu." Outline poprosił ReplyRabbit o zwolnienie tempa. Synchronizacja już czekała tak długo, jak prosił Outline, i ponowiła próbę, a Outline nadal był zajęty, więc spróbuje ponownie przy następnej codziennej synchronizacji. Strony, które zostały już zaindeksowane, pozostają w międzyczasie dostępne. Aby ponowić szybciej, kliknij ponownie "Sync now" za kilka minut.
"Ta wersja Outline jest zbyt stara. Zaktualizuj Outline do wersji 0.87 lub nowszej, a następnie ponownie przetestuj połączenie." Twojemu samodzielnie hostowanemu Outline brakuje metody API potrzebnej ReplyRabbit. Uaktualnij go do wersji 0.87 lub nowszej, a następnie kliknij ponownie "Test connection".
"To źródło jest wyłączone. Włącz "Użyj tego źródła", zapisz i zsynchronizuj je." Źródło Outline jest wyłączone. Zaznacz "Użyj tego źródła", zapisz ustawienia, a następnie kliknij "Synchronizuj teraz".
"Outline odrzucił ten klucz API." Klucz API jest nieprawidłowy lub został unieważniony. Wygeneruj nowy klucz w Outline Settings > API za pomocą read zakres.
"Nie można połączyć się z Outline. Sprawdź adres URL i spróbuj ponownie." Adres URL jest nieprawidłowy lub ReplyRabbit nie może połączyć się z serwerem. Potwierdź:
Adres URL jest poprawny (na przykład, https://wiki.company.com, a nie stronę główną ani konkretną stronę).
Jeśli Outline działa na prywatnym adresie IP lub wewnętrznej nazwie hosta, włącz "Outline jest w naszej sieci wewnętrznej".
Jeśli Outline znajduje się za proxy SSO, sprawdź sekcję "Obsługa proxy SSO" powyżej.
"Najpierw wprowadź klucz API Outline." Wklej klucz API w polu przed testowaniem lub synchronizacją.
"Źródło wiedzy Outline jest funkcją planu Team." Twój obecny plan nie obejmuje integracji z Outline. Uaktualnij do planu Team, aby używać tej funkcji.
Minimalna wersja Outline
Samodzielnie hostowany Outline wymaga wersji 0.87 lub nowszej (testowano na 1.0 do 1.10). Starszym wersjom brakuje części API, którego ReplyRabbit używa do odczytu drzew stron. Test połączenia sprawdza brakujące API drzewa stron. Jeśli zgłosi starą wersję, najpierw zaktualizuj Outline.
Wersja w chmurze pod adresem getoutline.com jest zawsze aktualna i obsługiwana.
Zmiana źródeł później
Przejście do publicznej witryny dokumentacji: Jeśli później chcesz przejść na publiczną stronę internetową (zamiast utrzymywać Outline wewnętrznie), dodaj źródło dokumentacji Website i wyłącz lub usuń źródło Outline, gdy będziesz gotowy. Oba mogą działać równolegle podczas przenoszenia. Usunięcie źródła Outline ukrywa jego strony przed szkicami i usuwa je z pamięci ReplyRabbit.
Obniżanie planu z Team: Jeśli obniżysz plan z Team, Twoje źródła Outline i ustawienia API pozostaną w bazie danych, ale zsynchronizowane strony zostaną usunięte i staną się niedostępne do pobierania szkiców. Konfiguracja źródeł jest zachowana, więc po ponownym przejściu na Team możesz je zsynchronizować ponownie bez ponownego wpisywania URL i klucza API.