Conecte seu wiki do Outline (auto-hospedado ou nuvem getoutline.com) ao ReplyRabbit para que os rascunhos de IA possam usar a base de conhecimento da sua equipe. As páginas do Outline permanecem internas por padrão: usadas para ajudar a escrever respostas, mas nunca exibidas ou vinculadas aos clientes, a menos que você marque explicitamente páginas como visíveis para o cliente.
Use isto quando sua equipe mantém o conhecimento no Outline em vez do módulo Base de Conhecimento do FreeScout. Se você usa o módulo do FreeScout, consulte Como conectar sua Base de Conhecimento do FreeScout. O Outline funciona bem junto com o ReplyRabbit porque:
Você controla o acesso às páginas via permissões do Outline, e o ReplyRabbit lê apenas o que seu usuário de serviço pode acessar.
As páginas ficam fora das respostas aos clientes por padrão, então seus runbooks internos e informações de fornecedores nunca vazam para os rascunhos.
Uma sincronização por dia mais o "Sincronizar agora" manual mantém o ReplyRabbit atualizado sem webhooks em tempo real.
Se seu Outline estiver atrás de um proxy SSO (Cloudflare Access, Authentik, oauth2-proxy), talvez seja necessário ajustar as configurações do proxy ou usar o endereço interno do Outline.
Caminho de configuração
Criar um usuário de serviço
No seu provedor de identidade (seu sistema SSO), crie uma conta de usuário dedicada como replyrabbit@yourcompany.com. Esta conta se torna os "olhos" do ReplyRabbit dentro do Outline.
Entre uma vez no Outline
Faça esse usuário de serviço entrar no Outline por meio do seu fluxo SSO normal. A conta deve existir no Outline antes de poder criar uma chave de API.
Conceder acesso no Outline
Compartilhe as coleções ou páginas do Outline que você deseja que o ReplyRabbit use com esse usuário de serviço. Compartilhe da mesma forma que você concederia acesso a qualquer ferramenta como Onyx ou wikis internas. Não torne o usuário um administrador; um membro comum com acesso a coleções específicas é suficiente.
Criar uma chave de API
Entre no Outline como esse usuário de serviço. Abra Configurações e depois API e Acesso em Account, e clique Nova chave de 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.As chaves de API pessoais ficam nas configurações da sua própria conta, não nas do espaço de trabalho.Nomeie a chave ReplyRabbit, digite read em Escopos, e defina Expiração para "No expiration". O padrão do Outline é 30 dias, e a sincronização para quando a chave expira. Clique Criar e copie a chave.O escopo de leitura cobre tudo o que o ReplyRabbit precisa e bloqueia qualquer gravação.
Abrir configurações do ReplyRabbit
No FreeScout, vá para as configurações da caixa de correio e encontre "Fontes de documentação" em ReplyRabbit.
Adicionar fonte do Outline
Clique em "Add Outline source". Cole sua URL do Outline (por exemplo, https://wiki.company.com ou a URL do seu workspace getoutline.com) e a chave de API que você acabou de copiar.
Escolha o que sincronizar
Depois de colar a URL e a chave, clique em "Testar conexão". Ela mostra a qual usuário do Outline a chave pertence, para que você possa verificar se é o usuário de serviço e não a chave de uma pessoa. Em seguida, escolha "Tudo o que esta chave pode ler" (recomendado, corresponde às próprias permissões do Outline) ou "Apenas coleções ou páginas específicas", e marque-as na árvore ou cole um link de coleção ou página.
Sincronizar e testar
Salve suas configurações. Salvar uma nova fonte, ou alterar seu endereço, chave ou escopo, inicia uma sincronização imediatamente. Depois disso, ela sincroniza diariamente, e "Sincronizar agora" na fonte executa uma quando você quiser. Em seguida, teste um rascunho para confirmar que o ReplyRabbit consegue usar o conteúdo.
Privacidade e segurança
As páginas do Outline são internas por padrão. O texto da página é armazenado no FreeScout e enviado ao seu provedor de IA e ao provedor de embeddings (geralmente o mesmo provedor que você usa para rascunhos). As páginas nunca são citadas palavra por palavra nem vinculadas nas respostas aos clientes, a menos que você ative "Os clientes podem ver estas páginas" para fontes em que todas as páginas selecionadas são seguras para compartilhar.
Ative "Os clientes podem ver estas páginas" apenas se:
Cada página selecionada abre e é exibida corretamente sem exigir login.
O conteúdo é adequado para clientes (sem detalhes de operações internas, informações de fornecedores ou instruções para a equipe).
Compartilhe apenas o necessário. Se você compartilhar todo o workspace do Outline com o ReplyRabbit, tudo o que o usuário do serviço puder ler ficará disponível para a IA e será armazenado no FreeScout. Compartilhe coleções ou páginas específicas, da mesma forma que você limitaria o acesso para qualquer outra ferramenta.
Lidando com endereços de rede internos
Se seu Outline rodar em um endereço IP privado ou nome de host interno (como outline.internal.company.com), ative "O Outline está na nossa rede interna" ao adicionar a fonte. Isso permite que o ReplyRabbit:
Acessar endereços IP privados (10.x.x.x, 192.168.x.x, 172.16.x.x a 172.31.x.x)
Resolver nomes de host internos via DNS da sua rede
Use HTTP (não criptografado) apenas em endereços privados
Endereços públicos ainda exigem HTTPS, mesmo com esta opção ativada. Se o seu Outline usa HTTPS com um certificado da sua própria CA interna, o repositório de confiança do servidor FreeScout deve incluir esse certificado da CA.
Lidando com proxies SSO
Login próprio do Outline: Se sua equipe faz login no Outline pelo Google, Microsoft, Slack, OIDC ou links de e-mail gerenciados pelo próprio Outline, nenhuma configuração extra é necessária. A chave de API contorna o fluxo de login.
Proxy SSO na frente do Outline: Se algo como Cloudflare Access, Authentik ou oauth2-proxy estiver na frente do Outline e interceptar solicitações, o ReplyRabbit não consegue acessar a API. Você verá uma mensagem de erro dizendo "Algo na frente do Outline está pedindo um login."
Corrija isso escolhendo uma destas abordagens:
Ignorar o proxy para /api/ apenas. Configure seu proxy para permitir que o servidor do FreeScout alcance /api/* diretamente sem a verificação de login. A maioria dos proxies oferece suporte a regras de bypass por caminho ou por IP. Consulte a documentação do seu proxy para encontrar a configuração.
Use o endereço interno do Outline. Se seu Outline tiver um IP privado ou nome de host interno que ignora o proxy, use isso no ReplyRabbit. Você precisará ativar "O Outline está na nossa rede interna" para endereços privados.
Se você não conseguir contornar o proxy, entre em contato com seu administrador para habilitar uma dessas opções para o servidor do ReplyRabbit.
Solução de problemas
"O Outline está limitando as requisições. Ele tentará novamente na próxima execução agendada." O Outline pediu ao ReplyRabbit para desacelerar. A sincronização já esperou o tempo que o Outline pediu e tentou novamente, e o Outline ainda estava ocupado, então tentará de novo na próxima sincronização diária. As páginas que já foram indexadas permanecem disponíveis enquanto isso. Para tentar novamente mais cedo, clique em "Sincronizar agora" novamente em alguns minutos.
"Esta versão do Outline é muito antiga. Atualize o Outline para 0.87 ou posterior e teste a conexão novamente." Seu Outline auto-hospedado não tem um método de API que o ReplyRabbit precisa. Atualize-o para a versão 0.87 ou posterior e clique em "Test connection" novamente.
"Esta fonte está desativada. Ative "Usar esta fonte", salve e sincronize." A fonte Outline está desativada. Marque "Usar esta fonte", salve as configurações e clique em "Sincronizar agora".
"O Outline rejeitou essa chave de API." A chave de API é inválida ou foi revogada. Gere uma nova chave em Configurações do Outline > API com o read escopo.
"Não foi possível acessar o Outline. Verifique a URL e tente novamente." A URL está errada, ou o ReplyRabbit não consegue alcançar o servidor. Confirme:
A URL está correta (por exemplo, https://wiki.company.com, não a página inicial nem uma página específica).
Se o Outline estiver em um IP privado ou nome de host interno, ative "O Outline está na nossa rede interna".
Se o Outline estiver atrás de um proxy SSO, verifique a seção "Lidando com proxies SSO" acima.
"Insira primeiro a chave de API do Outline." Cole a chave de API no campo antes de testar ou sincronizar.
"A fonte de conhecimento do Outline é um recurso do plano Team." Seu plano atual não inclui a integração com o Outline. Faça upgrade para o plano Team para usar este recurso.
Versão mínima do Outline
O Outline auto-hospedado precisa da versão 0.87 ou posterior (testado na 1.0 a 1.10). Versões mais antigas não têm parte da API que o ReplyRabbit usa para ler árvores de páginas. O teste de conexão verifica a API de árvore de páginas ausente. Se ele relatar uma versão antiga, atualize o Outline primeiro.
A versão em nuvem em getoutline.com está sempre atualizada e com suporte.
Alterando as fontes mais tarde
Mudando para um site de documentação público: Se você quiser depois mudar para um site público (em vez de manter o Outline interno), adicione uma fonte de documentação de Site e desative ou remova a fonte do Outline quando estiver pronto. Ambos podem funcionar lado a lado durante a migração. Remover uma fonte do Outline oculta suas páginas dos rascunhos e as exclui do armazenamento do ReplyRabbit.
Downgrade do Team: Se você fizer downgrade do plano Team, suas fontes do Outline e configurações de API permanecem no banco de dados, mas as páginas sincronizadas são excluídas e ficam indisponíveis para recuperação de rascunhos. A configuração da sua fonte é preservada, então quando você voltar ao Team, poderá sincronizá-las novamente sem reinserir a URL e a chave de API.