Como Hospedar HedgeDoc em um VPS (Guia Completo)

Introdução

HedgeDoc é um editor colaborativo de markdown que permite que múltiplos usuários editem documentos em tempo real. Ele é frequentemente utilizado para anotações e documentação entre equipes. Hospedar HedgeDoc em um Virtual Private Server (VPS) oferece controle total sobre seus dados e garante privacidade. Neste guia, vamos explicar os passos para instalar o HedgeDoc em um VPS usando Docker.

Pré-requisitos

1. Um VPS: Escolha um provedor de VPS adequado. Aqui está uma comparação rápida de algumas opções populares:

Para comparações detalhadas de diversos provedores de VPS, confira nossa comparação completa de VPS.

2. Acesso SSH: Garanta que você consegue acessar seu VPS via SSH.

3. Docker e Docker Compose: Certifique-se de que ambos estão instalados no seu VPS. Você pode instalá-los usando os seguintes comandos:

sudo apt update
sudo apt install -y docker.io docker-compose

Passo 1: Configurando o Ambiente do HedgeDoc

1. Crie um diretório para o HedgeDoc:

mkdir ~/hedgedoc
cd ~/hedgedoc

2. Crie um arquivo docker-compose.yml no diretório hedgedoc. Adicione a seguinte configuração para montar o HedgeDoc com PostgreSQL como banco de dados:

version: '3.1'

services:
  hedgedoc:
    image: hedgedoc/hedgedoc:latest
    environment:
      - CMD_URI=https://seu-dominio.com
      - DB_TYPE=postgres
      - DB_HOST=db
      - DB_PORT=5432
      - DB_USER=hedgedoc
      - DB_PASS=senha_hedgedoc
      - DB_NAME=hedgedoc
    ports:
      - '3000:3000'
    depends_on:
      - db

  db:
    image: postgres:latest
    environment:
      - POSTGRES_USER=hedgedoc
      - POSTGRES_PASSWORD=senha_hedgedoc
      - POSTGRES_DB=hedgedoc
    volumes:
      - db_data:/var/lib/postgresql/data

volumes:
  db_data:

3. Substitua seu-dominio.com pelo domínio real que usará para acessar o HedgeDoc.

Passo 2: Executando o HedgeDoc

1. Inicie o aplicativo do HedgeDoc usando Docker Compose:

docker-compose up -d

2. Verifique se o HedgeDoc está rodando corretamente consultando os logs:

docker-compose logs -f

3. Por padrão, o HedgeDoc estará acessível em http://seu-ip-do-servidor:3000. Para um ambiente de produção, é recomendado configurar um proxy reverso.

Passo 3: Configurando um Proxy Reverso com Nginx

1. Instale o Nginx:

sudo apt install -y nginx

2. Crie um novo arquivo de configuração para o HedgeDoc:

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

3. Adicione a seguinte configuração:

server {
    listen 80;
    server_name seu-dominio.com;

    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $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;
    }
}

4. Habilite a configuração:

sudo ln -s /etc/nginx/sites-available/hedgedoc /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl restart nginx

Passo 4: Protegendo o HedgeDoc com SSL

1. Para proteger sua instância do HedgeDoc, você pode usar o Let’s Encrypt. Instale o Certbot:

sudo apt install -y certbot python3-certbot-nginx

2. Execute o Certbot para obter SSL para seu domínio:

sudo certbot --nginx -d seu-dominio.com

Perguntas Frequentes

1. Quais são os benefícios de hospedar o HedgeDoc na sua própria infraestrutura?

Hospedar o HedgeDoc você garante controle total sobre seus dados e privacidade. Diferente de opções em nuvem, quando você se hospeda localmente, é possível gerenciar atualizações de segurança e personalizações conforme suas necessidades. Essa configuração é fundamental para desenvolvedores e entusiastas que precisam de conformidade com certos processos de tratamento de dados ou desejam integrar o HedgeDoc facilmente a sistemas maiores.

2. Posso rodar o HedgeDoc em um VPS de baixa especificação?

Sim, o HedgeDoc pode rodar eficientemente em um VPS de baixa especificação, desde que atenda aos requisitos do sistema. Para operações básicas, um VPS com 2 GB de RAM e espaço mínimo em disco é suficiente. No entanto, para instâncias maiores ou múltiplos colaboradores, considere um VPS com pelo menos 4 GB de RAM e 50 GB de espaço em disco para garantir desempenho suave. Os preços de provedores como Contabo e Hetzner oferecem essa capacidade de forma acessível.

3. Como faço para atualizar minha instalação do HedgeDoc?

A atualização do HedgeDoc é simples graças à sua configuração com Docker. Basta puxar a última imagem e reiniciar os containers. Veja os comandos:

docker-compose pull
docker-compose up -d

Após executar esses comandos, é importante verificar regularmente as notas de lançamento do HedgeDoc para eventuais mudanças ou passos de migração necessários, garantindo operação contínua. Você pode consultar a documentação do HedgeDoc para detalhes específicos sobre atualizações de versão.

Conclusão

Hospedar o HedgeDoc em um VPS permite que você usufrua de um editor de markdown poderoso enquanto mantém controle total sobre seu ambiente. Com as etapas descritas acima, agora você pode instalar, configurar e proteger seu HedgeDoc de forma eficaz. Aproveite a colaboração em tempo real sem comprometer privacidade ou integridade dos dados. --- FIM ---