Instala Discourse en Windows para desarrollo

[Discourse]

This tutorial has been tested on Windows 10 and 11.

To set up a development environment for Discourse on Windows, you can do it using Windows Subsystem for Linux feature.

This setup requires the WSL 2 installation. It is only available in Windows 10 builds 18917 or higher. We’ll assume that you already installed Windows Subsystem for Linux 2 (Ubuntu) on your Windows 10 system. WARNING: Install Ubuntu 18.04, and not 20.04 since some installations will fail on 20.04. For more information see June 30th, 2020 notes at the bottom of this post.

Let’s begin!

Installing Discourse

1. Initially follow the steps from the topic Beginners Guide to Install Discourse on Ubuntu for Development until the step Clone Discourse.

@techAPJ

Install Discourse Dependencies

You will need the following packages on your system:

• Git
• rbenv or asdf
• ruby-build
• Ruby (latest stable)
• Rails
• PostgreSQL
• SQLite
• Redis
• Node.js
• pnpm
• MailHog**
• ImageMagick**

** optional

Now that we have installed Discourse dependencies, let’s move on to install Discourse itself.

2. Before setting up the database you have to start PostgreSQL service & Redis server manually using following commands

   sudo service postgresql start
   redis-server --daemonize yes
   

3. Then go through all the remaining steps of the Ubuntu guide.

@techAPJ

Clone Discourse

Clone the Discourse repository in ~/discourse folder:

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

~ indicates home folder, so Discourse source code will be available in your home folder.

Setup Database

Create role with the same name as your ubuntu system username:

sudo -u postgres createuser -s "$USER"

Bootstrap Discourse

Switch to your Discourse folder:

cd ~/discourse

Install the needed gems

source ~/.bashrc
bundle install

Now that you have successfully installed gems, run these commands:

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

Try running the specs:

bundle exec rake autospec

All the tests should pass.

Start rails server:

bundle exec rails server

You should now be able to connect with your Discourse app on http://localhost:3000 - try it out!

Starting with Discourse 2.5+ EmberCLI is required in development and these additional steps will be required:

In a separate terminal instance, navigate to your discourse folder (cd ~/discourse) and run:

bin/ember-cli

You should now be able to navigate to http://localhost:4200 to see your local Discourse installation.

Creating a Command to Start Discourse

Now your development environment is almost ready. The only problem is every time when you open Ubuntu on Windows you have to start the PostgreSQL service & Redis server manually. Don’t worry we can have a workaround for this by creating a custom command

cd ~

Create a new file using the command nano start-discourse and paste the content below then save and exit.

#!/bin/bash

# to start PostgreSQL
sudo service postgresql start

# to start Redis server
redis-server --daemonize yes

Now modify the CHMOD using below command

chmod +x start-discourse

And copy the file to your bin folder

sudo cp start-discourse /usr/bin/

It’s done. Now, whenever you open the Ubuntu bash just run the command below and start developing

start-discourse

---

Alternatively, if you are using Windows 10 enterprise, pro, or education edition then you can create a Linux virtual machine in hyper-v to set up the Discourse dev environment.

Notes About Windows Environment

As of June 30, 2020:

@AndreaHabib

With the introduction of Windows 10 build 2004 and WSL 2 and many of you might run into some issues since Discourse now requires WSL 2 to actually run.
For starters: If you haven’t already, you would want to update your system to Windows 2004 (19041)
Note: Don’t install using Windows Update in the system settings as you might get errors mid-installation. Also make sure you are on Windows 1903 (18362) or 1909 (18363), you can search winver for that.

• Go to: Download Windows 10
• Click the Update Now button under Windows 10 May 2020 Update to download the update assistant and let it install and finish
• If you get any errors, then download the media creation tool, run it, and create a bootable flash drive (at least 8GB flash) and use it to install Windows.

When you are done with the Windows installation, you will need to manually install WSL 2
But first, we need to make sure that 2 features are enabled:

