Como instalar o Etherpad no Ubuntu 20.04

Etherpad é um editor online em tempo real baseado na web que permite que escritores editem simultaneamente um documento de texto e monitorem todas as edições em tempo real. É de código aberto, personalizável e tem a capacidade de exibir o texto de cada autor em sua própria cor. Também fornece uma API HTTP que você pode integrar com suas aplicações para gerenciar usuários e grupos. Oferece vários plugins que ajudam a integrar notificações por e-mail, upload de arquivos e chamadas de vídeo no Etherpad. Neste tutorial, mostraremos como instalar o editor baseado na web Etherpad no servidor Ubuntu 20.04.

Pré-requisitos

• Um servidor rodando Ubuntu 20.04.
• Um nome de domínio válido apontado para o IP do seu servidor.
• Uma senha de root configurada no servidor.

Começando

Antes de começar, você precisará atualizar os pacotes do seu sistema para a versão mais recente. Você pode atualizá-los executando o seguinte comando:

apt-get update -y

Uma vez que todos os pacotes estejam atualizados, você precisará instalar algumas dependências em seu sistema. Você pode instalar todas elas com o seguinte comando:

apt-get install gnupg2 git unzip libssl-dev pkg-config gcc g++ make build-essential -y

Uma vez que todos os pacotes estejam instalados, você pode prosseguir para a próxima etapa.

Instalar e Configurar o Banco de Dados MariaDB

O Etherpad usa o MariaDB como backend de banco de dados. Portanto, você precisará instalar o servidor MariaDB em seu sistema. Você pode instalá-lo com o seguinte comando:

apt-get install mariadb-server -y

Após instalar o MariaDB, faça login no shell do MariaDB com o seguinte comando:

mysql

Após o login, crie um banco de dados e um usuário para o Etherpad com o seguinte comando:

MariaDB [(none)]> create database etherpad;  
MariaDB [(none)]> grant all privileges on etherpad.* to etherpad@localhost identified by 'password';

Em seguida, limpe os privilégios e saia do MariaDB com o seguinte comando:

MariaDB [(none)]> flush privileges;  
MariaDB [(none)]> exit;

Neste ponto, seu banco de dados está configurado para o Etherpad. Você pode agora prosseguir para a próxima etapa.

Instalar Node.js

O Etherpad é baseado no Node.js. Portanto, você precisará instalar o Node.js em seu sistema. Por padrão, a versão mais recente do Node.js não está disponível no repositório padrão do Ubuntu 20.04. Portanto, você precisará adicionar o repositório do Node.js ao seu sistema. Você pode adicioná-lo com o seguinte comando:

curl -sL https://deb.nodesource.com/setup_14.x -o nodesource_setup.sh  
bash nodesource_setup.sh

Uma vez que o repositório esteja adicionado, instale o Node.js com o seguinte comando:

apt-get install nodejs -y

Após instalar o Node.js, verifique a versão instalada do Node.js com o seguinte comando:

node -v

Você deve obter a seguinte saída:

v14.15.0

Uma vez que você tenha terminado, pode prosseguir para a próxima etapa.

Instalar e Configurar o Etherpad

Antes de instalar o Etherpad, é recomendado executar o Etherpad como um usuário separado. Você pode criar um novo usuário para o Etherpad com o seguinte comando:

adduser --home /opt/etherpad --shell /bin/bash etherpad

Você será solicitado a definir uma senha, conforme mostrado abaixo:

Adding user `etherpad' ...
Adding new group `etherpad' (1000) ...
Adding new user `etherpad' (1000) with group `etherpad' ...
Creating home directory `/opt/etherpad' ...
Copying files from `/etc/skel' ...
New password: 
Retype new password: 
passwd: password updated successfully
Changing the user information for etherpad
Enter the new value, or press ENTER for the default
    Full Name []: Hitesh       
    Room Number []: 1
    Work Phone []: 
    Home Phone []: 
    Other []: 
Is the information correct? [Y/n] Y

Em seguida, forneça as permissões adequadas ao diretório home do Etherpad com o seguinte comando:

install -d -m 755 -o etherpad -g etherpad /opt/etherpad

Em seguida, troque o usuário para Etherpad e baixe a versão mais recente do Etherpad do repositório Git usando o seguinte comando:

su - etherpad  
git clone --branch master https://github.com/ether/etherpad-lite.git

Em seguida, mude o diretório para o diretório baixado e execute o Etherpad usando o seguinte comando:

cd etherpad-lite  
bin/run.sh

Isso instalará todas as dependências e iniciará o servidor Etherpad. Uma vez que o servidor seja iniciado com sucesso, você deve obter a seguinte saída:

[2020-11-11 06:46:44.783] [INFO] console - Your Etherpad version is 1.8.6 (2c8769a)
[2020-11-11 06:46:44.958] [INFO] console - You can access your Etherpad instance at http://0.0.0.0:9001/
[2020-11-11 06:46:44.958] [WARN] console - Admin username and password not set in settings.json.  To access admin please uncomment and edit 'users' in settings.json
[2020-11-11 06:46:44.958] [WARN] console - Etherpad is running in Development mode.  This mode is slower for users and less secure than production mode.  You should set the NODE_ENV environment variable to production by using: export NODE_ENV=production

Em seguida, pressione CTRL + C para parar o servidor. Em seguida, você precisará editar o arquivo settings.json e definir seu banco de dados e configurações de administrador:

nano settings.json

Remova as seguintes linhas:

"dbType" : "dirty",
  "dbSettings" : {
                   "filename" : "var/dirty.db"
                 },

