Install Discourse on macOS for development

:warning: This guide covers installation instructions for a macOS development environment, for production guides see: Install Discourse in production with the official supported instructions

So you want to set up Discourse on macOS to hack on and develop with?

We’ll assume that you don’t have Ruby/Rails/Postgres/Redis installed on your Mac. Let’s begin :rocket: !

Install Discourse Dependencies

You will need the following packages on your system:

** optional

restart your terminal

Now that we have installed Discourse dependencies, let’s move on to install Discourse itself.

Restart your Terminal

Exit your shell and restarting it ensures that the paths to the installed packages are correctly picked up by the Terminal.

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.

Bootstrap Discourse

Switch to your Discourse folder:

cd ~/discourse

Install the needed gems

bundle install

Install the JS dependencies

pnpm install

Next, run these commands to set up your local Discourse instance:

bundle exec rake db:create
bundle exec rake db:migrate
RAILS_ENV=test bundle exec rake db:create db:migrate

Start rails + Ember servers, you have two options here.

Option 1: using two separate Terminal tabs/windows, run Rails and Ember CLI separately via

bundle exec rails server

and

bin/ember-cli

Option 2: using only one Terminal tab/window:

bin/ember-cli -u # will run the Pitchfork server in the background

:tada: You should now be able to navigate to http://localhost:4200 to see your local Discourse installation. (Note that the first load can take up to a minute as the server is warmed up.)

You can also try running the specs:

bundle exec rake autospec

All (or almost all) the tests should pass.

Create New Admin

To create a new admin, run the following command:

RAILS_ENV=development bundle exec rake admin:create

Follow the prompts to create an admin account.

Configure Mail

Run MailHog:

mailhog

Congratulations! You are now the admin of your own Discourse installation!

Happy hacking! And to get started with that, see Beginner’s Guide to Creating Discourse Plugins.


This document is version controlled - suggest changes on github.

78 лайков
Setup discourse on Mac OS
Running Discourse on Docker for Mac
Localhost:3000/users gives no-results
How to install Discourse on windows
How to install Discourse locally?
Best dev installation method for running on macOS?
Migrate a NodeBB forum with Redis to Discourse
Starting discourse fails with bootstrap error
Please help, how do I install Discourse on macOS?
MacOS Installation Gem::FilePermissionError
Help me setup my Discourse development environment
Error after cleaning tmp folder
UndefinedTable: ERROR: relation "web_hook_event_types" when trying to run rspec test
Local installation internal use only
Discourse standalone
Ember-cli error on local MacOS development
Importing / migrating from Zendesk Community to Discourse
Change unicorn port from 3000 in development
Redis version error when I run bundle exec db:create
Category option: max topics per user (2 use-case examples)
Dev environment setup failed on bundle install
Set up a local Discourse Development Environment?
[Need help][MacOS M1 dev installation] ArgumentError unknown keywords
How to connect to an external database running on localhost
Migrate a PunBB forum to Discourse
Migrate a phpBB3 forum to Discourse
Migrate a FluxBB forum to Discourse
Migrate a vBulletin 3 forum to Discourse via XenForo
Migrate a MyBB forum to Discourse
Regarding the installation - docker
Migrate a NodeBB forum with MongoDB to Discourse
Migrate a Ning forum to Discourse
Migrate a Phorum forum to Discourse
Migrate from another forum to Discourse
Migrate a Kunena 3 forum to Discourse
Migrate a bbPress WordPress plugin forum to Discourse
Install Discourse for development using Docker
Use the Discourse API ruby gem
Vagrant based server failing on db:migrate
Please help, how do I install Discourse on macOS?
Can't start localhost server -- file was built for x86_64 which is not the architecture being linked (i386)
Discourse Connect on Local instance is not working
Local development and deploying from same repo
Enable CORS on localhost for DiscourseConnect
Set Environmental Variables
Need help integrating code wrote on Edittext to the Discourse
Keyboard navigation messes up the search menu
WP-Discourse not connected and admin email not recognized
Contributing to Discourse development
How to install discussions on localhost in my mac?
How to install Discourse for Wordpress locally running on MAMP
Disabling SSO in development environment
Error when building: "Runtime Error: discourse does not support compiling scss/sass files via sprockets"
Install on macOS – Failure: Scheduler::Defer can pause and resume
Stuck in infinite loop in Mac terminal after source ~/.bashrc
Can't set up dev environment due to cppjieba_rb failing to install
Override profile background via SSO
Installing Discourse for macOS Development Using asdf and docker-compose
How to relax Content Security Policy
How to add a new language
How to edit the discourse files? A development box?
Can't set up dev environment due to cppjieba_rb failing to install
Install error : Protocol violation
Cannot Backup my Development Instance (Fails)
Update PhantomJS to latest for Ubuntu dev guide?
Rake aborted message is showing when installing vagrant development
Nginx Performance Report plugin incompatible with development environment setup script
[PAID] Import from Legacy Postgres DB
Installing problem - bundle install
Discourse as Your First Rails App
Rails server --daemon and plugins
Migrate from GetSatisfaction to Discourse
Case study of an amateur plugin author
Upgrading Mathjax to version 4
Windows server publish method
Moderation Tools
Can't deploy to heroku
Topic List Previews (TLP)
Global messages on 94632 timed out, restarting process, 95535 successfully terminated by `TERM` signal
How can I include discourse in my local dev stack?
Cannot get embedding to work
/admin/config/emoji non responsive/locks up
App.yml file does not exist when installing Discourse locally
I want to build a debug version of discourse

