Instalar Discourse para desarrollo usando Docker

Desarrollo con Docker

Dado que Discourse se ejecuta en Docker, deberías poder ejecutar Discourse directamente desde tu directorio fuente usando un contenedor de desarrollo de Discourse.

:white_check_mark: Ventajas: No es necesario instalar dependencias del sistema, no se necesita ninguna configuración para configurar rápidamente un entorno de desarrollo.

:x: Desventajas: Será ligeramente más lento que el entorno de desarrollo nativo en Ubuntu, y mucho más lento que una instalación nativa en MacOS.

Ver también Developing Discourse using a Dev Container

Paso 1: Instalar Docker

Ubuntu

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update
sudo apt-get install -y docker-ce

19.10

sudo apt-get install docker.io
sudo usermod -a -G docker $USER
sudo reboot

Windows WSL: Ubuntu

Puedes ejecutar los comandos anteriores dentro de WSL pero debes tener todos los archivos dentro del sistema de archivos de WSL. Por ejemplo, funciona bien si está dentro de ~/discourse pero falla si se coloca dentro de /mnt/c/discourse.

MacOS

:warning: La imagen docker de desarrollo de Discourse solo está disponible para arquitecturas x86_64. Las Mac M1 son capaces de iniciar la imagen usando emulación de arquitectura, pero es poco probable que Discourse arranque debido a la falta de soporte para inotify en QEMU.

En su lugar, deberías usar Install Discourse on macOS for development

Opción 1: Descargar un .dmg empaquetado desde Docker store
Opción 2: brew install docker

Paso 2: Iniciar Contenedor

Clona el repositorio de Discourse en tu dispositivo local.

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

(desde la raíz de tu fuente)

d/boot_dev --init
    # espera mientras:
    #   - se instalan las dependencias,
    #   - se migra la base de datos, y
    #   - se crea un usuario administrador (necesitarás interactuar con esto)

# En una terminal:
d/rails s

# Y en una terminal separada
d/ember-cli

…luego abre un navegador en http://localhost:4200 y ¡listo!, deberías ver Discourse.

Symlinks de Plugins

El flujo de desarrollo de Docker soporta symlinks bajo el directorio plugins/, con la siguiente advertencia:

Cada vez que se crea un nuevo symlink de plugin, el contenedor de Docker debe reiniciarse con:

d/shutdown_dev; d/boot_dev

Notas:

  • Para probar correos electrónicos, ejecuta MailHog:

    d/mailhog
    
  • Si faltan gems, ejecuta:

    d/bundle install
    
  • Si se necesita una migración de db:

    d/rake db:migrate RAILS_ENV=development
    
  • Cuando termines, puedes optar por detener el contenedor de Docker con:

    d/shutdown_dev
    
  • Los datos se persisten entre las invocaciones del contenedor en el directorio tmp/postgres de tu raíz fuente. Si por alguna razón quieres restablecer tu base de datos, ejecuta:

    sudo rm -fr data
    
  • Si ves errores como “permission denied while trying to connect to Docker”, ejecuta:

    run `sudo usermod -aG docker ${USER}`
    sudo service docker restart
    
  • Si deseas exponer globalmente los puertos del contenedor a la red (desactivado por defecto) usa:

    d/boot_dev -p
    
  • El Dockerfile proviene de discourse/discourse_docker en GitHub, en particular image/discourse_dev.

Ejecutar Pruebas

d/rake autospec

Para ejecutar pruebas de un plugin específico, también puedes hacer algo como esto:

d/rake plugin:spec["discourse-follow"]

O incluso algo como esto para ser aún más específico:

my-machine:~/discourse$ d/shell
discourse@discourse:/src$ RAILS_ENV=test /src/bin/rspec plugins/discourse-follow/spec/lib/updater_spec.rb:37

Este documento está controlado por versiones: sugiere cambios en github.

