Como Instalar o Editor de Colaboração Etherpad no Servidor Ubuntu 24.04

Etherpad é um editor de texto colaborativo e em tempo real de código aberto para sua equipe, acessível de qualquer lugar a qualquer momento porque Etherpad é um editor de texto baseado na web. Etherpad suporta versionamento e formatação embutida para equipes e oferece um editor altamente personalizável com o suporte de vários plugins. Ele também suporta formatos de documento modernos, como doc, pdf, odt, markdown, etc.

Neste guia, vamos guiá-lo pelo processo de instalação do editor de colaboração Etherpad no servidor Ubuntu 24.04. Você configurará o Etherpad com o servidor de banco de dados MariaDB, Nginx como um proxy reverso e, em seguida, protegerá o Etherpad com HTTPS através do Certbot e Letsencrypt.

Pré-requisitos

Para começar com este guia, certifique-se de ter o seguinte:

Um servidor Ubuntu 24.04.
Um usuário não-root com privilégios de administrador.
Um nome de domínio apontado para um endereço IP do servidor.

Instalando Dependências

Etherpad é um editor colaborativo em tempo real escrito em Node.js. Para instalá-lo, você deve instalar dependências de pacotes como Node.js, NPM e Git. O Etherpad também requer Python3 e MySQL/MariaDB para o banco de dados.

Primeiro, atualize seu repositório Ubuntu com o seguinte:

sudo apt update

Agora, instale as dependências para o Etherpad usando o comando abaixo. Com este comando, você instalará o servidor MariaDB, Nginx, Node.js, Python3, Git e algumas ferramentas essenciais.

sudo apt install mariadb-server nginx nodejs npm gzip git curl python3 libssl-dev

Digite Y para confirmar a instalação.

Após a instalação, verifique os serviços MariaDB e Nginx para garantir que ambos os serviços estejam em execução.

Verifique o serviço MariaDB com o seguinte:

sudo systemctl is-enabled mariadb  
sudo systemctl status mariadb

Como você pode ver abaixo, o serviço MariaDB está em execução e será iniciado automaticamente na inicialização.

Agora verifique o serviço Nginx usando o comando abaixo. Você deve obter uma saída semelhante quando o serviço Nginx estiver em execução e habilitado.

sudo systemctl is-enabled nginx  
sudo systemctl status nginx

Por fim, verifique a versão do Node.js com o comando.

node -v

Certifique-se de ter Node.js v18.x ou mais. O Etherpad suporta Node.js v18 e acima.

Configurando o servidor MariaDB

Depois de instalar as dependências, você configurará o servidor MariaDB e criará um novo banco de dados e usuário para o Etherpad. Você protegerá o MariaDB usando a ferramenta ‘mariadb-secure-installation’ e, em seguida, configurará o banco de dados e o usuário através do cliente MariaDB.

Para proteger seu servidor MariaDB, execute o seguinte:

sudo mariadb-secure-installation

Você será solicitado a configurar o servidor MariaDB:

1. A instalação padrão do MariaDB vem sem uma senha, pressione ENTER quando solicitado pela senha.
2. Agora insira Y para configurar a senha root do MariaDB. Em seguida, digite a nova senha para o MariaDB e repita a senha.
3. Insira Y para remover o usuário anônimo da sua instalação do MariaDB.
4. Insira Y novamente quando solicitado para desativar o login remoto para o usuário root do MariaDB.
5. Insira Y para remover o banco de dados de teste padrão do seu MariaDB.
6. Por fim, insira Y para recarregar os privilégios da tabela e aplicar novas alterações.

Depois de proteger e configurar o servidor MariaDB, você criará um novo banco de dados e usuário para o Etherpad.

Faça login no servidor MariaDB com o seguinte comando. Insira a senha root do MariaDB quando solicitado.

sudo mariadb -u root -p

Em seguida, execute as seguintes consultas MariaDB para criar um novo banco de dados ‘etherpad_db‘, um usuário ‘etherpad‘, com a senha ‘StrongPasswordEtherpadDB‘. Você pode ajustar os seguintes detalhes do banco de dados com suas informações.

CREATE DATABASE etherpad_db;  
CREATE USER etherpad@localhost IDENTIFIED BY 'StrongPasswordEtherpadDB';  
GRANT CREATE,ALTER,SELECT,INSERT,UPDATE,DELETE on etherpad_db.* to etherpad@localhost;  
FLUSH PRIVILEGES;

