Install Discourse on Windows for development

[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

На свежей установке Ubuntu 22 (Windows 10, WSL2) и успешной установке Discourse все изображения не загружаются на порту по умолчанию 4200.

Отлично, решение найдено.

Я заметил, что замена 127.0.0.1 на localhost исправляет проблему с изображениями.

После небольшого поиска вот команда, которую можно использовать для запуска Discourse:

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

---

Позже я постараюсь обновить руководство.

[Arkshine]

Есть ли возможность просмотреть этот PR?

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

Это сделало бы это руководство немного более дружелюбным.

[Will_S1 (Will S)]

Есть ли какие-то идеи, почему я получаю сообщение «К сожалению, произошла непредвиденная ошибка, и Bundler не может продолжить работу» после выполнения bundle install?

[D111 (D)]

та же проблема

[sam (Sam Saffron)]

Можете прислать скриншот ошибки? Какая версия Ruby у вас установлена?

[frocm]

У меня возникли проблемы с зависимостями:

ux430uq@Asus-UX430UQ:~/discourse$ bundle install
Для работы с этим lockfile-файлом необходимо использовать Bundler версии 2 или выше.
ux430uq@Asus-UX430UQ:~/discourse$ bundler -v
Bundler version 1.16.1

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

Fetching: bundler-2.4.20.gem (100%)
ERROR:  While executing gem ... (Gem::FilePermissionError)
    У вас нет прав на запись в каталог /var/lib/gems/2.5.0.
ux430uq@Asus-UX430UQ:~/discourse$
ux430uq@Asus-UX430UQ:~/discourse$ sudo gem install bundler
[sudo] пароль для ux430uq:
Fetching: bundler-2.4.20.gem (100%)
ERROR:  Error installing bundler:
        Последней версией bundler (>= 0), поддерживающей вашу Ruby и RubyGems, является версия 2.3.26. Попробуйте установить её командой `gem install bundler -v 2.3.26`
        bundler требует версию Ruby >= 2.6.0. Текущая версия Ruby — 2.5.0.
ux430uq@Asus-UX430UQ:~/discourse$ bundler -v
Bundler version 1.16.1
ux430uq@Asus-UX430UQ:~/discourse$

Как я могу легко исправить это? Я пытался установить версии 2.6.0, затем 2.7.0, но всегда возникали другие проблемы.

[AliBenBongo]

Как и некоторые ранее комментировавшие, я также столкнулся с трудностями и ошибками при попытке следовать этой инструкции — пробовал как на Windows 10, так и на Windows 11.

После ряда проб и ошибок я наконец нашёл шаги, которые позволяют создать полностью рабочую среду разработки под Windows 11. Это было протестировано на последней сборке 22H2, а также на предварительной версии релиза 23H2 (предполагаю, что это также будет работать на новейшей сборке Windows 10).

Если это кому-то пригодится, я только что опубликовал инструкцию здесь:

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…

Надеюсь, это поможет людям, таким как я, которые пытаются запустить Discourse под Windows

[Canapin (Coin-coin le Canapin)]

Я снова прошелся по всему этому официальному руководству, чтобы убедиться, что после моей предыдущей попытки ничего не сломалось.

Я установил Ubuntu (версия не указана) через WSL на Windows 11, в результате чего была установлена последняя LTS-версия — в данном случае 22.04.

У меня не возникло никаких проблем: всё прошло гладко, без ошибок, и установка разработчика работает корректно.

Если в будущем у вас возникнут трудности с установкой чего-либо по одному из наших официальных руководств, пожалуйста, записывайте ошибки и сообщайте нам об этом — это всегда полезно

---

Однако есть два предупреждения:

При установке Node.js:

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

                           ПРЕДУПРЕЖДЕНИЕ ОБ УСТАРЕВАНИИ СКРИПТА


  Этот скрипт, расположенный по адресу https://deb.nodesource.com/setup_X, который использовался
  для установки Node.js, теперь устарел и в конечном итоге будет отключён.

  Пожалуйста, посетите репозиторий NodeSource distributions на GitHub и следуйте
  инструкциям по миграции вашего репозитория.
  https://github.com/nodesource/distributions

  В репозитории GitHub NodeSource Node.js Linux distributions содержится
  информация о том, какие версии Node.js и какие дистрибутивы Linux
  поддерживаются, а также как их установить.
  https://github.com/nodesource/distributions


                          ПРЕДУПРЕЖДЕНИЕ ОБ УСТАРЕВАНИИ СКРИПТА

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

ЧТОБЫ ИЗБЕЖАТЬ ЭТОГО, ПЕРЕЙДИТЕ НА НОВЫЙ СКРИПТ
Продолжение через 60 секунд (нажмите Ctrl-C для прерывания) ...

При запуске redis-server --daemonize yes:

# ВНИМАНИЕ: необходимо включить переполнение памяти! Без этого фоновое сохранение или репликация могут завершиться неудачей при нехватке памяти. Отключение этой опции также может привести к сбоям даже при наличии достаточного объёма памяти. Подробнее см. https://github.com/jemalloc/jemalloc/issues/1328. Чтобы исправить эту проблему, добавьте 'vm.overcommit_memory = 1' в файл /etc/sysctl.conf, затем перезагрузите систему или выполните команду 'sysctl vm.overcommit_memory=1', чтобы изменения вступили в силу.

[AliBenBongo]

Не знаю, почему у меня тогда возникло столько проблем! Возможно, в моей установке Windows что-то было странное, и я случайно исправил это во время устранения неполадок, даже не осознав этого!

В любом случае, я доволен тем, что уже узнал, и с нетерпением жду продолжения работы по переносу моих форумов на Discourse.

[Arkshine]

@Coin-coin le Canapin

Я снова прошел весь этот официальный гайд, чтобы убедиться, что ничего не сломалось с момента моей последней попытки.

Мне пришлось переустановить Windows, и теперь у меня чистая установка Windows 11.
Я буду следовать гайду и позже отчитаюсь! Также буду иметь в виду гайд от @AliBenBongo.

[Arkshine]

Вот продолжение.

Конечно, руководство можно было бы обновить, но оно всё ещё отлично работает на чистой Windows 11 22H2.

Единственная проблема, с которой я столкнулся, заключалась в том, что, хотя команда wsl работала в терминале, функция WSL по умолчанию не была включена:

[NateDhaliwal]

Я думаю, что эта инструкция устарела. Шаги, упомянутые в руководстве для Ubuntu/Debian, больше даже не существуют.

[NateDhaliwal]

Есть ли способ отменить все эти действия, например, выполнить обратную установку скрипта пакетов, gem-библиотек и клонирования?

[TempAccount]

@Discourse

ВНИМАНИЕ: Установите Ubuntu 18.04, а не 20.04, так как некоторые установки не пройдут на 20.04.

Все еще требуется установка 18.04 вместо 20.04?

Получаю ошибку при установке nodejs:

# apt install nodejs

Чтение списков пакетов... Готово
Построение дерева зависимостей
Чтение информации о состоянии... Готово
Некоторые пакеты не могут быть установлены. Это может означать, что вы
запросили невозможную ситуацию или, если вы используете нестабильную
версию дистрибутива, некоторые требуемые пакеты еще не созданы
или были перемещены из Incoming.
Следующая информация может помочь разрешить ситуацию:

Следующие пакеты имеют неудовлетворенные зависимости:
 nodejs : Зависит: libc6 (>= 2.28), но будет установлен 2.27-3ubuntu1.6
E: Не удалось исправить проблемы, у вас есть заблокированные поврежденные пакеты.

[saros]

@Arkshine

Всё, я нашёл решение.

Я заметил, что замена 127.0.0.1 на localhost решает проблему с изображениями.

Поискал информацию и обнаружил, что для запуска Diwsl можно использовать следующую команду:

Установка на 24.04 не удалась, хост-машина не может подключиться к порту 3000

[merefield (Robert)]

У меня это работает на 24.04. Рекомендую поделиться более подробной информацией о том, что происходит при запуске сервера.

Попробуйте FORCE_HOSTNAME=localhost bin/ember-cli -u — это запустит одновременно серверы бэкенда и фронтенда.

(В пути: по памяти)