Instalar o Discourse no Windows para desenvolvimento

[Discourse]

Este tutorial foi testado no Windows 10 e 11.

Para configurar um ambiente de desenvolvimento para o Discourse no Windows, você pode fazê-lo usando o recurso Windows Subsystem for Linux.

Esta configuração requer a instalação do WSL 2. Está disponível apenas em builds do Windows 10 18917 ou superiores. Vamos assumir que você já instalou o Windows Subsystem for Linux 2 (Ubuntu) em seu sistema Windows 10. AVISO: Instale o Ubuntu 18.04 e não o 20.04, pois algumas instalações falharão no 20.04. Para mais informações, veja as notas de 30 de junho de 2020 no final desta publicação.

Vamos começar!

Instalando o Discourse

1. Inicialmente, siga as etapas do tópico Guia para Iniciantes: Instalar o Discourse no Ubuntu para Desenvolvimento até a etapa Clonar o Discourse.

@techAPJ

Instalar Dependências do Discourse

Você precisará dos seguintes pacotes em seu sistema:

• Git
• rbenv ou asdf
• ruby-build
• Ruby (estável mais recente)
• Rails
• PostgreSQL
• SQLite
• Redis
• Node.js
• pnpm
• libvips
• MailHog**
• ImageMagick**

** opcional

Agora que instalamos as dependências do Discourse, vamos avançar para a instalação do próprio Discourse.

2. Antes de configurar o banco de dados, você deve iniciar manualmente o serviço do PostgreSQL e o servidor Redis usando os seguintes comandos

   sudo service postgresql start
   redis-server --daemonize yes
   

3. Em seguida, siga todas as etapas restantes do guia do Ubuntu.

@techAPJ

Clonar o Discourse

Clone o repositório do Discourse na pasta ~/discourse:

git clone https://github.com/discourse/discourse.git ~/discourse

~ indica a pasta inicial, então o código-fonte do Discourse estará disponível em sua pasta inicial.

Configurar o Banco de Dados

Crie uma role com o mesmo nome do seu nome de usuário do sistema ubuntu:

sudo -u postgres createuser -s "$USER"

Inicializar o Discourse

Mude para a sua pasta do Discourse:

cd ~/discourse

Instale as gems necessárias

source ~/.bashrc
bundle install

Agora que você instalou as gems com sucesso, execute estes comandos:

bundle exec rake db:create
bundle exec rake db:migrate
RAILS_ENV=test bundle exec rake db:create db:migrate

Tente executar as especificações (specs):

bundle exec rake autospec

Todos os testes devem passar.

Inicie o servidor rails:

bundle exec rails server

Agora você deve ser capaz de se conectar ao seu aplicativo Discourse em http://localhost:3000 - experimente!

Em uma instância de terminal separada, navegue para a sua pasta discourse (cd ~/discourse) e execute:

bin/dev --only ember

Isso inicia o bundler do frontend; o aplicativo continua sendo servido em http://localhost:3000.

Criando um Comando para Iniciar o Discourse

Agora seu ambiente de desenvolvimento está quase pronto. O único problema é que, toda vez que você abre o Ubuntu no Windows, precisa iniciar o serviço do PostgreSQL e o servidor Redis manualmente. Não se preocupe, podemos ter uma solução alternativa criando um comando personalizado

cd ~

Crie um novo arquivo usando o comando nano start-discourse e cole o conteúdo abaixo, depois salve e saia.

#!/bin/bash

# para iniciar o PostgreSQL
sudo service postgresql start

# para iniciar o servidor Redis
redis-server --daemonize yes

Agora modifique o CHMOD usando o comando abaixo

chmod +x start-discourse

E copie o arquivo para a sua pasta bin

sudo cp start-discourse /usr/bin/

Está pronto. Agora, sempre que você abrir o bash do Ubuntu, basta executar o comando abaixo e começar a desenvolver

start-discourse

---

Alternativamente, se você estiver usando o Windows 10 enterprise, pro ou education edition, pode criar uma máquina virtual Linux no hyper-v para configurar o ambiente de desenvolvimento do Discourse.

Notas Sobre o Ambiente Windows

Até 30 de junho de 2020:

@AndreaHabib

Com a introdução do build 2004 do Windows 10 e do WSL 2, muitos de vocês podem encontrar alguns problemas, já que o Discourse agora requer o WSL 2 para funcionar de fato.
Para começar: Se você ainda não o fez, desejará atualizar seu sistema para o Windows 2004 (19041)
Nota: Não instale usando o Windows Update nas configurações do sistema, pois você pode receber erros durante a instalação. Também verifique se você está no Windows 1903 (18362) ou 1909 (18363); você pode pesquisar por isso usando winver.

• Vá para: Download Windows 10
• Clique no botão Atualizar Agora sob Windows 10 May 2020 Update para baixar o assistente de atualização e deixe-o instalar e terminar
• Se você receber algum erro, baixe a ferramenta de criação de mídia, execute-a e crie um pendrive inicializável (pelo menos 8GB de flash) e use-o para instalar o Windows.