72 Me gusta
Using a launcher built docker image in docker-compose
IDE and comfortable DEV environment for newbies
Docker install on MacOS
Installing Discourse for macOS Development Using asdf and docker-compose
How to install Discourse locally?
External database ENV VARs not documented (external PG Port, external Redis ENV VARs)
Discourse on local pc
Discourse developement environment setup
How to Install Discourse on LocalHost in Windows?
Unicode (Russian) username validation fails randomly
Qunit in Docker
Is it possible to use a local plugin directory with a docker install?
Is it possible to use a local plugin directory with a docker install?
Problem with development on Windows with Docker and mounted volume
[Resolved] Recent change breaks connectivity in Docker (+ non-Docker)
How might we better structure #howto?
Apple M1 for discourse development
How to open via internal IP?
Fast, efficient plugin development with Docker dev install (Windows WSL2)
How do I install a stable version of Discourse on Docker locally?
Backup fails on localhost with docker
How do I install a stable version of Discourse on Docker locally?
Problems with understanding the development of Discourse
Which is the better option to self-host?
Need to create custom static page as home page
Docker new licensing
Install Discourse Docker on Ubuntu 11
Backup restore failing on clean dev docker env: FATAL: Peer authentication failed for user “postgres”
Install Discourse on macOS for development
Can't build Discourse on Ubuntu 20.10
Installing discourse for development is failing
Create, download, and restore a backup of your Discourse database
Set up a local Discourse Development Environment?
How do you install Discourse using Windows 10 Docker Desktop?
NoMethodError: undefined method `min_tags_from_required_group'
Adding command line tools support for user api keys
Install plugins in your non-Docker development environment
Adding command line tools support for user api keys
NoMethodError: undefined method `min_tags_from_required_group'
Error installing `bullseye-backports` when trying to install for Development
What I should do for migration from Cusdis to Discourse
Migrate a MyBB forum to Discourse
Local installation internal use only
Maintaining an up-to-date development environment
PG::UndefinedTable: ERROR: relation "pg_range" does not exist
Docker-compose.yml to run discourse locally
Can't set up dev environment due to cppjieba_rb failing to install
Allow subscription of predetermined length
Cannot load any images “Uncaught (in promise) no-response: no-response”
Discovery document is missing
Discourse API developers docker-compose basic image
What are the benefits of a dev environment?
Installing Discourse on windows using Docker Desktop
Installing discourse follow plugin in development (boot_dev) setup — no app.yml file
How to troubleshoot database errors in an outdated plugin?
Error when building: discourse does not support compiling scss/sass files via sprockets
Integration into custom auth system where emails are not unique?
Contributing to Discourse development
Install Discourse on Ubuntu or Debian for Development
There was an error while trying to write to `/src/Gemfile.lock`. It is likely that you need to grant write permissions for that path
Availability of OpenID Connect in hosted plans
Tags rearranged, triggering an extra edit
Migrate a phpBB3 forum to Discourse
OAuth2 and Microsoft ADFS
Install Discourse for Development using Docker is Failed
External database ENV VARs not documented (external PG Port, external Redis ENV VARs)
Install on macOS – Failure: Scheduler::Defer can pause and resume
Ember addons are resolving as incorrect peer dependencies. -- fixed by removing "content-tag@3.1.0": "patches/content-tag@3.1.0.patch",
Trying to install Discourse on portainer but it's not pulling the base container
Developing Discourse using a Dev Container
Subscribe to post an ad
Postgres doesn't seem to be running when running Discourse locally using Docker
Discourse OpenID Connect (OIDC)
Install on macOS – Failure: Scheduler::Defer can pause and resume
How can I install Discourse on Windows? Getting restarting (100) error
Stuck in infinite loop in Mac terminal after source ~/.bashrc
I want to install a plugin for development, what should I do?
Can't set up dev environment due to cppjieba_rb failing to install
Total newbie struggling to preview the signup modal with my test theme, what am I missing?
Configure Discourse to use a separate PostgreSQL server
`script/osx_dev` script is pretty broken
Issue in setup discourse on ubuntu server
Bundle install fails after adding gem "mysql2" and gem "reverse_markdown"
Using a launcher built docker image in docker-compose
Developing Discourse using a Dev Container
Can't uninstall on Ubuntu 18.04
I want to install a plugin for development, what should I do?
Without any coding knowledge, is it possible to install and maintain Discourse?
Using a launcher built docker image in docker-compose
Discourse redirects to the OAuth server after loading `/?authComplete=true`
Hello from Gitpod! (installing on google cloud + automated dev setup)

