Guia rápido para configurar seu próprio wiki com Wiki.js em apenas alguns minutos

O Wiki.js é um aplicativo wiki de código aberto e rico em recursos, desenvolvido no framework Node.js. Ele oferece uma experiência de edição versátil com suporte para interfaces Markdown e WYSIWYG. Além disso, facilita a colaboração em tempo real, o controle de versões e uma variedade de métodos de autenticação, incluindo integrações com Google e LDAP. Este guia completo guiará você pelas etapas necessárias para configurar o Wiki.js usando o Docker, permitindo que você implante seu próprio wiki em questão de minutos.

Configurando Wiki.js via Docker Compose

O processo de configuração do Wiki.js usando Docker e Docker Compose é simples. Comece criando um novo diretório chamado wikijs-dockere navegue até ele:

mkdir wikijs-docker && cd wikijs-docker

Em seguida, crie um arquivo chamado docker-compose.ymlusando seu editor de texto preferido:

nano docker-compose.yml

Em seguida, insira a seguinte configuração no 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:

Após salvar e fechar o arquivo, inicie os contêineres executando o seguinte comando:

docker compose up -d

Após a conclusão do processo de configuração, acesse http://localhost no seu navegador. Você precisará fornecer os detalhes da conta de administrador e selecionar o botão Instalar para iniciar a instalação:

Após concluir a instalação, faça login usando suas credenciais.

Criando e gerenciando páginas no Wiki.js

Com a configuração inicial concluída, você pode estabelecer sua página inicial para começar a preencher seu conteúdo ou acessar o painel de administração para gerenciar suas configurações, usuários e recursos disponíveis:

Ao clicar na opção Criar página inicial, você será solicitado a escolher um editor adaptado às suas preferências:

Em seguida, defina as propriedades da sua página e clique no botão OK para prosseguir com a criação de uma nova página:

Escreva o conteúdo desejado e clique no botão Criar para finalizar a criação da página:

Gerenciando e organizando conteúdo

Seu painel oferece uma maneira conveniente de visualizar e modificar páginas existentes, bem como criar novas usando o editor de sua escolha. Você pode organizar seu conteúdo renomeando, movendo ou excluindo páginas e utilizar tags para uma categorização eficaz. Além disso, a barra lateral e a funcionalidade de pesquisa agilizam a navegação para páginas específicas do seu wiki:

Configurando as configurações do site Wiki.js

No painel de administração do Wiki.js, você tem a flexibilidade de configurar as configurações do site, como localidade, estruturas de navegação, temas e tags. Essas configurações desempenham um papel crucial na definição da configuração geral da sua instância do Wiki.js.

Na aba Geral, você pode ajustar as configurações fundamentais do site, incluindo o título do site, a descrição, a página inicial padrão e as configurações de visibilidade (pública ou privada):

Alterne para a aba Localidade para especificar o idioma padrão, o fuso horário e os formatos de data/hora para o seu site:

Para gerenciar a estrutura do menu do seu wiki e melhorar a navegação do usuário, visite a seção Barra de navegação :

Na aba Páginas, você pode supervisionar, editar e organizar todas as páginas wiki, criar novas páginas e gerenciar a hierarquia do seu conteúdo:

Além disso, na aba Tags, você pode criar e gerenciar tags de conteúdo, melhorando a capacidade de pesquisa da página. Você também pode personalizar os elementos estéticos do seu wiki na aba Tema, onde pode alterar o logotipo, as cores, as fontes e os estilos de layout do site.

Gerenciando grupos em seu wiki

A seção Grupos permite criar grupos de usuários, designar membros e estabelecer permissões em nível de grupo para regular o acesso. Esse método organizacional ajuda a otimizar as funções dos usuários e mantém um gerenciamento de acesso consistente em todo o seu wiki.

Clicar em um grupo específico permite atualizar suas configurações, permissões, regras de página e gerenciamento de usuários dentro desse grupo. Na aba Configurações, você pode ajustar opções, incluindo o URL de redirecionamento de login.

Você também pode navegar pelas seções Permissões, Regras da página e Usuários para refinar o que o grupo pode acessar e atribuir usuários adequadamente.

Gerenciamento de usuários no Wiki.js

Para adicionar um novo usuário, vá até a seção Usuários, clique no botão NOVO USUÁRIO e preencha os campos necessários.

Após concluir, selecione CRIAR ou CRIAR E FECHAR para finalizar a configuração do novo usuário:

Selecionar um usuário específico permite que você visualize e edite seu perfil, atribua grupos de usuários, defina métodos de autenticação (como senhas ou autenticação de dois fatores) e gerencie seu status com ações como Desativar, Verificar ou Excluir :

Além disso, você pode atualizar suas informações básicas, metadados estendidos (incluindo localização e cargo) e visualizar seu histórico de atividades:

Gerenciando seus módulos Wiki

Módulos são melhorias que ampliam os recursos do Wiki.js. Por exemplo, o módulo Analytics permite integrar ferramentas como o Google Analytics para monitorar o engajamento do usuário e as métricas de tráfego:

Utilize a guia Autenticação para estabelecer e gerenciar provedores de autenticação (login local, LDAP, OAuth) além de configurar várias opções de login:

Configurar as definições de autenticação

Você também pode ativar ou desativar o sistema de comentários e determinar como os usuários se envolvem nas discussões da página:

Configuração do sistema

Gerencie como o conteúdo é renderizado, indexado para pesquisa e armazenado configurando mecanismos de renderização, indexação de pesquisa e configurações de armazenamento. Por exemplo, acesse a aba Renderização para personalizar a renderização do conteúdo, como ajustar as configurações do mecanismo de Markdown ou habilitar o suporte a diagramas e expressões matemáticas:

Na seção Mecanismo de busca, você pode gerenciar opções de indexação de pesquisa interna e integrações de mecanismos de busca de terceiros:

Na seção Armazenamento, especifique os destinos de backup e sincronização para seu conteúdo, permitindo que você gerencie onde e como a mídia e os anexos de página são armazenados (como no sistema de arquivos local ou no AWS S3):

Gerenciando Segurança e Conectividade

Você pode proteger sua instância do Wiki.js configurando o acesso à API, definindo notificações por e-mail, ajustando as políticas de segurança e habilitando o SSL para uma experiência segura. Por exemplo, gerencie tokens de API para integrar o Wiki.js a outros aplicativos:

Defina configurações de e-mail para gerenciar notificações, convites e processos de recuperação de senha no Wiki.js:

As configurações de segurança também podem ser ajustadas, abrangendo aspectos como tempos limite de sessão, políticas de senha e restrições de acesso:

Além disso, você pode configurar certificados SSL/TLS para garantir que sua instância Wiki.js opere com segurança via HTTPS:

Além disso, verifique as informações do seu Wiki, como diagnósticos do sistema, especificações do servidor e estatísticas do ambiente de execução na seção Informações do Sistema :

Execute atividades de manutenção, como reindexar resultados de pesquisa, limpar dados em cache ou redefinir configurações na guia Utilitários :

Por fim, as Ferramentas do Desenvolvedor oferecem recursos avançados, como o GraphQL Playground, recursos de depuração de log ou integrações de script personalizadas:

Gerenciar ferramentas de desenvolvimento

Agora que você está equipado com o conhecimento para configurar o Wiki.js usando o Docker, você pode usar esta plataforma com confiança para criar documentação interna, wikis de equipe colaborativa ou bases de conhecimento públicas sem esforço.

Fonte e Imagens