Agora execute a seguinte consulta para garantir que o usuário ‘etherpad‘ possa acessar o banco de dados ‘etherpad_db‘.

SHOW GRANTS FOR etherpad@localhost;

Você pode ver abaixo o usuário ‘etherpad‘ com vários privilégios ao banco de dados ‘etherpad_db‘.

Por fim, digite quit para sair do servidor MariaDB.

Instalando o Etherpad Lite

Após criar o banco de dados e o usuário, você fará o download do código-fonte do Etherpad, instalará as dependências do Etherpad com o script de instalação e, em seguida, configurará a instalação do Etherpad com o servidor MariaDB.

Por padrão, o Etherpad usa o gerenciador de pacotes pnpm para gerenciar a instalação, então você deve instalar o ‘pnpm’ globalmente em seu sistema primeiro.

Primeiro, instale o pacote pnpm globalmente (-g) usando o seguinte comando npm. Por padrão, o projeto Etherpad usa pnpm como um gerenciador de pacotes Node.js em vez do npm padrão.

npm install pnpm -g

Agora execute o comando abaixo para criar um novo usuário do sistema ‘etherpad‘. Este usuário será usado para executar o aplicativo Etherpad.

sudo adduser --system --no-create-home --home=/opt/etherpad-lite --group etherpad

Em seguida, vá para o /opt e faça o download do código-fonte do Etherpad para o diretório ‘etherpad-lite‘ com git. Em seguida, mude a propriedade do diretório ‘/opt/etherpad-lite‘ para o usuário ‘etherpad‘.

cd /opt && git clone --branch master https://github.com/ether/etherpad-lite.git   
sudo chown -R etherpad:etherpad /opt/etherpad-lite

Depois, vá para o diretório ‘opt/etherpad-lite’ e instale as dependências do Node.js para o Etherpad com o seguinte.

cd /opt/etherpad-lite  
sudo su -s /bin/bash -c "./bin/run.sh" etherpad

Abaixo está o processo de download das dependências do Etherpad usando o gerenciador de pacotes pnpm.

Após as dependências serem instaladas, o Etherpad deve estar em execução automaticamente. Você pode ver abaixo que o Etherpad 2.0.3 está em execução.

Pressione Ctrl+c para encerrar o processo atual do Etherpad. Você estará configurando o Etherpad com o banco de dados MariaDB.

Agora abra o arquivo ‘settings.json‘ com o seguinte editor nano.

nano settings.json

Altere o título da sua instalação do Etherpad.

 "title": "Etherpad Ubuntu 24",

Altere o endereço IP padrão para 12.0.0.1 ou localhost. Isso iniciará o processo do Etherpad apenas em localhost.

"ip": "127.0.0.1",  
"port": 9001,   

Comente a configuração de banco de dados padrão ‘dirty‘ como a seguinte:

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

Insira a configuração abaixo para configurar um banco de dados com o servidor MariaDB. Certifique-se de alterar os detalhes das informações do banco de dados com os seus.

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

Quando terminar, salve o arquivo e saia do editor.

Executando o Etherpad como um serviço systemd

Agora que você instalou e configurou o Etherpad, você criará um novo arquivo de serviço systemd para o Etherpad. Com isso, você executará o Etherpad em segundo plano e poderá gerenciar o Etherpad através do comando ‘systemctl’.

Crie um novo arquivo de serviço systemd para o Etherpad ‘/etc/systemd/system/etherpad.service‘ com o editor nano.

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

Adicione a seguinte configuração ao arquivo. Com isso, você executará o Etherpad em segundo plano como um serviço systemd através do comando ‘pnpm’.

[Unit]  
Description=Etherpad-lite, o editor colaborativo.  
After=syslog.target network.target mariadb.service  
  
[Service]  
Type=simple  
User=etherpad  
Group=etherpad  
WorkingDirectory=/opt/etherpad-lite  
ExecStart=/usr/local/bin/pnpm run prod  
# use mysql plus a complete settings.json to avoid Service hold-off time over, scheduling restart.  
Restart=always  
  
[Install]  
WantedBy=multi-user.target

Salve o arquivo e saia.

Agora execute o comando abaixo para recarregar o gerenciador systemd e aplicar o arquivo de serviço do Etherpad.

sudo systemctl daemon-reload

Após o systemd ser recarregado, inicie e habilite o serviço ‘etherpad’ com o seguinte comando systemctl.

sudo systemctl start etherpad  
sudo systemctl enable etherpad