Quando você terminar a instalação do Windows, precisará instalar o WSL 2 manualmente.
Mas primeiro, precisamos ter certeza de que 2 recursos estão habilitados:

• Virtual Machine Platform, que pode ser habilitado diretamente do seu Windows indo em Programas e Recursos e depois habilitando Recursos Opcionais em Ativar ou desativar recursos do Windows
• O outro é a Virtualização, que só pode ser habilitada a partir da sua BIOS. No entanto, essa opção pode variar de uma placa-mãe para outra. Ex: na AMD é chamada de SVM. Então, por favor, consulte a sua placa-mãe específica.

Agora que você habilitou ambos os recursos:

• Instale o Ubuntu 18.04 e não o 20.04, pois algumas instalações falharão no 20.04.
• Vá aqui e atualize o Kernel Linux: Link nas respostas
• Vá para este link e siga as etapas: Instalar o Windows Subsystem for Linux (WSL) no Windows 10 | Microsoft Docs
• Vá para o powershell (executar como administrador) e execute: wsl --set-version Ubuntu-18.04 2 ou wsl --set-version Ubuntu 2, dependendo da distro que aparecer em wsl -l -v
• A conversão leva tempo, alguns minutos
• Execute wsl -l -v para ter certeza de que o Ubuntu está executando no WSL 2

Agora você pode executar o Ubuntu-18.04 ou o Windows Terminal com o Ubuntu e começar a instalar as dependências e ferramentas

Nota: Se você estiver encontrando um erro ao instalar uma das gems durante o bundle install: Verifique se você está no Ubuntu-18.04 e não no 20.04

No entanto, se você já tiver o postgreSQL 12 e estiver executando na porta 5432, pode encontrar alguns problemas, pois as dependências instalam o postgreSQL 10, o que pode incrementar a porta para 5433.
Para corrigir isso:

• Abra sua pasta em um editor de texto (por exemplo, VS Code)
• Vá para config/database.yml
• Sob development e sob adapter, adicione uma nova linha e depois adicione: port: 5433
• Verifique se você faz o mesmo para test e profile.

Se o acima não funcionar, verifique se o PostgreSQL está em execução e em qual porta via pg_isready. Depois, siga as mesmas instruções acima, definindo a porta igual àquela em que o banco de dados está em execução.

PARA O KERNEL LINUX: Atualizando o kernel Linux do WSL 2 | Microsoft Docs

@RickyC0626

Uma solução que não requer configuração explícita de porta em database.yml

Alguns erros durante a criação e migração do banco de dados:

Conexão Redis inválida para uma porta específica / recusa de conexão

bundle exec rake db:create

rake aborted!
Redis::CannotConnectError: Error connecting to Redis on localhost:6379 (Errno::ECONNREFUSED)
...

Caused by:
Errno::ECONNREFUSED: Connection refused - connect(2) for 127.0.0.1:6379
...

Caused by:
IO::EINPROGRESSWaitWritable: Operation now in progress - connect(2) would block
...

Tasks: TOP => db:create => db:load_config => environment
(See full trace by running task with --trace)

A partir deste erro, podemos ver que a porta usada pelo Redis é 6379, e podemos corrigir isso iniciando o servidor Redis por essa porta.

Por padrão, redis-server --daemonize yes deve funcionar, mas se não funcionar, use:

redis-server --daemonize yes --port 6379

Verifique o status da instância do Redis:

redis-cli

127.0.0.1:6379> ping
PONG

Conexão inválida para a porta psql

bundle exec rake db:migrate

PG::ConnectionBad: could not connect to server: No such file or directory
       Is the server running locally and accepting
       connections on Unix domain socket "/var/run/postgresql/.s.PGSQL.5432"?

A partir deste erro, podemos ver que o PostgreSQL está tendo problemas para se conectar à porta 5432. Normalmente, iniciar o serviço deve funcionar

sudo service postgresql start

Se isso ainda não funcionar e o erro persistir, tente verificar em qual porta o serviço está ouvindo e, se necessário, altere a porta para a que você deseja em postgresql.conf:

pg_isready

/var/run/postgresql:5432 - no response
or
/var/run/postgresql:5432 - accepting connections

---

O Resultado

Depois de fazer o acima ou executar o comando start-discourse, as duas instâncias devem ser executadas em suas portas padrão/especificadas. Para verificar seu status via o terminal cmd padrão do Windows, podemos executar:

netstat -anop tcp

que mostrará algo assim:

Proto    Local Address        Foreign Address        State            PID
TCP      127.0.0.1:5432       0.0.0.0:0              LISTENING        17768
TCP      127.0.0.1:6379       0.0.0.0:0              LISTENING        17768

Agora confirmamos que ambas as nossas instâncias postgresql e redis-server estão em execução.

Também podemos verificar o status das instâncias no Ubuntu ou WSL, com os seguintes comandos:

lsof -i

