Como Configurar o Wiki.js e Ter seu Próprio Wiki em Minutos

Wiki.js é uma poderosa plataforma wiki de código aberto construída sobre Node.js. Ela suporta edição em Markdown e WYSIWYG, colaboração em tempo real, controle de versão e opções de autenticação flexíveis, incluindo Google e LDAP. Neste guia, mostraremos como configurar o Wiki.js com Docker para que você possa colocar seu wiki em funcionamento em apenas alguns minutos.

Instalar o Wiki.js Usando Docker Compose

Usando Docker e Docker Compose, é incrivelmente fácil configurar o wiki.js. Primeiro, crie um diretório chamado “wikijs-docker” e acesse-o usando o comando cd:

mkdir wikijs-docker && cd wikijs-docker

Depois disso, crie um arquivo “docker-compose.yml” em qualquer editor de texto:

nano docker-compose.yml

E então, cole o seguinte conteúdo neste arquivo:

services:  
  
  db:  
    image: postgres:16  
    environment:  
      POSTGRES_DB: wiki  
      POSTGRES_PASSWORD: wikijsrocks  
      POSTGRES_USER: wikijs  
    restart: unless-stopped  
    volumes:  
      - db-data:/var/lib/postgresql/data  
  
  wiki:  
    image: ghcr.io/requarks/wiki:2  
    depends_on:  
      - db  
    environment:  
      DB_TYPE: postgres  
      DB_HOST: db  
      DB_PORT: 5432  
      DB_USER: wikijs  
      DB_PASS: wikijsrocks  
      DB_NAME: wiki  
    restart: unless-stopped  
    ports:  
      - "80:3000"  
  
volumes:  
  db-data:

Salve e feche o arquivo e, em seguida, inicie os contêineres usando o seguinte comando:

docker compose up -d

Uma vez que a configuração termine, abra o wiki.js no seu navegador em http://localhost. Especifique os detalhes da conta de administrador e clique no botão Instalar para iniciar a instalação:

Após a instalação, insira suas credenciais para fazer login.

Criando e Gerenciando Páginas no Wiki.js

Agora você pode criar a página inicial para começar a adicionar conteúdo ou acessar o painel de administração para gerenciar configurações, usuários e recursos:

Se você clicar no botão Criar Página Inicial, será solicitado a selecionar um editor para a página. Selecione aquele com base em suas preferências e requisitos:

Especifique as propriedades da página e clique no botão OK para criar uma nova página:

Escreva o que quiser e clique no botão Criar para criar a página:

Gerenciar e Organizar Conteúdo

No painel, você pode visualizar e editar páginas existentes, criar novas páginas usando seu editor preferido e organizar seu conteúdo movendo, renomeando ou excluindo páginas. Você também pode adicionar tags para categorizar o conteúdo de forma eficaz. Além disso, a barra lateral e a barra de pesquisa facilitam a navegação rápida até páginas específicas dentro do seu wiki:

Configurações do Site Wiki.js

No painel de administração do Wiki.js, você pode configurar as configurações do site, como local, navegação, temas e tags. Essas opções ajudam a definir a configuração global da sua instância Wiki.js.

Você pode configurar as configurações básicas do site na aba Geral, como título do site, descrição, página inicial padrão e visibilidade do site (pública ou privada):

Navegue até a aba Local para definir o idioma padrão, fuso horário e formatos de data/hora usados em todo o site:

Para gerenciar a estrutura dos menus do seu wiki e controlar como os usuários navegam pelo conteúdo, vá para a Barra de Navegação.

Na aba Páginas, você pode visualizar, gerenciar e organizar todas as páginas do wiki. Você pode criar novas páginas, editar as existentes ou gerenciar a hierarquia das páginas.

Você também pode criar e gerenciar tags de conteúdo na aba Tags para ajudar a categorizar as páginas e melhorar a busca. Da mesma forma, você pode modificar a aparência do seu wiki a partir da aba Tema. Por exemplo, você pode modificar o logotipo do site, cores, fontes e temas de layout.