• Virtual Machine Platform which can be enabled directly from your Windows by going to Programs and Features and then enabling Optional Features in Turn Windows features on or off
• The other is Virtualization which can be only enabled from your BIOS. However this option can vary from one motherboard to the other. eg: on AMD it’s called SVM. So please look up your specific motherboard.

Now that you have both features enabled:

• Install Ubuntu 18.04, and not 20.04 since some installations will fail on 20.04.
• Go here and update Linux Kernel: Link in replies
• Go to this link and follow the steps: Install Windows Subsystem for Linux (WSL) on Windows 10 | Microsoft Docs
• Go to powershell (run as administrator) and run: wsl --set-version Ubuntu-18.04 2 or wsl --set-version Ubuntu 2, whichever distro shows up in wsl -l -v
• Conversion takes time, a few minutes
• Run wsl -l -v to make sure that Ubuntu is running on WSL 2

Now you can run Ubuntu-18.04 or Windows Terminal with Ubuntu and start installing the dependencies and tools

Note: If you are running into an error installing one of the gems during bundle install: Make sure you are on Ubuntu-18.04 and not 20.04

However, if you already have postgreSQL 12 and running on port 5432, you might run into some issues, since the dependencies install postgreSQL 10, which might increment the port to 5433.
To fix that:

• Open your folder in a text editor (VS Code for example)
• Go to config/database.yml
• Under development and under adapter, add a new line and then add: port: 5433
• Make sure you do the same for test and profile.

If the above doesn’t work, make sure to check if PostgreSQL is running and at which port via pg_isready. Then follow the same instructions above, setting the port equal to the one the database is running on.

FOR THE LINUX KERNEL: Updating the WSL 2 Linux kernel | Microsoft Docs

@RickyC0626

A solution that does not require explicit port configuration in database.yml

Some errors during database creation and migration:

Invalid Redis connection to a specific port / connection refusal

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)

From this error we can see that the port Redis uses is 6379, and we can fix this by starting the Redis server via that port.

By default, redis-server --daemonize yes should work, but if not, use:

redis-server --daemonize yes --port 6379

Check status of Redis instance:

redis-cli

127.0.0.1:6379> ping
PONG

Invalid connection to psql port

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"?

From this error we can see that PostgreSQL is having trouble connecting to port 5432. Usually starting the service should work

sudo service postgresql start

If this still doesn’t work and the error persists, try checking to see which port the service is listening from, and if necessary, change the port to the one you want in postgresql.conf:

pg_isready

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

---

The Result

Once we have done the above or executed the start-discourse command, the two instances should run on their default/specified ports. To check their status via the default Windows cmd terminal, we can run:

netstat -anop tcp

which will show something like this:

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

We have now confirmed that both our postgresql and redis-server instances are running.

We can also check the status of the instances on Ubuntu or WSL, with the following commands:

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

---

From here, these commands should work with no major issues, without needing to modify the database.yml file:

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

Any further issues that show up can be addressed in the future.

As of July 1, 2020

@RickyC0626

A solution that does not require explicit port configuration in database.yml

Some errors during database creation and migration:

Invalid Redis connection to a specific port / connection refusal

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)

From this error we can see that the port Redis uses is 6379, and we can fix this by starting the Redis server via that port.

By default, redis-server --daemonize yes should work, but if not, use:

redis-server --daemonize yes --port 6379

Check status of Redis instance:

redis-cli

127.0.0.1:6379> ping
PONG

Invalid connection to psql port

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"?

From this error we can see that PostgreSQL is having trouble connecting to port 5432. Usually starting the service should work

sudo service postgresql start

If this still doesn’t work and the error persists, try checking to see which port the service is listening from, and if necessary, change the port to the one you want in postgresql.conf:

pg_isready

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

---

The Result

Once we have done the above or executed the start-discourse command, the two instances should run on their default/specified ports. To check their status via the default Windows cmd terminal, we can run:

netstat -anop tcp

which will show something like this:

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

We have now confirmed that both our postgresql and redis-server instances are running.

