Installiere Discourse auf Windows für die Entwicklung

[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

Auf einem frischen Ubuntu 22 (Windows 10, WSL2) und einer erfolgreichen Discourse-Installation werden alle Bilder nicht auf dem Standardport 4200 ausgeliefert.

Okay, Lösung gefunden.

Mir ist aufgefallen, dass das Ersetzen von 127.0.0.1 durch localhost die Bilder reparieren würde.

Nach einigem Suchen ist dies der Befehl, mit dem Sie Discourse starten können:

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

---

Ich werde versuchen, die Anleitung später zu aktualisieren.

[Arkshine]

Gibt es eine Möglichkeit, diesen PR zu überprüfen?

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

Das würde diese Anleitung ein wenig benutzerfreundlicher machen.

[Will_S1 (Will S)]

Haben Sie eine Idee, warum ich nach bundle install\n die Meldung „Leider ist ein unerwarteter Fehler aufgetreten, und Bundler kann nicht fortfahren.“ erhalte?

[D111 (D)]

Gleiches Problem

[sam (Sam Saffron)]

Können Sie einen Screenshot des Fehlers bereitstellen? Welche Ruby-Version ist installiert?

[frocm]

Ich habe Probleme mit Abhängigkeiten:

ux430uq@Asus-UX430UQ:~/discourse$ bundle install
Sie müssen Bundler 2 oder höher mit dieser Lockfile verwenden.
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)
    Sie haben keine Schreibberechtigungen für das Verzeichnis /var/lib/gems/2.5.0.
ux430uq@Asus-UX430UQ:~/discourse$
ux430uq@Asus-UX430UQ:~/discourse$ sudo gem install bundler
[sudo] Passwort für ux430uq:
Fetching: bundler-2.4.20.gem (100%)
ERROR:  Error installing bundler:
        Die letzte Version von bundler (>= 0), die Ihre Ruby- & RubyGems-Version unterstützt, war 2.3.26. Versuchen Sie, sie mit `gem install bundler -v 2.3.26` zu installieren.
        bundler erfordert Ruby-Version >= 2.6.0. Die aktuelle Ruby-Version ist 2.5.0.
ux430uq@Asus-UX430UQ:~/discourse$ bundler -v
Bundler version 1.16.1
ux430uq@Asus-UX430UQ:~/discourse$

Wie kann ich das einfach beheben? Ich habe versucht, 2.6.0 und dann 2.7.0 zu installieren, aber es gab immer wieder andere Probleme.

[AliBenBongo]

Wie in einigen der früheren Kommentare erwähnt, hatte ich auch einige Schwierigkeiten und Fehler, als ich versuchte, dieser Anleitung zu folgen – getestet auf einem Windows 10- und einem Windows 11-Desktop.

Nach einiger Ausprobiererei habe ich endlich Schritte gefunden, die zu einer voll funktionsfähigen Entwicklungsumgebung unter Windows 11 führen, getestet auf dem neuesten Build 22H2 und auch auf der kommenden 23H2 Release Preview (ich gehe davon aus, dass es auch auf dem neuesten Build von Windows 10 funktionieren wird).

Wenn es jemandem nützt, habe ich die Anleitung gerade hier veröffentlicht:-

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…

Hoffentlich hilft das Leuten wie mir, die versuchen, Discourse unter Windows zum Laufen zu bringen

[Canapin (Coin-coin le Canapin)]

Ich habe diese gesamte offizielle Anleitung noch einmal durchgesehen, um sicherzustellen, dass seit meinem letzten Versuch nichts kaputt gegangen ist.
Ich habe Ubuntu (nicht spezifizierte Version) über WSL unter Windows 11 installiert, was die letzte LTS-Version, in diesem Fall 22.04, installiert hat.

Ich bin auf keine Probleme gestoßen; alles war unkompliziert, keine Fehler, und die Dev-Installation funktioniert.

Wenn Sie in Zukunft Probleme bei der Installation von etwas mit einer unserer offiziellen Anleitungen haben, schreiben Sie bitte die Fehler auf und melden Sie sie uns, das ist immer nützlich

---

Zwei Warnungen allerdings:

