Hospedagem de elementos web no Nginx com um servidor doméstico personalizado

Para hospedar um cliente Element Web personalizado no Nginx, baixe uma versão oficial pré-compilada do Element Web, coloque seus arquivos estáticos em seu servidor web, configure-o config.jsoncom seu servidor Matrix e sirva o site via HTTPS. O Nginx não executa o Element em si: ele serve os arquivos do aplicativo do navegador, enquanto o aplicativo se conecta separadamente ao seu servidor Matrix. Use nomes de host diferentes para o cliente e o servidor Matrix, como `<nome_do_cliente>` e `<nome_do_servidor> chat.example.com` matrix.example.com.

Este guia pressupõe o uso de Debian ou Ubuntu, um servidor Nginx com um nome DNS público e um servidor Matrix existente acessível via HTTPS. Ele utiliza o arquivo de lançamento oficial em vez de uma versão de desenvolvimento. A documentação atual do projeto Element descreve o aplicativo web implantado como conteúdo estático e requer configurações importantes e URLs de entrada para evitar o cache. Consulte as notas de lançamento e a documentação de configuração atual ao escolher uma versão ou alterar opções.

1. Prepare o nome do host e o servidor.

Crie um registro A chat.example.comapontando para o endereço IPv4 público do servidor Nginx. Adicione um registro AAAA somente se o servidor for acessível via IPv6. Permita o tráfego de entrada nas portas TCP 80 e 443 através do firewall do host e do firewall da nuvem. Confirme se essas portas já não estão sendo utilizadas por outro servidor web.

Instale o Nginx e crie um diretório para o aplicativo web:

sudo apt update
sudo apt install nginx
sudo mkdir -p /var/www/element

Em outra máquina, abra a página oficial de lançamentos do Element Web e escolha uma versão estável publicada. Baixe o arquivo web pré-compilado e transfira-o para o servidor. Evite usar a developbranch principal ou uma versão de desenvolvimento (nightly build) para um serviço público, a menos que você pretenda executar um software em versão prévia.

2. Instale os arquivos estáticos e configure o servidor doméstico.

Primeiro, extraia o arquivo de lançamento para um diretório temporário. Inspecione o layout de nível superior do arquivo e, em seguida, copie seus arquivos web para o diretório `/etc/web` /var/www/element, preservando a estrutura de diretórios do lançamento. O layout do pacote pode mudar, portanto, certifique-se de que o diretório `/etc/web` index.html, os pacotes (bundles), o arquivo ` i18n/etc/web` e o arquivo de configuração estejam localizados no diretório raiz do Nginx.

sudo mkdir -p /tmp/element-release
tar -xzf /tmp/element-web-REPLACE_WITH_RELEASE.tar.gz -C /tmp/element-release
find /tmp/element-release -maxdepth 2 -name index.html

Use o diretório que contém o arquivo index.htmlcomo origem ao copiar o conteúdo da versão para /var/www/element. Se o arquivo tiver um diretório raiz versionado, copie o conteúdo desse diretório em vez de criar um nível aninhado adicional. Não substitua uma implantação em produção até que os novos arquivos estejam completos; uma cópia incompleta pode deixar os usuários com pacotes JavaScript ausentes.

Copie o arquivo de lançamento config.sample.jsonpara o config.jsondiretório, caso o arquivo o forneça, e edite o novo arquivo. O Element precisa de uma configuração de conexão padrão com o servidor doméstico para iniciar. O formato preferencial suportado é `http://localhost:8080` default_server_config, usando a URL base da API do cliente. O exemplo abaixo é ilustrativo; substitua a URL pela URL real servida pelo seu servidor doméstico Matrix:

{
  "default_server_config": {
    "m.homeserver": {
      "base_url": "https://matrix.example.com"
    }
  },
  "brand": "Example Chat"
}

A documentação de configuração do Element também oferece suporte a `--request -url` default_server_name, que depende da .well-knowndescoberta do Matrix. Use `--request default_server_config-url` quando quiser especificar diretamente a URL do servidor principal. Não inclua senhas, tokens de acesso, chaves de assinatura ou outros segredos neste arquivo JSON público. A brandopção `--request-url` altera alguns rótulos de aplicativos; não se trata de uma rebranding completa.

3. Configure o Nginx para o aplicativo.

Crie um bloco de servidor Nginx como este /etc/nginx/sites-available/element. Substitua o domínio, se necessário. Esta configuração simples serve o Element como arquivos estáticos e envia os caminhos ausentes para `/etc/element/` index.html, enquanto marca todas as respostas para revalidação. Essa política de cache conservadora evita que os usuários recebam um shell de aplicativo ou uma configuração desatualizada após uma versão; você pode ajustar o cache de recursos posteriormente, caso seu processo de implantação preserve os caminhos obrigatórios do Element que não devem ser armazenados em cache.

server {
    listen 80;
    listen [::]:80;
    server_name chat.example.com;

    root /var/www/element;
    index index.html;

    location / {
        try_files $uri $uri/ =404;
        add_header Cache-Control "no-cache" always;
        add_header X-Frame-Options SAMEORIGIN always;
        add_header X-Content-Type-Options nosniff always;
        add_header Content-Security-Policy "frame-ancestors 'self'" always;
    }
}

As notas de hospedagem da Element recomendam não armazenar em cache os cabeçalhos `<head> /config.*.json`, /i18n` /version<body>` ou ` /index.html<span>`, e sugerem a revalidação do navegador ao carregar a página. O exemplo se aplica no-cachea tudo como um ponto de partida simples. Ele também inclui os cabeçalhos de segurança recomendados pela Element, incluindo uma política de frames e proteção contra MIME-sniffing. Se você já definiu uma Política de Segurança de Conteúdo (CSP) em outro lugar, mescle-a frame-ancestors 'self'com essa política em vez de enviar políticas conflitantes.

