calgoodman / devcontainer-rails

💎 devcontainer configurations to run Ruby on Rails with PostgreSQL and Redis on GitHub Codespaces

Codespace on Rails

Why?

I've been trying to get some Ruby on Rails projects I have set up on Codespaces. After many tries, I've finally got it working (at least the way I wanted it to), so now I'm creating this repository to keep these changes and copy them to other projects whenever needed.

I mostly copied what was done here and fixed some things that were not working for me or that I didn't need.

How?

1. Copy the .devcontainer folder to your project
2. Customize
3. Open the project in Codespaces
4. No step 4 :)

What's in the box?

• Ruby 3.3
• PostgreSQL 15 (exposed locally on port 5433)
• Redis 7
• Node 20
• SSH server
• ZSH and Oh My Zsh

Customizations

There are a couple of things you can customize and a couple of things you should customize.

Could

You can choose different Ruby and Node versions by updating the devcontainer.json file. Currently, it will install Ruby 3.2.x and Node 20.x.x. You can also change the PostgreSQL username and password, although I don't think it matters too much.

You can also change the project's name under devcontainer.json and docker-compose.yml if you want to. I've left it as Your Project Name for now.

If you change the service name (defaults to app right now), remember to update the app section in docker-compose.yml. They have to match.

Should

You should, however, update your database.yml file if you use one. Here is what mine looks like:

default: &default
  adapter: postgresql
  encoding: unicode
  host: postgres # This is the name of the container in the docker-compose.yml file
  username: postgres # This is the default username for the postgres image
  password: postgres # This is the default password for the postgres image
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>

development:
  <<: *default
  database: app_development

test:
  <<: *default
  database: app_test

production:
  <<: *default
  url: <%= ENV["DATABASE_URL"] %>

Notice the host: postgres? That's the name of the container in the docker-compose.yml file. If you change it to db, you must update the database.yml file too.

How to ssh into the devcontainer?

ssh -p 2222 -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o GlobalKnownHostsFile=/dev/null vscode@localhost

The password is vscode, configured under boot.sh