Bei der Installation von Node.js:

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

                           SCRIPT DEPRECATION WARNING


  Dieses Skript, das sich unter https://deb.nodesource.com/setup_X befindet,
  wurde verwendet, um Node.js zu installieren, ist jetzt veraltet und wird
  schließlich inaktiviert.

  Besuchen Sie das NodeSource-Distributionen-Github und folgen Sie den
  Anweisungen zur Migration Ihres Repos.
  https://github.com/nodesource/distributions

  Das GitHub-Repository für NodeSource Node.js Linux-Distributionen enthält
  Informationen darüber, welche Versionen von Node.js und welche Linux-Distributionen
  unterstützt werden und wie die Installation erfolgt.
  https://github.com/nodesource/distributions


                          SCRIPT DEPRECATION WARNING

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

UM DIESE WARTEZEIT ZU VERMEIDEN, MIGRATEN SIE DAS SKRIPT
Fortsetzung in 60 Sekunden (drücken Sie Strg-C zum Abbrechen) ...

Beim Ausführen von redis-server --daemonize yes:

# WARNUNG Memory overcommit muss aktiviert sein! Ohne ihn kann ein Hintergrundspeichern oder eine Replikation unter geringem Arbeitsspeicher fehlschlagen. Wenn es deaktiviert ist, kann es auch ohne geringen Arbeitsspeicher zu Fehlern kommen. Siehe https://github.com/jemalloc/jemalloc/issues/1328. Um dieses Problem zu beheben, fügen Sie 'vm.overcommit_memory = 1' zu /etc/sysctl.conf hinzu und starten Sie dann neu oder führen Sie den Befehl 'sysctl vm.overcommit_memory=1' aus, damit dies wirksam wird.

[AliBenBongo]

Ich bin mir nicht sicher, warum ich dann so viele Probleme hatte! Vielleicht gab es etwas Seltsames in meiner Windows-Installation, das ich während meiner Fehlersuche behoben habe, ohne es zu merken!

Ich bin aber immer noch zufrieden mit dem, was ich bisher gelernt habe, und freue mich darauf, weiterhin daran zu arbeiten, meine Foren nach Discourse zu migrieren.

[Arkshine]

@Canapin

Ich habe diesen gesamten offiziellen Leitfaden noch einmal durchgesehen, um sicherzustellen, dass seit meinem letzten Versuch nichts kaputt gegangen ist.

Ich musste Windows neu installieren und habe jetzt ein frisches Windows 11 installiert.
Ich werde dem Leitfaden folgen und später berichten! Ich werde auch @AliBenBongo’s Leitfaden im Hinterkopf behalten.

[Arkshine]

Hier ist eine Nachlese.
Der Leitfaden könnte sicherlich ein Update gebrauchen, aber er funktioniert auf einem frischen Windows 11 22H2 immer noch wunderbar.
Das einzige Problem, das ich hatte, war, dass die WSL-Funktion standardmäßig nicht aktiviert war, obwohl der Befehl wsl in einem Terminal funktionierte:

[NateDhaliwal]

Ich glaube, diese Anleitung ist veraltet. Die im Ubuntu/Debian-Leitfaden erwähnten Schritte existieren nicht mehr.

[NateDhaliwal]

Gibt es eine Möglichkeit, all diese Schritte rückgängig zu machen, z. B. das Rückgängigmachen des Installationsskripts von Paketen, Gems und das Klonen?

[TempAccount]

@Discourse

WARNUNG: Installieren Sie Ubuntu 18.04 und nicht 20.04, da einige Installationen auf 20.04 fehlschlagen werden.

Ist die Installation von 18.04 über 20.04 noch erforderlich?

Fehler bei der Installation von nodejs:

# apt install nodejs

Paketlisten werden gelesen... Fertig
Abhängigkeitsbaum wird aufgebaut
Statusinformationen werden eingelesen... Fertig
Einige Pakete konnten nicht installiert werden. Das könnte bedeuten, dass Sie
eine unmögliche Situation angefordert haben, oder, wenn Sie die
instabile Distribution verwenden, dass einige erforderliche Pakete noch
nicht erstellt wurden oder aus Incoming entfernt wurden.
Die folgenden Informationen helfen möglicherweise bei der Lösung des Problems:

Die folgenden Pakete haben nicht erfüllte Abhängigkeiten:
 nodejs : Hängt ab von: libc6 (>= 2.28) aber 2.27-3ubuntu1.6 soll installiert werden
E: Fehler beim Korrigieren von Problemen, Sie haben zurückgehaltene Pakete.```