Acessar o HedgeDoc
- Abra a interface web do HedgeDoc:
https://<SERVER-IP> - Um aviso do navegador aparecerá porque um certificado autoassinado está sendo usado. Continue para o site para prosseguir.
- Clique em 'Entrar' e depois em 'Registrar' para criar sua conta.
Endpoints
- Aplicação principal:
https://<SERVER-IP>/(interface web) - Status:
https://<SERVER-IP>/status(página de verificação de saúde) - Métricas:
https://<SERVER-IP>/metrics(métricas do sistema) - WebSocket:
/socket.io/(comunicação em tempo real)
Registro
O registro de usuários está habilitado por padrão.
Para desabilitar o registro de novos usuários, altere CMD_ALLOW_EMAIL_REGISTER=true to CMD_ALLOW_EMAIL_REGISTER=false in /root/hedgedoc/.env.
Reinicie a aplicação para aplicar a alteração:
cd /root/hedgedoc
docker compose restart
Backup do banco de dados
Crie um backup do PostgreSQL:
cd /root/hedgedoc
docker compose exec database pg_dump hedgedoc -U hedgedoc > backup.sql
Ficheiros e diretórios importantes
- Caminho de instalação:
/root/hedgedoc - Arquivo Compose:
/root/hedgedoc/docker-compose.yml - Arquivo de ambiente:
/root/hedgedoc/.env - Configuração do Nginx:
/etc/nginx/sites-available/hedgedoc - Certificado SSL:
/etc/nginx/ssl/hedgedoc.crt - Chave SSL:
/etc/nginx/ssl/hedgedoc.key - Volume de uploads:
/var/lib/docker/volumes/hedgedoc_uploads/_data - Volume do banco de dados:
/var/lib/docker/volumes/hedgedoc_database/_data
Gerenciamento Docker
Verificar contêineres:
docker ps
Ver registos:
cd /root/hedgedoc
docker compose logs -f
Reiniciar os serviços:
cd /root/hedgedoc
docker compose restart
Parar serviços:
cd /root/hedgedoc
docker compose down
Iniciar serviços:
cd /root/hedgedoc
docker compose up -d
Gerenciamento do NGINX
Configuração do teste:
nginx -t
Reiniciar o NGINX:
systemctl restart nginx
Recarregar o NGINX:
systemctl reload nginx
Verificar o status do NGINX:
systemctl status nginx
Ativar SSL com um domínio
1. Aponte o seu domínio para o IP do servidor.
2. Edite a configuração do Nginx e substitua ambos server_name _; com o seu domínio (server_name <yourdomain.com>) para ambos os blocos HTTP (porta 80) e HTTPS (porta 443):
vim /etc/nginx/sites-available/hedgedoc
3. Instalar o Certbot:
apt install -y certbot python3-certbot-nginx
4. Execute o seguinte comando para gerar um certificado Let's Encrypt válido:
certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com
5. Substitua os caminhos SSL na configuração do Nginx:
vim /etc/nginx/sites-available/hedgedoc
# Before:
# ssl_certificate /etc/nginx/ssl/hedgedoc.crt;
# ssl_certificate_key /etc/nginx/ssl/hedgedoc.key;
# After:
# ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
# ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;
6. Recarregue o Nginx para aplicar as alterações:
systemctl reload nginx
7. Editar o /root/hedgedoc/.env para definir o nome do seu domínio: CMD_DOMAIN=yourdoamin.com
8. Recriar os serviços:
cd /root/hedgedoc
docker compose up -d
9. Abra o seu browser e visite: https://yourdomain.com
