Como Instalar o Wiki.js no Debian 12

Wiki.js é um software wiki gratuito e de código aberto baseado em Node.js, Git e Markdown. É lançado sob a Licença AGPL-v3 e projetado para desempenho e conservação de recursos do sistema. O Wiki.js é um software Wiki poderoso que pode ser instalado em qualquer lugar do seu sistema. Você pode instalá-lo no seu sistema operacional ou usar serviços em nuvem como Heroku, e também implantar o Wiki.js em seus ambientes de contêiner, como Docker e Kubernetes.

O Wiki.js é compatível com o banco de dados PostgreSQL e fornece mais de 50 integrações para autenticação adicional, sistema de registro, mecanismo de busca, renderização e armazenamento. É um software Wiki poderoso construído sobre interfaces bonitas e intuitivas tanto para o painel de administração quanto para as páginas. É um software wiki totalmente personalizável para documentar sua pilha tecnológica.

Neste artigo, vamos mostrar como instalar o Wiki.js em um sistema Debian 12. Vamos guiá-lo pela instalação do Wiki.js, utilizando um servidor de banco de dados PostgreSQL, Nginx como um proxy reverso e, em seguida, proteger sua instância do Wiki.js com certificados SSL/TLS do Let’s Encrypt.

Pré-requisitos

Antes de prosseguir, certifique-se de que você tem:

• Um servidor Debian 12.
• Um usuário não-root com privilégios de administrador.
• Um nome de domínio apontado para o endereço IP do seu servidor. Este exemplo usará o domínio wiki.howtoforge.local.

Instalando Dependências

Na primeira etapa, você instalará algumas das dependências que serão usadas pelo Wiki.js, que incluem:

• Servidor de banco de dados PostgreSQL: Este será usado como o banco de dados para o seu Wiki.js.
• Servidor web Nginx: O servidor web Nginx será usado como um proxy reverso para o Wiki.js.
• Node.js e NPM: O motor de execução JavaScript Node.js e o gerenciador de pacotes NPM.
• Certbot e Plugin Certbot Nginx: Certbot para gerar certificados SSL/TLS via Let’s Encrypt e o Plugin Certbot Nginx confirmará automaticamente seu bloco de servidor Nginx com HTTPS.

Para começar, atualize e atualize o repositório Debian usando o comando abaixo antes de instalar os pacotes.

sudo apt update

Agora instale as dependências do pacote para o Wiki.js via o comando apt install abaixo. Com o seguinte comando, você instalará o servidor de banco de dados PostgreSQL, Node.js e NPM, servidor web Nginx, Certbot e plugin Certbot Nginx.

sudo apt install postgresql postgresql-common nodejs npm nginx certbot python3-certbot-nginx

Digite y para confirmar e prosseguir com a instalação.

Uma vez que as dependências estão instaladas, verifique cada uma delas usando os seguintes comandos.

Verifique o status do serviço PostgreSQL usando o comando systemctl abaixo.

sudo systemctl is-enabled postgresql  
sudo systemctl status postgresql

Uma saída semelhante abaixo será mostrada.

Verifique o status do serviço Nginx para garantir que ele está em execução e habilitado.

sudo systemctl is-enabled nginx  
sudo systemctl status nginx

Se o Nginx estiver em execução e habilitado, a saída abaixo será exibida no seu terminal.

Por fim, verifique o Node.js e NPM executando o seguinte comando. A saída exibirá as versões atuais do Node.js e NPM instaladas no seu sistema.

node --version  
npm --version

Criando um Banco de Dados e Usuário PostgreSQL

Após instalar as dependências, o próximo passo é criar um novo banco de dados e usuário para sua instalação do Wiki.js. Para fazer isso, você deve fazer login no PostgreSQL via o cliente psql.

Faça login no servidor PostgreSQL executando o seguinte comando.

sudo -u postgres psql

Uma vez logado, execute as seguintes consultas para criar um novo banco de dados PostgreSQL e o usuário wikijs. Certifique-se de alterar a senha nas seguintes consultas.

CREATE USER wikijs WITH PASSWORD 'p4ssw0rd';  
CREATE DATABASE wikijs OWNER wikijs;

Após o banco de dados e o usuário serem criados, verifique sua existência usando as seguintes consultas para listar os bancos de dados e usuários disponíveis na sua instância PostgreSQL.

du  

l

