Como instalar o Wiki.js na Saplo (documentação da empresa)

Instruções de integração de novos funcionários no Google Docs, procedimentos em arquivos Word enviados por e-mail, palavras-passe de servidor num bloco de notas que só uma pessoa tem - todas as empresas em crescimento, mais cedo ou mais tarde, enfrentam esta confusão. Wiki.js é uma base de dados de conhecimento de código aberto com editor Markdown e WYSIWYG, controlo de versões de páginas e um motor de pesquisa incorporado, que podes instalar na tua própria Box em vez de pagar por mais uma conta na nuvem. Abaixo, mostramos-te como instalar o Wiki.js no Saplo, passo a passo.

Porquê o Wiki.js para a documentação da empresa

Documentos espalhados por discos, e-mails e blocos de notas pessoais apresentam o mesmo conjunto de problemas: falta de um local único onde um novo funcionário possa encontrar as instruções sozinho, em vez de perguntar aos colegas "onde está isto"; falta de histórico de alterações, porque um ficheiro Word substituído por uma segunda versão não indica quem, quando ou porquê alterou o conteúdo; e zero de pesquisa significativa, porque numa pilha de ficheiros no disco, pesquisa-se por nome, e não pelo conteúdo do documento. O Wiki.js mantém todas as páginas num só local, com um histórico de edição completo de cada página (pode reverter para qualquer versão) e um motor de busca que funciona com o conteúdo, não apenas com o título. As empresas que querem o mesmo numa versão alojada pagam pelo Confluence da Atlassian, onde uma licença para uma pequena equipa pode custar cerca de 25 € por mês, e isso antes de adicionar espaço extra para anexos. A base de dados de conhecimento do Wiki.js está na tua própria Box, sem taxa para contas adicionais, sem limite para o número de páginas e sem uma fatura mensal que aumenta com o número de pessoas na equipa.

Wiki.js ou BookStack, qual escolher

No catálogo de aplicações Saplo, ao lado do Wiki.js, encontra-se também o BookStack, e ambas as ferramentas resolvem o mesmo problema, mas organizam o conteúdo de forma diferente. O Wiki.js permite construir qualquer árvore de páginas e subpáginas, o que o torna ideal para empresas com muitos tópicos vagamente relacionados: procedimentos, políticas, notas de projetos, documentação técnica. O BookStack impõe uma estrutura mais rígida de Prateleira, Livro, Capítulo, Página, o que pode ser mais conveniente quando a documentação tem uma divisão pré-definida, por exemplo, um livro separado para cada departamento da empresa. O Wiki.js requer o seu próprio contentor PostgreSQL e um mínimo de 1 GB de RAM, enquanto o BookStack usa a base de dados MySQL partilhada da Saplo e começa com apenas 512 MB de RAM, o que significa que num Box mais pequeno, sobram mais recursos para outras aplicações. Se não tens a certeza de qual escolher, começa com o Wiki.js, pois a estrutura mais flexível é mais fácil de expandir com a empresa, e o BookStack será mais adequado se souberes de antemão como a documentação deve ser dividida.

Requisitos

Para instalares o Wiki.js no Saplo, precisas de uma Box com Docker ativado (o motor liga-o automaticamente durante a instalação a partir do catálogo, é necessário um aninhamento no contentor, o que o Saplo tem por predefinição), um mínimo de 1 GB de RAM e 2 GB de espaço livre em disco na Box, e um domínio ou subdomínio *.saploapp.pl, que está incluído no preço de qualquer plano. O Wiki.js, tal como o Paperless-ngx ou o Baserow, não usa a base de dados partilhada do Saplo. Requer PostgreSQL, por isso a receita instala o seu próprio contentor de base de dados ao lado da aplicação, o que significa que a instalação não requer nenhuma base de dados separada do catálogo ou configuração manual da ligação.

Instalação passo a passo

1. No Painel da Saplo, vai a Catálogo de aplicações e escolhe Wiki.js (categoria "Negócios").
2. Indica a Box onde será instalado e o domínio ou subdomínio onde a base de conhecimento estará disponível.
3. Confirma a instalação. O motor cria dois contentores Docker: a imagem oficial ghcr.io/requarks/wiki e o PostgreSQL próprio para os dados, e depois disponibiliza o painel no domínio indicado através do nginx com um certificado SSL gratuito.
4. Após a conclusão, o domínio responderá com o assistente de primeira execução do Wiki.js.

Primeiro lançamento

Ao contrário do Paperless-ngx ou Listmonk, onde a conta de administrador é gerada automaticamente durante a instalação, o Wiki.js funciona como o n8n - crias a conta manualmente no assistente, na primeira vez que acedes ao site, sem um ficheiro de password no diretório da aplicação. Acede ao domínio indicado, o assistente irá pedir o e-mail do administrador, a password e o nome do site. Depois de criar a conta, és direcionado para o painel de administração, onde podes adicionar mais utilizadores para o resto da equipa na secção Administração -> Utilizadores. Cada utilizador tem o seu próprio login, por isso é sempre visível quem editou pela última vez uma determinada página, o que distingue o Wiki.js de uma drive partilhada, onde a autoria da alteração tem de ser adivinhada.