We can also check the status of the instances on Ubuntu or WSL, with the following commands:

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

---

From here, these commands should work with no major issues, without needing to modify the database.yml file:

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

Any further issues that show up can be addressed in the future.

---

Last Reviewed by @SaraDev on 2022-06-16T02:00:00Z

---

This document is version controlled - suggest changes on github.

[Arkshine]

@Arkshine

En un Ubuntu 22 recién instalado (Windows 10, WSL2) y con una instalación exitosa de Discourse, todas las imágenes fallan al ser servidas en el puerto predeterminado 4200.

Bien, encontré una solución.

Noté que reemplazar 127.0.0.1 con localhost solucionaba las imágenes.

Después de buscar un poco, este es el comando que puedes usar para iniciar Discourse:

DISCOURSE_HOSTNAME=localhost UNICORN_LISTENER=localhost:3000 bin/ember-cli -u

---

Intentaré actualizar la guía más tarde.

[Arkshine]

¿Hay alguna posibilidad de revisar esta PR?

FIX: The PostgreSQL service not starting after installation (WSL2 context)

Eso haría esta guía un poco más amigable.

[Will_S1 (Will S)]

¿Alguna idea de por qué obtengo “Desafortunadamente, ocurrió un error inesperado y Bundler no puede continuar”. Después de bundle install?

[D111 (D)]

mismo problema

[sam (Sam Saffron)]

¿Puede proporcionar una captura de pantalla del error? ¿Qué versión de Ruby tiene instalada?

[frocm]

Tengo problemas con las dependencias:

ux430uq@Asus-UX430UQ:~/discourse$ bundle install
Debes usar Bundler 2 o superior con este lockfile.
ux430uq@Asus-UX430UQ:~/discourse$ bundler -v
Versión de Bundler 1.16.1

ux430uq@Asus-UX430UQ:~/discourse$ gem install bundler

Fetching: bundler-2.4.20.gem (100%)
ERROR:  Mientras se ejecutaba gem ... (Gem::FilePermissionError)
    No tienes permisos de escritura para el directorio /var/lib/gems/2.5.0.
ux430uq@Asus-UX430UQ:~/discourse$
ux430uq@Asus-UX430UQ:~/discourse$ sudo gem install bundler
[sudo] contraseña para ux430uq:
Fetching: bundler-2.4.20.gem (100%)
ERROR:  Error al instalar bundler:
        La última versión de bundler (>= 0) que admitía tu Ruby y RubyGems fue la 2.3.26. Intenta instalarla con `gem install bundler -v 2.3.26`
        bundler requiere la versión de Ruby >= 2.6.0. La versión actual de ruby es 2.5.0.
ux430uq@Asus-UX430UQ:~/discourse$ bundler -v
Versión de Bundler 1.16.1
ux430uq@Asus-UX430UQ:~/discourse$

¿Cómo puedo solucionarlo fácilmente? Estaba intentando instalar 2.6.0, luego 2.7.0, pero siempre hay otros problemas con esto.

[AliBenBongo]

Según algunos de los comentarios anteriores, yo también tuve algunas dificultades y errores al intentar seguir esta guía; probé tanto en un escritorio con Windows 10 como con Windows 11.

Después de un poco de prueba y error, finalmente tengo los pasos que resultan en un entorno de desarrollo completamente funcional en Windows 11, probado en la última compilación 22H2 y también en la próxima vista previa de lanzamiento 23H2 (supongo que también funcionará en la compilación más reciente de Windows 10).

Si a alguien le sirve, acabo de publicar la guía aquí:-

Guide to Setting Up Discourse Development Environment - Windows 11

Hi Everyone, After spending some time attempting to get a working development environment up and running under Windows 11 / WSL2 I thought I would share the steps that I have followed. This is my first post here so I hope that this is of use to somebody I am a Systems Administrator used to working with Windows so this has been an interesting journey learning Linux / Ruby / Discourse etc. A few things seem to have changed since the guide for Windows 10 was written and I ran into…