Você deve ver o banco de dados e o usuário wikijs criados no PostgreSQL.

Digite quit para sair do servidor PostgreSQL.

Baixando o Código Fonte do Wiki.js

Na seção seguinte, você fará o download do código fonte do Wiki.js para o seu servidor e configurará o diretório de instalação com as permissões e propriedade adequadas.

Crie um novo usuário wikijs executando o seguinte comando.

sudo useradd -m -s /bin/false wikijs

Agora crie um novo diretório /opt/wikijs e entre nele. Em seguida, faça o download do código fonte do Wiki.js via o comando wget abaixo.

mkdir -p /opt/wikijs; cd /opt/wikijs  
wget https://github.com/Requarks/wiki/releases/latest/download/wiki-js.tar.gz

Uma vez baixado, extraia o código fonte do Wiki.js e altere a propriedade do diretório /opt/wikijs para o usuário wikijs.

tar -xf wiki-js.tar.gz  
sudo chown -R wikijs:wikijs /opt/wikijs

Configurando o Wiki.js

Com o Wiki.js baixado, você configurará sua instalação do Wiki.js com o banco de dados e usuário PostgreSQL, e também configurará o endereço IP de ligação para o Wiki.js.

Copie a configuração padrão do Wiki.js config.sample.yml para config.yml, em seguida, abra-o usando o seguinte editor nano.

sudo -u wikijs cp config.sample.yml config.yml  
sudo -u wikijs nano config.yml

Altere a configuração padrão do banco de dados com seu banco de dados PostgreSQL, usuário e senha.

  # PostgreSQL / MySQL / MariaDB / MS SQL Server apenas:  
  host: localhost  
  port: 5432  
  user: wikijs  
  pass: p4ssw0rd  
  db: wikijs  
  ssl: false

Altere a opção bindIP padrão para localhost ou 127.0.0.1. Isso fará com que o Wiki.js seja executado no localhost.

bindIP: 127.0.0.1

Salve e saia após terminar.

Em seguida, execute o seguinte comando para executar e testar sua instalação do Wiki.js.

sudo -u wikijs node server

Você deve ver a confirmação de que o Wiki.js está em execução no localhost com a porta padrão 3000.

Por fim, pressione Ctrl+c para encerrar o processo do Wiki.js.

Executando o Wiki.js em Segundo Plano como um Serviço

Agora que você concluiu a configuração do Wiki.js, o próximo passo é configurar o Wiki.js para ser executado em segundo plano como um serviço systemd. Usando a abordagem a seguir, você pode gerenciar facilmente o Wiki.js via a utilidade systemctl.

Crie um novo arquivo de serviço systemd para o Wiki.js /etc/systemd/system/wikijs.service usando o comando do editor nano abaixo.

sudo nano /etc/systemd/system/wikijs.service

Insira a seguinte configuração que permitirá que o Wiki.js seja executado em segundo plano como um serviço.

[Unit]  
Description=Wiki.js  
After=network.target postgresql.service  
  
[Service]  
Type=simple  
ExecStart=/usr/bin/node server  
Restart=always  
  
User=wikijs  
Environment=NODE_ENV=production  
WorkingDirectory=/opt/wikijs  
  
[Install]  
WantedBy=multi-user.target

Salve o arquivo e saia do editor quando terminar.

Em seguida, execute o comando systemctl abaixo para recarregar o gerenciador systemd e aplicar o novo arquivo de serviço para o Wiki.js.

sudo systemctl daemon-reload

Agora você pode iniciar e habilitar o serviço wiki.js usando o comando abaixo. Isso iniciará o Wiki.js em segundo plano no localhost com a porta padrão 3000 e habilitará para ser executado automaticamente na inicialização.

sudo systemctl start wikijs  
sudo systemctl enable wikijs

Verifique o serviço wikijs usando o comando abaixo para garantir que o serviço está em execução.

sudo systemctl status wikijs

Uma saída abaixo deve ser apresentada.

Por fim, execute o comando ss abaixo para verificar a porta 3000 que é usada pela aplicação Wiki.js.

ss -tulpn | grep 3000

Se o Wiki.js estiver em execução, você deve ver que a aplicação Node.js usa a porta 3000.

Configurando o Nginx como um Proxy Reverso

Agora que o Wiki.js está em execução no localhost com a porta padrão 3000. No próximo passo, você criará uma nova configuração de bloco de servidor Nginx que será usada como um proxy reverso para o Wiki.js. Antes de começar, certifique-se de que você tem um nome de domínio apontado para o endereço IP do seu servidor.