This is really easy to get set up! Thanks.

I’m surprised, however, by how slow the local installation is. Is there a way to adjust the container specs somehow? I’d expect a slowdown, but maybe not one so dramatic…

Thanks again.

7 Me gusta

I’m trying to use Docker on Windows 10, and I have a question about the guide. I have Docker installed and it can run an ubuntu container (with basically nothing installed in the container). This docker guide just says to clone the repo next, but I can’t do that since the container doesn’t have git installed.

At this point, should I just follow the Ubuntu Guide and install all of the prerequisites in the container? Or should I be using the discourse_dev image referenced on Github? It seems like this guide is skipping over a lot of steps, but I’ve never used docker before so maybe I’m missing something.

4 Me gusta

I think what is tripping you is that you are trying to clone the repo within the container, but the git clone should be done on your machine. So if you already have git installed locally, you are close to get it working.

3 Me gusta

I actually did that first, which is good. So I already have a copy of the repo on my local machine.

Do I automatically have access have my host file system from the docker container? I think I was partly confused by d/boot_dev --init because I didn’t know what the d/ part was (I don’t see a folder called d for example in the repo, even though I do see boot_dev).

3 Me gusta

The d is on the repo (scroll further down) — it is not a folder but a symlink to bin/docker. You should get it if you do the git clone.