Altere as configurações do MySQL conforme mostrado abaixo:

  "dbType" : "mysql",
  "dbSettings" : {
    "user":     "etherpad",
    "host":     "localhost",
    "port":     3306,
    "password": "password",
    "database": "etherpad",
    "charset":  "utf8mb4"
  },

Altere a linha trustProxy para true:

  "trustProxy": true,

Defina uma senha para o usuário administrador:

  "users": {
    "admin": {
      "password": "adminpassword",
      "is_admin": true
    },

Salve e feche o arquivo e, em seguida, instale as dependências necessárias com o seguinte comando:

./bin/installDeps.sh

Uma vez que todas as dependências estejam instaladas, saia do usuário Etherpad com o seguinte comando:

exit

Neste ponto, o Etherpad está instalado e configurado. Você pode agora prosseguir para a próxima etapa.

Criar um Arquivo de Serviço Systemd para o Etherpad

Em seguida, você precisará criar um arquivo de serviço systemd para gerenciar o serviço Etherpad. Você pode criá-lo com o seguinte comando:

nano /etc/systemd/system/etherpad.service

Adicione as seguintes linhas:

[Unit]
Description=Etherpad-lite, the collaborative editor.
After=syslog.target network.target

[Service]
Type=simple
User=etherpad
Group=etherpad
WorkingDirectory=/opt/etherpad/etherpad-lite
Environment=NODE_ENV=production

ExecStart=/usr/bin/node /opt/etherpad/etherpad-lite/src/node/server.js

Restart=always

[Install]
WantedBy=multi-user.target

Salve e feche o arquivo e, em seguida, recarregue o daemon systemd executando o seguinte comando:

systemctl daemon-reload

Em seguida, inicie o serviço Etherpad e habilite-o para iniciar na reinicialização do sistema com o seguinte comando:

systemctl start etherpad  
systemctl enable etherpad

Você também pode verificar o status do serviço Etherpad com o seguinte comando:

systemctl status etherpad

Você deve ver a seguinte saída:

? etherpad.service - Etherpad-lite, the collaborative editor.
     Loaded: loaded (/etc/systemd/system/etherpad.service; disabled; vendor preset: enabled)
     Active: active (running) since Wed 2020-11-11 06:50:49 UTC; 4s ago
   Main PID: 12269 (node)
      Tasks: 13 (limit: 4691)
     Memory: 119.1M
     CGroup: /system.slice/etherpad.service
             ??12269 /usr/bin/node /opt/etherpad/etherpad-lite/src/node/server.js

Configurar o Nginx para o Etherpad

Neste ponto, o Etherpad está iniciado e ouvindo na porta 9001. Em seguida, você precisará instalar e configurar o Nginx como um proxy reverso para acessar o Etherpad. Primeiro, instale o Nginx com o seguinte comando:

apt-get install nginx -y

Em seguida, crie um novo arquivo de configuração de host virtual do Nginx com o seguinte comando:

nano /etc/nginx/sites-available/etherpad.conf

Adicione as seguintes linhas:

upstream etherpad {
   server localhost:9001;
   keepalive 32;
}

server {
   listen 80;
   server_name etherpad.mydomain.com;

   location / {
       client_max_body_size 50M;
       proxy_set_header X-Real-IP $remote_addr;
       proxy_http_version 1.1;
       proxy_pass http://etherpad;
   }
}

Salve e feche o arquivo e, em seguida, ative o arquivo de configuração do host virtual do Nginx com o seguinte comando:

ln -s /etc/nginx/sites-available/etherpad.conf /etc/nginx/sites-enabled/

Em seguida, verifique o Nginx para qualquer erro de sintaxe com o seguinte comando:

ginx -t

Você deve obter a seguinte saída:

nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

Em seguida, reinicie o serviço Nginx para aplicar as alterações:

systemctl restart nginx

Você também pode verificar o status do Nginx com o seguinte comando:

systemctl status nginx

Você deve obter a seguinte saída:

? nginx.service - A high performance web server and a reverse proxy server
     Loaded: loaded (/lib/systemd/system/nginx.service; enabled; vendor preset: enabled)
     Active: active (running) since Wed 2020-11-11 06:53:44 UTC; 6s ago
       Docs: man:nginx(8)
    Process: 12984 ExecStartPre=/usr/sbin/nginx -t -q -g daemon on; master_process on; (code=exited, status=0/SUCCESS)
    Process: 12985 ExecStart=/usr/sbin/nginx -g daemon on; master_process on; (code=exited, status=0/SUCCESS)
   Main PID: 13001 (nginx)
      Tasks: 3 (limit: 4691)
     Memory: 3.5M
     CGroup: /system.slice/nginx.service
             ??13001 nginx: master process /usr/sbin/nginx -g daemon on; master_process on;
             ??13002 nginx: worker process
             ??13003 nginx: worker process

Nov 11 06:53:44 ubuntu2004 systemd[1]: Starting A high performance web server and a reverse proxy server...
Nov 11 06:53:44 ubuntu2004 systemd[1]: Started A high performance web server and a reverse proxy server.

Acessar o Etherpad

Agora, abra seu navegador da web e digite a URL http://etherpad.mydomain.com. Você será redirecionado para a seguinte página:

Forneça o nome da sua página e clique no botão OK. Você deve ver seu painel do Etherpad na seguinte página:

Conclusão

Parabéns! você instalou e configurou com sucesso o Etherpad com o Nginx como um proxy reverso no servidor Ubuntu 20.04. Você pode usar o Etherpad no ambiente de produção facilmente. Sinta-se à vontade para me perguntar se você tiver alguma dúvida.