Em seguida, execute o comando abaixo para verificar o status do serviço Etherpad e garantir que o serviço esteja em execução.

sudo systemctl status etherpad

Você pode ver abaixo que o serviço Etherpad está em execução como um serviço.

Por fim, verifique a porta padrão do Etherpad 9001 com o comando ‘ss’ abaixo. Você deve ver que a porta 9001 está sendo usada pelo processo Etherpad.

ss -tulpn | grep 9001

Configurando o Nginx como um proxy reverso

Você executará o Etherpad com o Nginx como um proxy reverso neste guia. Portanto, agora você criará a configuração do bloco de servidor Nginx para o Etherpad e garantirá que você tenha preparado seu nome de domínio para o Etherpad.

Use o seguinte comando do editor nano para criar um novo bloco de servidor Nginx ‘/etc/nginx/sites-available/etherpad.conf’.

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

Adicione a seguinte configuração e altere a opção server_name com seu nome de domínio. Com esta configuração, você usará o Nginx como um proxy reverso para o Etherpad, que é executado na porta 9001.

server {  
 listen 80;  
 server_name etherpad.howtoforge.local;  
  
 access_log /var/log/nginx/eplite.access.log;  
 error_log /var/log/nginx/eplite.error.log;  
  
location / {  
 proxy_pass http://127.0.0.1:9001;  
 proxy_buffering off; # tenha cuidado, esta linha não substitui nenhum proxy_buffering on definido em um conf.d/file.conf  
 proxy_set_header Host $host;  
 proxy_pass_header Server;  
# Nota: você pode querer passar esses cabeçalhos etc também.  
 proxy_set_header X-Real-IP $remote_addr; # https://nginx.org/en/docs/http/ngx_http_proxy_module.html  
 proxy_set_header X-Forwarded-For $remote_addr; # EP logs para mostrar o IP remoto real  
 proxy_set_header X-Forwarded-Proto $scheme; # para EP definir a bandeira de cookie seguro quando https é usado  
 proxy_http_version 1.1; # recomendado com conexões keepalive  
# Proxy WebSocket - de https://nginx.org/en/docs/http/websocket.html  
 proxy_set_header Upgrade $http_upgrade;  
 proxy_set_header Connection "upgrade";  
 }  
  
}

Salve e feche o arquivo quando terminar.

Agora execute o comando abaixo para ativar o arquivo do bloco de servidor ‘etherpad.conf‘ e verificar sua sintaxe do Nginx.

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

Você deve obter uma saída ‘nginx is ok…test is successful‘ com a sintaxe do Nginx adequada.

Por fim, execute o comando abaixo para reiniciar o serviço Nginx e aplicar seu novo bloco de servidor. Após executar o comando, seu Etherpad estará acessível através do servidor web Nginx.

sudo systemctl restart nginx

Protegendo o Etherpad com HTTPS

Após configurar o proxy reverso Nginx, você protegerá o Etherpad com HTTPS. Se você estiver usando o domínio público, pode usar as seguintes etapas para configurar o HTTPS com Certbot e Letsencrypt. Usuários de domínio local podem usar certificados autoassinados.

Instale o Certbot e o plugin Certbot Nginx usando o seguinte comando. Quando solicitado, digite Y para confirmar a instalação.

sudo apt install certbot python3-certbot-nginx

Agora execute o seguinte comando certbot para gerar certificados SSL/TLS do Letsencrypt. Certifique-se de alterar o nome do domínio e o endereço de e-mail com seus detalhes.

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

Após concluir o processo, seus certificados estarão disponíveis no diretório ‘/etc/letsencrypt/live/domain.com‘. Além disso, sua instalação do Etherpad deve ser executada automaticamente com HTTPS através do plugin Certbot Nginx.

Acessando o Etherpad

Visite seu nome de domínio Etherpad https://etherpad.howtoforge.local para acessar sua instalação do Etherpad. Se for bem-sucedido, você verá a seguinte página:

Digite o novo nome para seu primeiro pad e clique em OK para confirmar.

Agora você verá o editor de documentos do Etherpad. Você pode agora editar o documento ao mesmo tempo que seus amigos ou colegas.

Conclusão

Parabéns! Você instalou o editor de colaboração Etherpad no servidor Ubuntu 24.04. Você tem o Etherpad em execução com o servidor de banco de dados MariaDB e o servidor web Nginx. Além disso, você protegeu o Etherpad com HTTPS através do Certbot e Letsencrypt.