I haven’t used this setup extensively myself, but my understanding is that you edit the source files directly in your host filesystem (that you have just checked out) and the docker containers mount that and run from it. The d/* scripts will to most of the docker setup work for you.

6 Me gusta

Thanks for that. I didn’t even think to look past the folders. I think I have enough information to make another pass at this.

3 Me gusta

I’m still getting something wrong. Between this topic, here, and here, nowhere just states what docker command to run. I settled on docker run -ti -v LocalRepoPath:/src discourse/discourse_dev, which initialized a whole bunch of stuff and seemingly mounted the repo to /src. But I can’t run d/boot_dev --init for some reason. Even just running ls in the repo’s top-level directory gives me:

ls: cannot access 'adminjs': Input/output error
ls: cannot access 'd': Input/output error
ls: cannot access 'jsapp': Input/output error

Does anyone know what’s going on here?

3 Me gusta

You might be overcomplicating this: the tutorial on the first post already has everything you need to get started.

The d/* commands will do all the docker command magic so that you don’t have to. Once you have cloned the repo, the d/boot_dev --init and the d/unicorn commands (that you do on the host machine) should be all it takes to get http://localhost:9292 working. Those scripts will call docker to generate the container and start it for you. The d/shutdown_dev will stop it.

If you are getting those errors while browsing the repo files on the host, then something else seems amiss with your filesystem. Did you run out of disk space perhaps?

4 Me gusta

sigh, I see. I thought those had to be run in docker. That said, d/boot_dev --init apparently doesn’t work on Windows in Powershell (which I guess is why this docker guide only mentions Mac and Ubuntu hosts). I tried to run the command in my linux subsystem (v1), but of course that fails at the docker step since I installed docker on Windows, not on the linux subsystem.


Next I tried to run it in git bash for Windows. I couldn’t run d/boot_dev --init (error “d/boot_dev: Is a directory”), but I was able to run bin/docker/boot_dev --init. This got a lot further, doing a bunch of pulls, but then it failed with

C:\Program Files\Docker\Docker\resources\bin\docker.exe: Error response from daemon: Mount denied:
The source path “PathToRepo/data/postgres;C”
doesn’t exist and is not known to Docker.

I was able to get past that (I think) by escaping the mount path, per:
Docker mounted volume adds ;C to end of windows path when translating from linux style path - Stack Overflow

After that I got this error:

C:\Program Files\Docker\Docker\resources\bin\docker.exe: Error response from daemon: OCI runtime create failed: container_linux.go:346: starting container process caused “exec: "C:/Program Files/Git/sbin/boot": stat C:/Program Files/Git/sbin/boot: no such file or directory”: unknown.

C:/Program Files/Git/sbin/boot doesn’t exist on my file system, so I guess the error’s not surprising. The only thing mentioning sbin/boot in the boot_dev file is this part of the docker command: discourse/discourse_dev:release /sbin/boot.

And that’s pretty much where I’m at right now… I don’t really know what to try at this point.

3 Me gusta

I’m afraid that’s how far I’m able to help you as I’m not familiar with windows.

Perhaps @rishabh is able to confirm whether this is supposed to work on windows too and update any missing steps for that (or add a note if it doesn’t).

3 Me gusta

@sam Is what I’m trying to do even a remotely supported way of running Discourse for development? In the Windows development thread you mentioned trying this, but it hasn’t been going great so far. Basic (non-Discourse) Ubuntu containers technically work, but not the specific commands in this thread’s OP.

You originally mentioned this to me:

So unless you have a suggestion to get me through the issues I’m having with Docker on Windows, it’s probably best for me to cut my losses and run it in an Ubuntu VM using something like Virtual Box.

2 Me gusta

So many of us are on the slow ring with zero issues. Games work, steam works everything works.

I do get the fear here, but it really is not a giant deal. Anyway if this is just too scary for you, I recommend a traditional VM like Hyper-V or VirtualBox. Install Docker in there and use our docker dev setup.

6 Me gusta

If this wasn’t my primary (and only) computer I would join you on the slow ring, but I just can’t risk it. So I’ll go with a traditional VM with docker. Thanks again for the advice. I hope to have something up and running soon.

What would be sufficient for disk space and RAM to allocate to the VM? I was thinking maybe 16GB of disk space and 4GB of RAM, but I wanted to check first.

1 me gusta

That would probably be enough, best way to find the ideal recipe is to experiment

6 Me gusta

Alright, I’m close to getting this working for real. I have a local instance running using docker in an ubuntu VM. I assume that I should only run d/boot_dev --init the very first time, and after that I’d just run d/boot_dev. Is that accurate? The reason I ask is that d/unicorn works when I include --init, but doesn’t work when I omit the --init from d/boot_dev. When it fails to start I get the error

Could not find aws-partitions-1.270.0 in any of the sources.
Run bundle install to install missing gems.

But then running bundle install fails with

actionview_precompiler-0.2.2 requires ruby version >= 2.6, which is incompatible with the current version, ruby 2.5.1p57

Is there a specific version of ruby I should update to? Or is there something else going on?


My VM is Ubuntu 18.04 (LTS) and this time I was able to directly follow the instructions in the OP, so I’m not sure where I might have gone wrong (if something is wrong).

2 Me gusta

You would not use bundle install you would use d/bundle install you want to install the bundle inside the container, the VM does not need Ruby.

4 Me gusta

Yeah, I had a feeling that was the case, just didn’t know what the right way of running it in the container was. Thanks again for the help!

2 Me gusta

I pulled the latest version of the repo and as usual d/unicorn tells me “Run bundle install to install missing gems.”. However, this time when I run d/bundle install I get the following:

Fetching source index from https://rubygems.org/

Retrying fetcher due to error (2/4): Bundler::HTTPError Could not fetch specs from https://rubygems.org/

Retrying fetcher due to error (3/4): Bundler::HTTPError Could not fetch specs from https://rubygems.org/

Retrying fetcher due to error (4/4): Bundler::HTTPError Could not fetch specs from https://rubygems.org/

Could not fetch specs from https://rubygems.org/

So I can’t actually run Discourse at the moment. I have no idea if this is related to the pull (directly or indirectly) or if it’s something completely unrelated. Googling for the error hasn’t been particularly helpful, so I don’t know how to proceed.

1 me gusta

We you able to reach rubygems.org?

1 me gusta