Habilite o site e valide o Nginx antes de recarregá-lo:

sudo ln -s /etc/nginx/sites-available/element /etc/nginx/sites-enabled/element
sudo nginx -t
sudo systemctl reload nginx

4. Adicione HTTPS e teste o cliente.

O conteúdo deve ser servido via HTTPS. Assim que o DNS resolver para este servidor e a porta 80 estiver acessível, instale o Certbot seguindo as instruções específicas para a sua distribuição. Em seguida, solicite e instale um certificado utilizando a integração com o Nginx. O projeto Certbot documenta o certbot --nginxfluxo e as verificações de renovação; a instalação do pacote varia conforme o sistema operacional, portanto, utilize as instruções do Nginx específicas para a sua versão. Se o Certbot editar o bloco de servidor, execute o comando sudo nginx -tnovamente e confirme se a renovação está agendada.

Abra https://chat.example.comem uma janela anônima do navegador. A tela de login do Element deve carregar sem scripts ou estilos ausentes, exibir o servidor home esperado e ter um ícone de cadeado válido na barra de endereço do navegador. Faça login com uma conta de teste e confirme se o navegador consegue acessar o servidor home. Se o login falhar, verifique o console do desenvolvedor e o painel de rede do navegador em busca de solicitações bloqueadas, erros de certificado ou um endereço IP incorreto base_url.

Problemas comuns de implantação

  • Uma página em branco ou parcialmente carregada: verifique se o Nginx rootaponta para o diretório que contém o arquivo .bashrc index.htmle se os pacotes e i18no diretório foram copiados junto com ele.
  • O servidor inicial incorreto está sendo exibido: valide a sintaxe JSON config.jsone confirme se o arquivo está na raiz da web. Se você configurar um arquivo específico do domínio config.chat.example.com.json, o Element tentará usar esse arquivo antes do arquivo principal config.json; os arquivos não serão mesclados.
  • Os usuários visualizam as configurações antigas após uma atualização: certifique-se de que os parâmetros ` <nome_do_arquivo>`, index.html... e o JSON de configuração não estejam em cache. Limpe ou revalide o cache do navegador após alterar a política do Nginx.versioni18n
  • A página de login carrega, mas as requisições à API falham: verifique se a URL do servidor principal está correta, se utiliza HTTPS e se está configurada para acesso via navegador, incluindo o comportamento CORS apropriado quando necessário. O Hosting Element no Nginx não atua como proxy nem substitui o servidor principal do Matrix.

Para uma implementação bem-sucedida, o cliente é carregado no domínio personalizado via HTTPS, sua configuração aponta para o servidor de destino e uma conta de teste consegue fazer login sem falhas nas requisições de rede. As notas de hospedagem web da Element e a documentação do índice Nginx são as principais referências para a implementação estática e o comportamento do bloco de servidor descritos aqui.

Deixar um comentário

Restaure o Matrix Synapse com segurança usando um dump do PostgreSQL.

Faça backup do Synapse com pg_dump, proteja sua chave de assinatura e mídia e restaure-o em um banco de dados PostgreSQL limpo, sem reutilizar chaves de uso único obsoletas.

Execute o Mjölnir como um bot de moderação de salas Matrix com Docker.

Execute o Mjölnir como um bot de moderação de salas Matrix com Docker.

Configure o Mjölnir com uma conta Matrix dedicada, sala de gerenciamento criptografada, Docker Compose, lista de políticas e verificações de permissão.

Ative a sincronização deslizante nativa da matriz para um carregamento mais rápido em dispositivos móveis.

Ative a sincronização deslizante nativa da matriz para um carregamento mais rápido em dispositivos móveis.

Ignore o proxy descontinuado e configure a Sincronização Deslizante integrada do Synapse. Verifique a descoberta de clientes e, em seguida, meça o carregamento da lista de salas e o comportamento de reconexão em um telefone compatível.

Hospedagem de elementos web no Nginx com um servidor doméstico personalizado

Implante o Element Web como um site estático, aponte-o para o seu servidor Matrix, adicione HTTPS e configure o Nginx para servir atualizações sem arquivos obsoletos.

Execute um servidor doméstico Matrix leve no Raspberry Pi 4

Configure o Conduit em um Raspberry Pi 4 de 64 bits com dados persistentes, federação HTTPS, registro protegido e verificações para um servidor doméstico em funcionamento.

Configure um alias personalizado para a sala Matrix em seu próprio domínio.

Atribua um endereço fácil de compartilhar a uma sala do Matrix em seu domínio usando o Element ou a API do Matrix, com verificações de permissões, nomenclatura Synapse e federação.

Configure o Coturn para chamadas de voz e vídeo confiáveis ​​no Remake Matrix.

Configure o coturn e o Synapse com credenciais TURN correspondentes, abra as portas de retransmissão necessárias e verifique se os clientes Matrix conseguem obter candidatos de retransmissão.

Implante o Matrix Synapse com Docker Compose e PostgreSQL.

Implante o Matrix Synapse com Docker Compose e PostgreSQL.

Configure um servidor doméstico Synapse persistente com Docker Compose, PostgreSQL, uma configuração privada e verificações antes de expô-lo via HTTPS.

Personalize o tema e a identidade visual do Element Web.

Defina um nome de marca, cores personalizadas e recursos de login para sua implementação do Element Web, entendendo quais partes permanecerão com a marca Element.

Aumente o limite de arquivos do Systemd do Synapse sem complicações.

Aumente o limite de arquivos do Systemd do Synapse sem complicações.

Diagnostique se o Synapse atingiu seu limite de arquivos abertos por processo, configure um comando systemd para o serviço ou worker correto e verifique o limite em tempo real.