Developing Discourse on GitHub Codespaces

[system]

GitHub Codespaces is a very fast way to get started with Discourse development. Their free tier is good for 30 hours per month of a 4-core machine.

Getting Started

1. Navigate to the github repository

2. Press the , (comma) key on your keyboard, to open GitHub codespaces

3. Use ‘change options’ to customize the machine. Technically, the 2-core machine will work, but we recommend using at least 4-core for a better experience.

   

4. Click “Create Codespace”

5. 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.

   

6. Run the default build task using Cmd/Ctrl + Shift + B.

   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.

7. Run the dev/admin/create task. Open the command palette with Cmd/Ctrl + Shift + P and search for “Tasks: Run Tasks”. It will present a menu of tasks; select dev/admin/create off of that list. You’ll be prompted to enter an email address and a password for your admin user.

8. Visit the “Ports” tab, and click the button for port 3000. This will open a new tab showing your development copy of Discourse

   

9. All done! You can now make changes in the codespace and see them reflected in the preview.

   

The VSCode environment will automatically be configured with our recommended settings and extensions, including automatic linting and formatting.

To minimize usage, make sure to run “Codespaces: Stop Current Codespace” from the command palette (Ctrl + Shift + P or Cmd + Shift + P) when you’re finished. If you forget to do this, the Codespace should be shut down automatically after your account’s configured idle time (default 30 mins). But, there are some situations where the codespace will not be detected as idle, so it’s best to stop it deliberately.

Running tests

The first time you run tests, you’ll need to install testing dependencies, including Playwright and the discourse_test DB. You can run the deps/testing task to install those. Open the command palette, select “Tasks: Run Tasks”. It will present a menu of tasks; select deps/testing off of that list.

Once the test dependencies are installed, you can run bin/lint, bin/qunit, or the system specs

Tips

• You can launch a codespace from specific branches/PRs - just visit it, and press ,

• You can manage all your codespaces at Sign in to GitHub · GitHub

• 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.

---

This document is version controlled - suggest changes on github.

[NateDhaliwal]

문제를 하나 발견했습니다: 시작할 때 다음 카테고리가 생성됩니다:
General, Staff, Staff67d17c71d8026b365c4c6657a9a9b5eb, 그리고 General(그 뒤에 랜덤 문자열과 숫자가 붙음).
랜덤 문자열과 숫자가 붙은 카테고리를 만들지 않을 수 있을까요? General의 복제본은 삭제할 수 있지만, Staff의 복제본은 FAQ 토픽이 포함되어 있어 삭제할 수 없습니다(이 토픽은 원래의 Staff 카테고리에도 이미 있으므로 의미가 없습니다).

수정: Site Feedbackee4d95d3ac0267109c01ed5438943e6c도 생성되는데, 이미 Contribute > Site feedback 카테고리가 존재합니다. #Uncategorized에도 복제본이 있습니다.

[Moin]

This reminds me of Random string in category name

[NateDhaliwal]

When backing up the database, I get this error:

[2024-12-12 10:31:26] [STARTED]
[2024-12-12 10:31:26] 'system' has started the backup!
[2024-12-12 10:31:26] Marking backup as running...
[2024-12-12 10:31:26] Making sure '/workspace/discourse/tmp/backups/default/2024-12-12-103126' exists...
[2024-12-12 10:31:26] Making sure '/workspace/discourse/public/backups/default' exists...
[2024-12-12 10:31:26] Updating metadata...
[2024-12-12 10:31:27] Dumping the public schema of the database...
[2024-12-12 10:31:28] pg_dump: error: connection to database "discourse_development" failed: connection to server on socket "/var/run/postgresql/.s.PGSQL.5432" failed: FATAL:  Peer authentication failed for user "postgres"
[2024-12-12 10:31:28] EXCEPTION: pg_dump failed
[2024-12-12 10:31:28] /workspace/discourse/lib/backup_restore/backuper.rb:173:in `dump_public_schema'
/workspace/discourse/lib/backup_restore/backuper.rb:36:in `run'
/workspace/discourse/lib/backup_restore.rb:13:in `backup!'
/workspace/discourse/app/jobs/regular/create_backup.rb:10:in `execute'
/workspace/discourse/app/jobs/base.rb:322:in `block (2 levels) in perform'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/rails_multisite-6.1.0/lib/rails_multisite/connection_management/null_instance.rb:49:in `with_connection'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/rails_multisite-6.1.0/lib/rails_multisite/connection_management.rb:21:in `with_connection'
/workspace/discourse/app/jobs/base.rb:309:in `block in perform'
/workspace/discourse/app/jobs/base.rb:305:in `each'
/workspace/discourse/app/jobs/base.rb:305:in `perform'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:202:in `execute_job'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:170:in `block (2 levels) in process'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/middleware/chain.rb:177:in `block in invoke'
/workspace/discourse/lib/sidekiq/pausable.rb:132:in `call'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/middleware/chain.rb:179:in `block in invoke'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/middleware/chain.rb:182:in `invoke'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:169:in `block in process'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:136:in `block (6 levels) in dispatch'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/job_retry.rb:113:in `local'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:135:in `block (5 levels) in dispatch'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq.rb:44:in `block in <module:Sidekiq>'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:131:in `block (4 levels) in dispatch'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:263:in `stats'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:126:in `block (3 levels) in dispatch'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/job_logger.rb:13:in `call'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:125:in `block (2 levels) in dispatch'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/job_retry.rb:80:in `global'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:124:in `block in dispatch'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/job_logger.rb:39:in `prepare'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:123:in `dispatch'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:168:in `process'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:78:in `process_one'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/processor.rb:68:in `run'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/component.rb:8:in `watchdog'
/home/discourse/.bundle/gems/ruby/3.3.0/gems/sidekiq-6.5.12/lib/sidekiq/component.rb:17:in `block in safe_thread'
[2024-12-12 10:31:28] Cleaning stuff up...
[2024-12-12 10:31:28] Removing '.tar' leftovers...
[2024-12-12 10:31:28] Marking backup as finished...
[2024-12-12 10:31:28] Notifying 'system' of the end of the backup...