COMMAND     PID        USER  FD  TYPE  DEVICE  SIZE/OFF  NODE  NAME
mailcatch  3244  rickyc0626  7u  IPv4   36127       0t0   TCP  localhost:1025 (LISTEN)
mailcatch  3244  rickyc0626  8u  IPv4   36128       0t0   TCP  *:socks (LISTEN)
redis-ser  3287  rickyc0626  6u  IPv6   29352       0t0   TCP  *:6379 (LISTEN)
redis-ser  3287  rickyc0626  7u  IPv6   29353       0t0   TCP  *:6379 (LISTEN)

---

sudo ss -plunt | grep postgres

tcp  LISTEN  0  128  127.0.0.1:5432  0.0.0.0:*  users:(("postgres",pid=3070,fd=7))

---

pg_lsclusters

Ver Cluster Port Status Owner    Data directory              Log file
10  main    5432 online postgres /var/lib/postgresql/10/main /var/log/postgresql/postgresql-10-main.log

---

A partir daqui, estes comandos devem funcionar sem grandes problemas, sem a necessidade de modificar o arquivo database.yml:

bundle exec rake db:create
bundle exec rake db:migrate
RAILS_ENV=test bundle exec rake db:create db:migrate

Qualquer problema adicional que surja pode ser tratado no futuro.

Até 1 de julho de 2020

@RickyC0626

Uma solução que não requer configuração explícita de porta em database.yml

Alguns erros durante a criação e migração do banco de dados:

Conexão Redis inválida para uma porta específica / recusa de conexão

bundle exec rake db:create

rake aborted!
Redis::CannotConnectError: Error connecting to Redis on localhost:6379 (Errno::ECONNREFUSED)
...

Caused by:
Errno::ECONNREFUSED: Connection refused - connect(2) for 127.0.0.1:6379
...

Caused by:
IO::EINPROGRESSWaitWritable: Operation now in progress - connect(2) would block
...

Tasks: TOP => db:create => db:load_config => environment
(See full trace by running task with --trace)

A partir deste erro, podemos ver que a porta usada pelo Redis é 6379, e podemos corrigir isso iniciando o servidor Redis por essa porta.

Por padrão, redis-server --daemonize yes deve funcionar, mas se não funcionar, use:

redis-server --daemonize yes --port 6379

Verifique o status da instância do Redis:

redis-cli

127.0.0.1:6379> ping
PONG

Conexão inválida para a porta psql

bundle exec rake db:migrate

PG::ConnectionBad: could not connect to server: No such file or directory
       Is the server running locally and accepting
       connections on Unix domain socket "/var/run/postgresql/.s.PGSQL.5432"?

A partir deste erro, podemos ver que o PostgreSQL está tendo problemas para se conectar à porta 5432. Normalmente, iniciar o serviço deve funcionar

sudo service postgresql start

Se isso ainda não funcionar e o erro persistir, tente verificar em qual porta o serviço está ouvindo e, se necessário, altere a porta para a que você deseja em postgresql.conf:

pg_isready

/var/run/postgresql:5432 - no response
or
/var/run/postgresql:5432 - accepting connections

---

O Resultado

Depois de fazer o acima ou executar o comando start-discourse, as duas instâncias devem ser executadas em suas portas padrão/especificadas. Para verificar seu status via o terminal cmd padrão do Windows, podemos executar:

netstat -anop tcp

que mostrará algo assim:

Proto    Local Address        Foreign Address        State            PID
TCP      127.0.0.1:5432       0.0.0.0:0              LISTENING        17768
TCP      127.0.0.1:6379       0.0.0.0:0              LISTENING        17768

Agora confirmamos que ambas as nossas instâncias postgresql e redis-server estão em execução.

Também podemos verificar o status das instâncias no Ubuntu ou WSL, com os seguintes comandos:

lsof -i

COMMAND     PID        USER  FD  TYPE  DEVICE  SIZE/OFF  NODE  NAME
mailcatch  3244  rickyc0626  7u  IPv4   36127       0t0   TCP  localhost:1025 (LISTEN)
mailcatch  3244  rickyc0626  8u  IPv4   36128       0t0   TCP  *:socks (LISTEN)
redis-ser  3287  rickyc0626  6u  IPv6   29352       0t0   TCP  *:6379 (LISTEN)
redis-ser  3287  rickyc0626  7u  IPv6   29353       0t0   TCP  *:6379 (LISTEN)

---

sudo ss -plunt | grep postgres

tcp  LISTEN  0  128  127.0.0.1:5432  0.0.0.0:*  users:(("postgres",pid=3070,fd=7))

---

pg_lsclusters

Ver Cluster Port Status Owner    Data directory              Log file
10  main    5432 online postgres /var/lib/postgresql/10/main /var/log/postgresql/postgresql-10-main.log

---

A partir daqui, estes comandos devem funcionar sem grandes problemas, sem a necessidade de modificar o arquivo database.yml:

bundle exec rake db:create
bundle exec rake db:migrate
RAILS_ENV=test bundle exec rake db:create db:migrate

Qualquer problema adicional que surja pode ser tratado no futuro.

---

Última revisão por @SaraDev em 2022-06-16T02:00:00Z

---

Este documento é controlado por versão - sugira alterações no github.