gavin/maybe
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 28 Wiki Activity

docs: add dev containers config gotcha in README #479

Merged
nshki merged 3 commits from docs/improve-devcontainer-setup-config into main 2024-02-26 19:46:45 +08:00
Conversation 1 Commits 3 Files Changed 2 +4 -2
nshki commented 2024-02-25 01:26:29 +08:00 (Migrated from github.com)
Copy Link

Overview

This is a small README update for devs who choose to use dev containers to work on the project. When setting this up on my machine (Fedora Asahi Linux running on an M2 MacBook Air) via the dev containers CLI, I ran into an issue where the Rails server kept throwing a could not connect to server: Cannot assign requested address error. The issue was that the .env file that I copied from .env.example was trying to connect to DB_HOST=localhost when it needed to be pointed at DB_HOST=db in the Docker Compose setup.

This adds a sentence in the README to address this and it also adds a comment in .env.example next to the relevant line.

And as a side note, I'm very excited that you all have decided to open source this lovely project. I'm looking forward to keeping up with its developments and would love to contribute when I can.

# Overview This is a small README update for devs who choose to use dev containers to work on the project. When setting this up on my machine (Fedora Asahi Linux running on an M2 MacBook Air) via the [dev containers CLI](https://github.com/devcontainers/cli), I ran into an issue where the Rails server kept throwing a `could not connect to server: Cannot assign requested address` error. The issue was that the `.env` file that I copied from `.env.example` was trying to connect to `DB_HOST=localhost` when it needed to be pointed at `DB_HOST=db` in the Docker Compose setup. This adds a sentence in the README to address this and it also adds a comment in `.env.example` next to the relevant line. And as a side note, I'm very excited that you all have decided to open source this lovely project. I'm looking forward to keeping up with its developments and would love to contribute when I can.
zachgoll (Migrated from github.com) approved these changes 2024-02-26 19:46:33 +08:00
zachgoll (Migrated from github.com) left a comment
Copy Link

Good idea, this is always a tricky thing to remember when setting up with Docker!

Good idea, this is always a tricky thing to remember when setting up with Docker!
Sign in to join this conversation.
Reviewers
No Reviewers
zachgoll
Labels
Clear labels
📆 Planned
Not ready to be worked on yet, but planned for future
 💻 Self Hosted only
Issues pertaining to self-hosted versions of Maybe
 ⚙️ Config
ℹ️ Needs info
Further information is requested
 📱 Mobile
Bugs exclusively happening on mobile devices
 1️⃣ High Priority
High priority issues will be worked on next
 🚨 Urgent
Issues that are urgent for app functionality
 3️⃣ Low priority
Contributions accepted, but Maybe team will not be working on this in the near term
 2️⃣ Medium Priority
Community contributions accepted, Maybe team only works on if there are no high priority items open
 ⚡ Performance
Performance issues to address
 🎨 UI / UX
Issues related to UI / UX interactions and design.
 💎 Bounty
💰 Rewarded
📊 Data issue
Issues where the app functionally works, but the data is missing or inaccurate.
 🙋 Bounty claim
$1.5K
Community
This is a great issue for community members to work on
 dependencies
Pull requests that update a dependency file
 Design
Hosted only
Hosted app only
 Required self hoster data migration
Self hosters must run data migrations to resolve this issue
 ruby
Pull requests that update Ruby code
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
gavin
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: gavin/maybe#479
Delete Branch "docs/improve-devcontainer-setup-config"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?