Crie uma nova configuração de bloco de servidor Nginx /etc/nginx/sites-available/wikijs usando o seguinte comando do editor nano.

sudo nano /etc/nginx/sites-available/wikijs

Insira a seguinte configuração e certifique-se de alterar o nome de domínio da sua instalação do Wiki.js.

server {  
    listen 80;  
    server_name wiki.howtoforge.local;  
  
    root /opt/wikijs;  
  
    access_log  /var/log/nginx/wikijs.access.log;  
    error_log   /var/log/nginx/wikijs.error.log;  
  
    location / {  
        proxy_http_version 1.1;  
        proxy_set_header Upgrade $http_upgrade;  
        proxy_set_header Connection "upgrade";  
        proxy_set_header Host $http_host;  
        proxy_set_header X-Real-IP $remote_addr;  
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;  
        proxy_set_header X-Forwarded-Proto $scheme;  
        proxy_pass http://127.0.0.1:3000;  
    }  
}

Salve o arquivo e saia do editor quando terminar.

Em seguida, execute o seguinte comando para habilitar a configuração do bloco de servidor do Wiki.js e verificar a sintaxe do Nginx.

sudo ln -s /etc/nginx/sites-available/wikijs /etc/nginx/sites-enabled  
sudo nginx -t

Se você tiver uma sintaxe Nginx adequada, deve obter uma saída teste bem-sucedido - sintaxe está ok.

Agora reinicie o serviço Nginx usando o comando abaixo para aplicar o novo bloco de servidor que você configurou.

sudo systemctl restart nginx

Uma vez que o Nginx seja reiniciado, abra seu navegador web preferido e visite o nome de domínio da sua instalação do Wiki.js, como http://wiki.howtoforge.local/. Se tudo correr bem, você deve ver a página de instalação do Wiki.js como esta:

Protegendo o Wiki.js com Certificados SSL/TLS

Na próxima etapa, você protegerá sua instalação do Wiki.js com certificados SSL/TLS do Letsencrypt. Além disso, você configurará o redirecionamento automático de HTTP para HTTPS via o Plugin Certbot Nginx.

Execute o comando certbot abaixo para gerar novos certificados SSL/TLS do letsencrypt. Certifique-se de alterar os detalhes do nome de domínio e endereço de e-mail com suas informações.

sudo certbot --nginx --agree-tos --redirect --hsts --staple-ocsp --email [email protected] -d wiki.howtoforge.local

Após o processo ser concluído, seus certificados SSL estarão disponíveis no diretório /etc/letsencrypt/live/wiki.howtoforge.local/. Quanto à configuração do bloco de servidor do Wiki.js, ela será automaticamente configurada com HTTPS via o Plugin Certbot Nginx.

Iniciando a Instalação do Wiki.js

Volte ao seu navegador web e visite o nome de domínio do seu Wiki.js, por exemplo, http://wiki.howtoforge.local/. Você deve ser redirecionado automaticamente para uma conexão HTTPS segura.

Agora crie o usuário administrador para o Wiki.js e insira seu endereço de e-mail e senha. Em seguida, clique em INSTALAR para confirmar a instalação.

Uma vez que a instalação esteja concluída, você deve ser redirecionado para a página de login do seu Wiki.js. Insira seu endereço de e-mail e senha de administrador, em seguida, clique em LOGIN.

Se sua instalação for bem-sucedida, você deve ver a página de boas-vindas do Wiki.js. A partir daqui, você pode criar uma nova página inicial ou acessar o painel de administração do Wiki.js.

Se você clicar em ADMINISTRAÇÃO, você deve ver a página de administração do Wiki.js como esta:

Na seção SISTEMA, clique no menu Informações do Sistema para obter informações detalhadas sobre sua instalação do Wiki.js. Abaixo você deve ver que o Wiki.js 2.5 está instalado com Node.js 18.x e PostgreSQL 15.x.

Conclusão

É isso! Você seguiu todas as etapas e instalou o Wiki.js no seu sistema Debian 12, completo com um servidor de banco de dados PostgreSQL, Nginx como um proxy reverso e protegeu a instalação via certificados SSL/TLS do Let’s Encrypt. Agora você pode começar a construir a documentação da sua empresa com o Wiki.js.