This happens whenever I boot up the forum with bin/ember-cli-u.

When clicking the Backup in the Admin panel, I get:

[2024-12-12 10:34:57] [STARTED]
[2024-12-12 10:34:57] 'NateDhaliwal' has started the backup!
[2024-12-12 10:34:57] Marking backup as running...
[2024-12-12 10:34:57] Making sure '/workspace/discourse/tmp/backups/default/2024-12-12-103457' exists...
[2024-12-12 10:34:57] Making sure '/workspace/discourse/public/backups/default' exists...
[2024-12-12 10:34:57] Updating metadata...
[2024-12-12 10:34:57] Dumping the public schema of the database...
[2024-12-12 10:34:57] pg_dump: error: connection to database "discourse_development" failed: connection to server on socket "/var/run/postgresql/.s.PGSQL.5432" failed: FATAL:  Peer authentication failed for user "postgres"
[2024-12-12 10:34:57] EXCEPTION: pg_dump failed
[2024-12-12 10:34:57] /workspace/discourse/lib/backup_restore/backuper.rb:173:in `dump_public_schema'
/workspace/discourse/lib/backup_restore/backuper.rb:36:in `run'
/workspace/discourse/script/spawn_backup_restore.rb:9:in `backup'
/workspace/discourse/script/spawn_backup_restore.rb:31:in `block in <main>'
/workspace/discourse/script/spawn_backup_restore.rb:4:in `fork'
/workspace/discourse/script/spawn_backup_restore.rb:4:in `<main>'
[2024-12-12 10:34:57] Cleaning stuff up...
[2024-12-12 10:34:57] Removing '.tar' leftovers...
[2024-12-12 10:34:57] Marking backup as finished...
[2024-12-12 10:34:57] Notifying 'NateDhaliwal' of the end of the backup...

[Daimonds_and_netherite (USCHESSID: 32121789)]

when i try to change it from the main to devcontainer like the image shows I don’t get anything it says no resultys

[david (David Taylor)]

@Daimonds_and_netherite

change it from the main to devcontainer like the image shows

If you’re talking about the ‘devcontainer’ branch shown in the footer of the second image, then you should ignore it. The screenshots were taken before devcontainer configuration was available on the main branch.

[Daimonds_and_netherite (USCHESSID: 32121789)]

thanks david

[Daimonds_and_netherite (USCHESSID: 32121789)]

@system

Visit the “Ports” tab, and click the button for port 4200. This will open a new tab showing your development copy of Discourse

before you press it tho you need to make an admin account in the code can someone send me some pictures showing how to do it because I finally have a away to my own discourse but I cant do it without knowing how to set it up so can someone give images so I can see how to do it

[Moin]

You can use the steps described in the other non-Docker based installs, like Install Discourse on Ubuntu or Debian for Development

The command to create an admin account is bin/rails admin:create and then you follow the prompts

[Daimonds_and_netherite (USCHESSID: 32121789)]

it worked thanks so much i now have my own forum

[NateDhaliwal]

@david any ideas for this? I’m still getting this error.

[sam (Sam Saffron)]

Does this system work with discourse plugins? Can it?

[NateDhaliwal]

Yes, I have tried and plugins do work with this.
It can be installed by:

Install plugins in your non-Docker development environment

(This guide only covers non-docker dev install. For Docker dev see Install Discourse for development using Docker) If you’ve followed the instructions to set up your local discourse, you can install a plugin locally: Stop your local server if it’s running. Download the plugin repo and save it your /plugins folder. Alternatively, you can use a symlink. If the plugin includes migrations (you’ll see them in db/migrate), run them with: LOAD_PLUGINS=1 bundle exec rake db:migrate fro…

I have installed post voting, topic voting and gamification, and they are work so far.

[david (David Taylor)]

Yup it’s just running our standard docker container in the cloud, so you can cd to the plugins directory and clone whatever you like.

One day it might be nice if we can have a config in individual plugin repos, so that the codespaces environment can be launched directly from their repos.

[NateDhaliwal]

이 문제가 Codespaces와 관련이 있는지, 아니면 단순히 Linux 환경 문제인지 확실하지 않습니다. 하지만 사용자 impersonation(대리)을 수행하면서 사용자를 전환하고 로그인/로그아웃을 하면 bin/ember-cli -u가 아무런 오류 로그 없이 종료됩니다. Codespace는 Discourse 저장소와 최신 상태가 유지되고 있습니다.

2번째 개발 환경(이것도 GH Codespaces)에서 매번 로그아웃하지 않아도 되도록 experimental_impersonation을 활성화해야 했습니다.