Gerenciar Grupos no Seu Wiki

Na seção Grupos, você pode criar grupos de usuário, atribuir membros e definir permissões de nível de grupo para controlar o acesso. Use grupos para organizar usuários por função e gerenciar seu acesso de forma consistente em todo o seu wiki.

Você pode clicar em um grupo específico para atualizar suas configurações, permissões, regras de páginas e gerenciar usuários dentro desse grupo. A aba Configurações permite que você configure opções como a URL de redirecionamento após o login.

Além disso, você pode navegar pelas abas Permissões, Regras de Páginas e Usuários para controlar o que o grupo pode acessar e quais usuários estão atribuídos a ele.

Gerenciamento de Usuários no Wiki.js

Para criar um novo usuário, vá para a seção Usuários, clique no botão NOVO USUÁRIO e especifique os detalhes necessários.

Depois disso, clique no botão CRIAR ou CRIAR E FECHAR para criar um novo usuário:

Clique em um usuário específico para visualizar e editar seu perfil, atribuí-los a grupos de usuários, definir métodos de autenticação como senhas e autenticação de dois fatores, e gerenciar seu status usando ações como Desativar, Verificar ou Excluir:

Você também pode atualizar suas informações básicas, metadados extensos (como localização e cargo) e monitorar seu histórico de atividades:

Gerenciar Seus Módulos do Wiki

Os módulos são recursos opcionais que aprimoram a funcionalidade do Wiki.js. Por exemplo, o módulo Analytics permite que você ative e configure integrações como Google Analytics para rastrear o comportamento do usuário e o tráfego no seu wiki.

Use a aba Autenticação para configurar e gerenciar provedores de autenticação (como login local, LDAP, OAuth) e configurar opções de login.

Você pode ativar ou desativar o sistema de comentários e escolher como os usuários interagem com as discussões de páginas.

Configuração do Sistema

Você também pode gerenciar como o conteúdo é renderizado, pesquisado e armazenado configurando mecanismos de renderização, indexação de busca e opções de armazenamento. Por exemplo, você pode navegar até a aba Renderização para personalizar como o conteúdo é renderizado, como configurações do mecanismo Markdown ou suporte para diagramas, expressões matemáticas, etc.

Na seção Mecanismo de Busca, você pode configurar opções de indexação de busca interna e integrações com motores de busca:

Vá para a seção Armazenamento para definir destinos de backup e sincronização para seu conteúdo. Aqui, você pode gerenciar onde e como mídias e anexos de página são armazenados (sistema de arquivos local, AWS S3, etc.):

Gerenciar Segurança e Conectividade

Você pode gerenciar segurança e conectividade configurando acesso à API, configurando e-mail para notificações, ajustando políticas de segurança e habilitando SSL para proteger seu site Wiki.js. Por exemplo, você pode gerenciar tokens de API para integrar o Wiki.js com sistemas externos ou suas próprias aplicações personalizadas:

Podemos configurar as configurações de e-mail para lidar com notificações, convites e recuperação de senha no Wiki.js.

Você pode configurar as opções de Segurança, como tempos de expiração de sessão, políticas de senha e restrições de acesso.

Além disso, você pode configurar certificados SSL/TLS para proteger seu site Wiki.js com HTTPS.

Além disso, você pode confirmar suas informações do Wiki, como visualizar diagnósticos do sistema, detalhes do servidor e estatísticas do ambiente de execução, na seção Informações do Sistema.

Você pode realizar ações de manutenção, como reindexar a busca, limpar caches ou redefinir configurações na aba Utilitários.

Finalmente, as Ferramentas de Desenvolvedor permitem que você acesse ferramentas avançadas, como playground GraphQL, logs de depuração ou scripts personalizados:

Agora que você aprendeu como configurar o Wiki.js com Docker, pode usá-lo para construir documentação interna, wikis de equipe ou até mesmo bases de conhecimento públicas com facilidade. Se você ainda está avaliando suas opções, confira nossa comparação DokuWiki vs Wiki.js para ver qual plataforma é a mais adequada para seu projeto.