If anyone is getting failing specs with most of them being .count errors, then try the following:

RAILS_ENV=test bundle exec rake db:reset

I had a problem where development data somehow got into my test database and was causing lots of failures.

7 лайков

Is it possible to reset a discourse completely?

2 лайка

Yes, do:

rake db:drop db:create db:migrate

Note that this will wipe everything and you will have to create your Admin user account again.

11 лайков

Can someone assist me in how I can update my discourse?

/launcher rebuild app

returns an error.

1 лайк

./launcher rebuild app is for discourse_docker based production setup. To update local/development Discourse instance you need:

cd ~/discourse
git pull origin master
8 лайков

I get this error @techAPJ,

error: Your local changes to the following files would be overwritten by merge:
	.gitignore
Please commit your changes or stash them before you merge.
Aborting

The error message is pretty clear:

Please commit your changes or stash them before you merge.

If you want to ignore your local changes, do:

git fetch origin
git reset --hard origin/master
7 лайков

Следуя руководству с форума Ruby on Rails, я застрял на шаге 7.

Это, вероятно, очень «начальный» вопрос, но как мне «указать» на экспериментальную ветку, на которую была ссылка в той теме? Я попробовал несколько вариантов, но каждый раз получал сообщение Unknown command mini_racer.

1 лайк

Они вполне могут задать вопрос здесь.

В этом руководстве мы ссылаемся на специфические инструкции для M1, которые мы написали и которые упоминаются на форуме Rails.

Мне нужно будет позже посмотреть на моём M1 Air, и, возможно, мои коллеги, которые недавно настроили новые Mac, знают лучше, нужно ли это вообще сейчас, но в шаге 7 есть пример того, как указать ветку:

gem 'mini_racer', github: 'rubyjs/mini_racer', branch: 'refs/pull/186/head'

Так что вам нужно отредактировать эту строку в локальной версии discourse/Gemfile:

а затем выполнить bundle install.

4 лайка

Ссылка находится прямо вверху оригинального сообщения.

Тема на форуме Ruby on Rails уже много месяцев неактивна. Автор оригинального поста не проявлял активности с февраля и не отвечал ни на один комментарий с просьбой о помощи.

Здесь больше людей, готовых мне помочь. Просто к сведению. :wink:

Я попробовал скопировать это в Терминал, но получил ту же ошибку «Unknown command mini_racer», что и раньше.

