Developing Discourse using a Dev Container

[system]

Dev Containers is an open standard for configuring a development environment inside a container. This almost entirely eliminates the need to install/configure Discourse-specific tools/dependencies on your local machine, and makes it very easy to keep up-to-date as Discourse evolves over time.

Dev Containers can be used in a number of different IDEs, or directly using their reference CLI. This guide will describe the setup process for VSCode.

Getting started

1. Download and install VSCode

2. Install the Dev Containers extension in VSCode

3. Clone the Discourse repository onto your machine

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

4. In VSCode, use File → Open Folder, then choose the Discourse directory

5. Open the folder in its Dev Container. This can be done via the popup prompt, or by opening the command palette (Cmd/Ctrl + Shift + P) and searching for “Open folder in container…”

6. If this is your first time launching a container, you will be prompted to install and start Docker Desktop. Once complete, go back to VSCode re-run “Open folder in container…”

7. Wait for the container to download and start. When it’s done, the README will appear, and you’ll see the Discourse filesystem in the sidebar.

8. Run the default build task using Ctrl + Shift + B (Cmd + Shift + B on mac).

   This will install dependencies, migrate the database, and start the server. It’ll take a few minutes, especially on the lower-end machines. You’ll see “Build successful” in the terminal when it’s done.

9. Visit http://localhost:4200 in your browser to see your new Discourse instance

10. All done! You can now make changes to Discourse’s source code and see them reflected in the preview.

Applying config/container updates

Every so often, the devcontainer config and the associated container image will be updated. VSCode should prompt you to “rebuild” to apply the changes. Alternatively, you can run “Dev Containers: Rebuild Container” from the VSCode command palette. The working directory, and your Redis/Postgres data will be preserved across rebuilds.

If you’d like to start from scratch with fresh database, you’ll need to delete the discourse-pg and discourse-redis docker volumes. This can be done from the “Remote Explorer” tab of the VSCode sidebar.

Discourse’s sample vscode .vscode/settings.json and .vscode/tasks.json will be copied when you first boot the codespace. From that point forward, if you want to use the latest sample config, you’ll need to manually copy .vscode/settings.json.sample to .vscode/settings.json.

References

• Development container specification

• VSCode devcontainer docs

---

This document is version controlled - suggest changes on github.

[JogiJonas (Jonas)]

Ciao,

Nessun account amministratore creato

Quando si utilizza il container Docker dall’esterno tramite gli script in d/ (ad esempio, d/boot_dev --init come specificato in Install Discourse for development using Docker , mi viene chiesto di creare un account amministratore come parte del processo.

Tuttavia, quando lo si utilizza come Dev Container ed eseguendo i passaggi di compilazione (ctrl/cmd + shift + b), NON crea un amministratore.

Dando una rapida occhiata alle istruzioni, ho avuto inizialmente l’impressione che la creazione di un amministratore fosse piuttosto ardua; ma poi mi sono reso conto che tutto ciò che serve è questo comando, lo lascio qui per coloro che incontrano lo stesso problema:

rake admin:create

(o, se si lamenta di una versione di rake diversa richiesta: bundle exec rake admin:create)

[Arkshine]

Su Windows 11, se non si desidera incorrere in problemi di terminazione di riga, come ad esempio:

[23963 ms] Start: Run in container: /bin/sh -c ./.devcontainer/scripts/start.rb
/usr/bin/env: ‘ruby\r’: No such file or directory
/usr/bin/env: use -[v]S to pass options in shebang lines

.. assicurati di Clonare nel volume

[dsims (Daniel)]

Forse c’è un modo migliore, ma per lavorare sui plugin ho una cartella sorella discourse-plugins accanto alla mia cartella principale del repository discourse. Questa viene montata in /workspace/plugins in modo da poter creare collegamenti simbolici all’interno del container.

Questo è ciò che ho aggiunto a mounts in devcontainer.json:
"source=${localWorkspaceFolder}/../${localWorkspaceFolderBasename}-plugins,target=/workspace/plugins,type=bind"

[唐帅华 (tang shuaihua)]

È davvero utile, grazie.

[Dimava]

… O semplicemente git reset --hard
Ha funzionato per me
Poi Dev Container: Rebuild Container e Ctrl-Shift-B

[gormus (Osman Görmüş)]

Se stai usando OrbStack (non affiliato) sul tuo ambiente macOS locale e vuoi eseguire Discourse su HTTPS con un dominio personalizzato, aggiorna il tuo devcontainer.json con le seguenti aggiunte:

1. Assegna un nome al container.
2. Aggiungi il dominio wildcard .orb.local alla variabile d’ambiente RAILS_DEVELOPMENT_HOSTS (gli hostname devono essere separati da una virgola).

--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@@ -13,10 +13,11 @@
   ],
   "remoteUser": "discourse",
   "remoteEnv": {
-    "RAILS_DEVELOPMENT_HOSTS": ".app.github.dev",
+    "RAILS_DEVELOPMENT_HOSTS": ".app.github.dev,.orb.local", // Step 2
     "PGUSER": "discourse",
     "SELENIUM_FORWARD_DEVTOOLS_TO_PORT": "9229",
   },
+  "runArgs": ["--name","discourse"], // Step 1
   "mounts": [
     "source=${localWorkspaceFolderBasename}-node_modules,target=${containerWorkspaceFolder}/node_modules,type=volume",
     "source=${localWorkspaceFolderBasename}-pg,target=/shared/postgres_data,type=volume",

p.s. per favore fammi sapere se sai come impostare l’hostname *.orb.local e il nome del container dinamicamente, come è definito per GitHub Codespaces. Impostare il valore come .app.github.dev,.orb.local non ha funzionato per me.

Aggiornamento: In qualche modo, mi mancava una voce nel mio file /etc/hosts. Dopo aver aggiunto questa riga, sono stato in grado di utilizzare il dominio wildcard .orb.local nel passaggio 2.

Con queste modifiche nel file devcontainer.json, ora posso eseguire la mia istanza locale di Discourse su \u003chttps://discourse.orb.local/\u003e

/etc/hosts

Aggiungi questa riga al tuo file /etc/hosts se non l’hai già fatto.

##
# Docker e OrbStack
##
127.0.0.1 host.docker.internal

Suggerimento bonus 1
Se in qualche modo le tue impostazioni di rete, o la rete VPN della tua azienda, ecc. entrano in conflitto con gli intervalli IP dei container di OrbStack, aggiorna OrbStack con un intervallo diverso.

Container networking · OrbStack Docs

Suggerimento bonus 2
Se ometti il passaggio 1, OrbStack creerà un container con un nome casuale, ma sarai comunque in grado di utilizzare HTTPS senza aggiungere alcun numero di porta. Lo svantaggio è il nome del container, quindi il nome del dominio verrà aggiornato ogni volta che ricostruisci il container.