Criação e organização de páginas

Crias uma nova página com o botão Nova página, selecionando um editor Markdown ou WYSIWYG, um editor visual que não exige conhecimentos de sintaxe, e podes alternar entre eles a qualquer momento sem perder conteúdo. As páginas são organizadas numa estrutura de diretórios, por exemplo, “Implementação”, “Procedimentos”, “Acessos”, para que a estrutura da documentação espelhe a estrutura da empresa, em vez de ser uma lista simples de títulos. Cada alteração na página é guardada no histórico de versões, e no separador Histórico podes ver todos os conteúdos anteriores e reverter para qualquer um deles com um clique, o que é útil se alguém, por engano, substituir uma parte de um procedimento. O motor de pesquisa na barra superior pesquisa o conteúdo de todas as páginas, não apenas os títulos, por isso, um fragmento de frase é suficiente para encontrares a instrução certa, mesmo que não te lembres do nome exato da página.

Permissões e trabalho em equipa

Nem todas as páginas devem estar visíveis para toda a empresa, por isso, o Wiki.js permite atribuir permissões em dois níveis: grupos de utilizadores e páginas individuais. Na secção Administração -> Grupos, podes criar grupos correspondentes a departamentos, por exemplo, "Direção", "Departamento Técnico", "Comerciais", e atribuir-lhes permissões de leitura, edição ou gestão de ramos específicos da árvore de páginas. Graças a isso, os acessos às palavras-passe dos servidores são visíveis apenas para o departamento técnico, e a política de férias está aberta a todos, sem necessidade de manter dois sistemas separados. Adicionar um novo funcionário resume-se a criar uma conta e atribuí-la ao grupo correto, em vez de enviar manualmente links para ficheiros espalhados por discos partilhados.

Cópias de segurança e exportação de conteúdo

O Wiki.js guarda os dados num container PostgreSQL, por isso, a cópia de segurança funciona exatamente como em qualquer outra aplicação na Saplo, e inclui os ficheiros e a base de dados em conjunto. Nos planos Box L e superiores, a cópia de segurança é criada automaticamente todos os dias, e nos planos Box S e M, a cópia de segurança está disponível como um extra pago. Podes fazer uma cópia de segurança manual a qualquer momento no painel, na secção Backups, independentemente da automática, por exemplo, logo antes de uma grande reorganização da estrutura das páginas. A restauração a partir de uma cópia de segurança reverte a aplicação para o estado em que estava no momento da sua criação, o que é importante ter em mente antes de testar alterações arriscadas numa base de conhecimento em produção. Além disso, o Wiki.js permite exportar páginas individuais para ficheiros markdown a partir do editor, por isso, um fragmento da documentação pode ser retirado do painel sem fazer uma cópia de segurança completa de toda a aplicação.

Wiki.js na Saplo vs. ficheiros espalhados por discos

Perguntas Frequentes

O Wiki.js tem um editor WYSIWYG, ou é preciso conhecer Markdown? Ambos. Para cada nova página, podes escolher um editor Markdown ou um editor visual WYSIWYG sem precisar de conhecer a sintaxe. Também podes alternar entre eles enquanto escreves a mesma página.

Como obtenho os dados de login após a instalação? Crias a conta de administrador no assistente na primeira vez que acedes ao domínio. O Wiki.js não gera uma palavra-passe predefinida como o Paperless-ngx.

As páginas têm histórico de alterações? Sim, cada edição vai para o histórico de versões da página, com a possibilidade de pré-visualizar e restaurar qualquer versão anterior.

Posso restringir o acesso a páginas selecionadas? Sim, o Wiki.js permite atribuir permissões a nível de grupos e de páginas individuais. Assim, por exemplo, apenas o departamento técnico pode ver os acessos aos servidores.

Em que o Wiki.js difere do BookStack? O Wiki.js oferece uma árvore de páginas flexível e requer o seu próprio PostgreSQL. O BookStack impõe uma estrutura de Estante/Livro/Capítulo e usa a base de dados MySQL partilhada da Saplo, portanto, funciona numa Box mais pequena. Ambos estão lado a lado no Catálogo de aplicações.

Posso ter o Wiki.js e outra aplicação na mesma Box? Sim, cada plano tem um número ilimitado de aplicações, sendo as únicas restrições a RAM e o disco da Box.

Se tiveres dúvidas ao configurar o Wiki.js na tua Box ou ao organizar a documentação da tua equipa, escreve-nos. Ajudaremos com a primeira configuração.