Признаю, что руководство с форума Ruby on Rails в этом плане не так понятно, как я надеялся.

Заранее извиняюсь… :pray:

2 лайка

Это не команда для запуска. Вам нужно РЕДАКТИРОВАТЬ фактический текстовый файл под названием «Gemfile», расположенный внутри директории discourse.

1 лайк

Ой! :facepalm:

Спасибо! Сейчас же попробую.

На мой взгляд, кому-то следует отредактировать руководство на форуме Ruby on Rails и предоставить дополнительные разъяснения касательно шага 7. Это лишь моё мнение.

Я скоро вернусь. Подождите секунду…

1 лайк

Извините, мне нужно бежать, но, кажется, исправление для mini_racer на Mac M1 уже внесено в основную ветку. Я только что проверил свой Gemfile на Mac M1, и он не был изменён. Так что, думаю, вы можете пропустить шаг 7.

3 лайка

Я выполнил шаг 8 и получил ошибку Could not locate Gemfile.

Я (думаю) смог разобраться со шагом 7, но шаг 8 по-прежнему вызывает трудности и выдаёт ошибку, упомянутую выше.

Вам нужно находиться внутри директории discourse при запуске bundle install.

Привет, @merefield! Можешь немного подробнее описать свою удалённую настройку?

При разработке темы я могу вносить изменения на живом сайте, но для разработки плагина, похоже, нет другого выхода, кроме как делать это на локальной машине, имея там всю кодовую базу Discourse (с моим плагином поверх неё).

В результате при любом изменении (кроме CSS) при разработке плагина после перезагрузки: 1) включается вентилятор моего компьютера и 2) перезагрузка занимает solid 30 секунд. А если нужно перезапустить сервер, это занимает несколько минут.

Эти задержки сильно накапливаются — в итоге на реализацию чего-то может уйти целый час, тогда как при обычном рабочем процессе (где есть горячая перезагрузка или максимум 2–3 секунды на изменение) это заняло бы 15 минут.

Поэтому буду благодарен за любые предложения по ускорению процесса.

1 лайк

Это, пожалуй, лучше обсудить в теме Ubuntu, так как я запускаю установку на облачном сервере с nginx и полной настройкой DNS (без Docker), поэтому я фактически работаю с доменом. Всё выполняется из терминала. Сейчас у меня даже Ember CLI отлично работает в этой среде.

Это не самый быстрый вариант, но достаточно быстрый. Плюс в том, что можно запускать и тестировать полноценные HTTPS-сервисы обратного вызова.

Самая быстрая среда для разработки плагинов, о которой я знаю, — это локальный Docker Dev на WSL2, который летит. К тому же её очень просто поддерживать. К сожалению, discourse_theme, насколько мне известно, в этой среде пока не работает, поэтому для этой работы я вернулся к своему облачному серверу.

Немного странно, почему Apple отстаёт в этом вопросе? Инженеры Microsoft показали себя очень сообразительными.

3 лайка

В случае, если у кого-то возникают ошибки при установке Ruby 2.7.3, похоже, что после Xcode 12 что-то изменилось, что ломает процесс установки с помощью rbenv:

Я постоянно получал это сообщение, даже несмотря на то, что у меня установлены последние версии psych и libyaml:

Похоже, что в вашей установке Ruby отсутствует модуль psych (для вывода YAML).
Чтобы устранить это предупреждение, установите libyaml и переустановите Ruby.

Я попробовал обходной путь, предложенный в руководстве, но продолжал получать ту же ошибку и в итоге был вынужден использовать rvm:

rvm install 2.7.3
1 лайк

Что касается того, как ускорить программирование при создании плагина, я недавно изменил свой подход. И это работает отлично. Суть в том, чтобы перенести все элементы фронтенда в компонент темы, а в самом плагине писать только бэкенд-код. Я знаю, что другие уже пришли к такому решению. Но теперь, когда я делаю именно так, программирование становится намного быстрее и приятнее. Подробнее здесь.

3 лайка