Espero que esto ayude a personas como yo que intentan ejecutar Discourse en Windows

[Canapin (Coin-coin le Canapin)]

Revisé esta guía oficial completa nuevamente para asegurarme de que nada se rompiera desde mi último intento.
Instalé Ubuntu (versión no especificada) a través de WSL en Windows 11, lo que instaló la última versión LTS, 22.04 en este caso.

No encontré ningún problema; todo fue sencillo, sin errores, y la instalación de desarrollo funciona.

Si tienes problemas para instalar algo usando una de nuestras guías oficiales en el futuro, por favor anota los errores y repórtalos, ¡siempre es útil!

---

Dos advertencias, sin embargo:

Al instalar Node.js:

================================================================================
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
================================================================================

                           ADVERTENCIA DE DESAPROBACIÓN DE SCRIPT


  Este script, ubicado en https://deb.nodesource.com/setup_X, que se usaba para
  instalar Node.js, ahora está obsoleto y eventualmente se desactivará.

  Por favor, visita el repositorio de Github de distribuciones de NodeSource y sigue las
  instrucciones para migrar tu repositorio.
  https://github.com/nodesource/distributions

  El repositorio de Github de distribuciones de Linux de NodeSource para Node.js contiene
  información sobre qué versiones de Node.js y qué distribuciones de Linux
  son compatibles y cómo instalarlo.
  https://github.com/nodesource/distributions


                          ADVERTENCIA DE DESAPROBACIÓN DE SCRIPT

================================================================================
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
================================================================================

PARA EVITAR ESTA ESPERA, MIGRAR EL SCRIPT
Continuando en 60 segundos (presiona Ctrl-C para abortar) ...

Al ejecutar redis-server --daemonize yes:

# ¡ADVERTENCIA! El overcommit de memoria debe estar habilitado. Sin él, un guardado en segundo plano o la replicación pueden fallar en condiciones de poca memoria. Al estar deshabilitado, también puede causar fallos sin condiciones de poca memoria, ver https://github.com/jemalloc/jemalloc/issues/1328. Para solucionar este problema, agrega 'vm.overcommit_memory = 1' a /etc/sysctl.conf y luego reinicia o ejecuta el comando 'sysctl vm.overcommit_memory=1' para que tenga efecto.

[AliBenBongo]

¡No estaba seguro de por qué tuve tantos problemas entonces! ¡Quizás había algo extraño en mi instalación de Windows que logré arreglar durante mi solución de problemas sin darme cuenta!

Aún así, todavía estoy contento con lo que he aprendido hasta ahora y espero seguir trabajando en la migración de mis foros a Discourse.

[Arkshine]

@Canapin

Volví a repasar esta guía oficial para asegurarme de que nada se rompiera desde mi último intento.

Tuve que reinstalar Windows y ahora tengo una instalación limpia de Windows 11.
Seguiré la guía y reportaré más tarde. Tendré en cuenta la guía de @AliBenBongo también.

[Arkshine]

Aquí tienes un seguimiento.

La guía seguramente necesita una actualización, pero todavía funciona de maravilla en una instalación limpia de Windows 11 22H2.

El único problema que tuve fue que, aunque el comando wsl funcionaba en una terminal, la característica WSL en realidad no estaba habilitada por defecto:

[NateDhaliwal]

Creo que esta guía está desactualizada. Los pasos mencionados en la guía de Ubuntu/Debian ya no existen.

[NateDhaliwal]

¿Hay alguna forma de deshacer todos estos pasos, por ejemplo, revertir el script de instalación de paquetes, gems y clonación?

[TempAccount]

@Discourse

ADVERTENCIA: Instala Ubuntu 18.04 y no 20.04, ya que algunas instalaciones fallarán en 20.04.

¿Sigue siendo necesario instalar 18.04 sobre 20.04?

Recibo un error al instalar nodejs:

# apt install nodejs

Leyendo lista de paquetes... Hecho
Creando árbol de dependencias