개발용 Windows에 Discourse 설치하기

[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
• libvips
• 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!

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

bin/dev --only ember

This starts the frontend bundler; the app remains served from http://localhost:3000.

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
You must use Bundler 2 or greater with this lockfile.
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)
    You don't have write permissions for the /var/lib/gems/2.5.0 directory.
ux430uq@Asus-UX430UQ:~/discourse$
ux430uq@Asus-UX430UQ:~/discourse$ sudo gem install bundler
[sudo] password for ux430uq:
Fetching: bundler-2.4.20.gem (100%)
ERROR:  Error installing bundler:
        The last version of bundler (>= 0) to support your Ruby & RubyGems was 2.3.26. Try installing it with `gem install bundler -v 2.3.26`
        bundler requires Ruby version >= 2.6.0. The current ruby version is 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의 최신 빌드에서도 작동할 것으로 생각합니다.

누군가에게 도움이 될 수 있다면, 가이드를 여기에 게시했습니다:

Windows 11에서 Discourse 개발 환경 설정 가이드

여러분 안녕하세요, Windows 11 / WSL2 환경에서 동작하는 개발 환경을 설정하기 위해 시간을 보낸 끝에, 제가 따랐던 단계를 공유하고자 합니다. 여기서 처음 글을 남기는 것이므로 누군가에게 도움이 되길 바랍니다 저는 Windows 환경에서 작업하는 데 익숙한 시스템 관리자라, Linux / Ruby / Discourse 등을 배우는 과정이 흥미로운 여정이었습니다. Windows 10 가이드가 작성된 이후 몇 가지 사항이 변경된 것 같았고, 진행 중 몇 가지 문제에 부딪혔습니다(댓글을 읽어보니 저만이 아니었네요!) 다음 지침이 제 Windows 11 Pro 22H2 설치 환경과, 곧 출시될 Windows 11 23H2 Release Preview의 Windows Insider 빌드에서도 정상적으로 작동함을 확인했습니다. 지침을 최대한 간결하고 직관적으로 유지하겠습니다 초기 준비 WSL 업데이트가 있는지 확인…

저처럼 Windows에서 Discourse를 실행하려는 분들에게 도움이 되기를 바랍니다.

[Canapin (Coin-coin le Canapin)]

지난번 시도 이후로 아무 문제가 없는지 확인하기 위해 이 공식 가이드를 처음부터 다시 확인해 보았습니다.
Windows 11에서 WSL을 통해 Ubuntu(버전 미지정)를 설치했는데, 이 경우 마지막 LTS 버전인 22.04가 설치되었습니다.

어떤 문제도 발생하지 않았습니다. 모든 과정이 순조로웠고, 오류도 없었으며 개발용 설치도 정상적으로 작동합니다.

앞으로 저희 공식 가이드를 사용하여 무언가를 설치하다가 문제가 발생하면, 오류 내용을 기록해 두셔서 저희에게 보고해 주십시오. 항상 유용합니다

---

다만 두 가지 경고가 있습니다:

Node.js를 설치할 때:

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

                           SCRIPT DEPRECATION WARNING


  This script, located at https://deb.nodesource.com/setup_X, used to
  install Node.js is deprecated now and will eventually be made inactive.

  Please visit the NodeSource distributions Github and follow the
  instructions to migrate your repo.
  https://github.com/nodesource/distributions

  The NodeSource Node.js Linux distributions GitHub repository contains
  information about which versions of Node.js and which Linux distributions
  are supported and how to install it.
  https://github.com/nodesource/distributions


                          SCRIPT DEPRECATION WARNING

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

TO AVOID THIS WAIT MIGRATE THE SCRIPT
Continuing in 60 seconds (press Ctrl-C to abort) ...

redis-server --daemonize yes를 실행할 때:

# WARNING Memory overcommit must be enabled! Without it, a background save or replication may fail under low memory condition. Being disabled, it can also cause failures without low memory condition, see https://github.com/jemalloc/jemalloc/issues/1328. To fix this issue add 'vm.overcommit_memory = 1' to /etc/sysctl.conf and then reboot or run the command 'sysctl vm.overcommit_memory=1' for this to take effect.

[AliBenBongo]

그때 왜 그렇게 많은 문제가 발생했는지 모르겠네요! 아마도 제 Windows 설치에 뭔가 이상한 점이 있었는데, 문제 해결을 하던 중에 모르게 고쳐버린 것 같습니다!

그래도 지금까지 배운 것에 대해 만족하고, 포럼을 Discourse로 이식하는 작업을 계속 진행하는 것을 기대하고 있습니다.

[Arkshine]

@Canapin

마지막 시도 이후로 아무 문제가 없는지 확인하기 위해 이 공식 가이드를 다시 한 번 정독했습니다.

Windows를 다시 설치해야 했으며, 이제 새 Windows 11이 설치된 상태입니다.
가이드를 따라 진행한 후 나중에 결과를 보고하겠습니다! @AliBenBongo님의 가이드도 염두에 두겠습니다.

[Arkshine]

추가 후속 답변입니다.

가이드는 확실히 업데이트가 필요하지만, 새로 설치한 Windows 11 22H2에서는 여전히 훌륭하게 작동합니다.

제가 겪은 유일한 문제는 터미널에서 wsl 명령이 정상적으로 작동했음에도 불구하고, WSL 기능이 기본적으로 활성화되어 있지 않았다는 점이었습니다:

[NateDhaliwal]

이 가이드가 오래된 것 같습니다. Ubuntu/Debian 가이드에 언급된 단계들은 더 이상 존재하지도 않습니다.

[NateDhaliwal]

이 모든 단계를 되돌리는 방법이 있을까요? 예를 들어 패키지, gem, 클론 설치 스크립트를 역순으로 실행하는 방식 같은 것 말입니다.

[TempAccount]

@Discourse

경고: 일부 설치 환경에서 20.04가 실패할 수 있으므로 Ubuntu 18.04를 설치하고 20.04는 설치하지 마세요.

여전히 20.04 대신 18.04를 설치해야 하나요?

nodejs 설치 시 다음 오류가 발생합니다:

# apt install nodejs

Reading package lists... Done
Building dependency tree
Reading state information... Done
Some packages could not be installed. This may mean that you have
requested an impossible situation or if you are using the unstable
distribution that some required packages have not yet been created
or been moved out of Incoming.
The following information may help to resolve the situation:

The following packages have unmet dependencies:
 nodejs : Depends: libc6 (>= 2.28) but 2.27-3ubuntu1.6 is to be installed
E: Unable to correct problems, you have held broken packages.```

[saros]

@Arkshine

해결책을 찾았습니다.

127.0.0.1을 localhost로 교체하면 이미지 문제가 해결되는 것을 확인했습니다.

검색해 본 결과, Diwsl을 시작하는 데 다음 명령어를 사용할 수 있습니다.

24.04 설치 실패, 호스트 머신에서 3000 포트에 연결할 수 없음

[merefield (Robert)]

저는 24.04에서 실행하고 있습니다. 서버를 시작했을 때 어떤 화면이 표시되는지에 대한 정보를 더 많이 공유하는 것을 권장합니다.

FORCE_HOSTNAME=localhost bin/ember-cli -u를 시도해 보세요. 이 명령은 백엔드와 프론트엔드 서버를 동시에 실행합니다.

(도로 위에서: 기억에 의존하여 작성)