From 42631eafd3f785ac651a95b9258ea7808386aca7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nishiki=20=28=E9=8C=A6=E8=8F=AF=29?= Date: Mon, 26 Feb 2024 03:46:45 -0800 Subject: [PATCH] docs: add dev containers config gotcha in README (#479) * docs: add dev containers config gotcha in README * Add comment in `.env.example` --------- Signed-off-by: Zach Gollwitzer Co-authored-by: Zach Gollwitzer --- .env.example | 4 ++-- README.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.env.example b/.env.example index acf9f1cd..039ddf74 100644 --- a/.env.example +++ b/.env.example @@ -25,7 +25,7 @@ SMTP_PASSWORD= TLS=true # Database Configuration -DB_HOST=localhost +DB_HOST=localhost # May need to be changed to `DB_HOST=db` if using devcontainer DB_PORT=5432 POSTGRES_PASSWORD=postgres -POSTGRES_USER=postgres \ No newline at end of file +POSTGRES_USER=postgres diff --git a/README.md b/README.md index f92435bb..09381403 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,8 @@ If you'd like multi-currency support, there are a few extra steps to follow. This is 100% optional and meant for devs who don't want to worry about installing requirements manually for their platform. You can follow [this guide](https://code.visualstudio.com/docs/devcontainers/containers) to learn more about Dev Containers. +If you run into `could not connect to server` errors, you may need to change your `.env`'s `DB_HOST` environment variable value to `db` to point to the Postgres container. + #### Mac Please visit our [Mac dev setup guide](https://github.com/maybe-finance/maybe/wiki/Mac-Dev-Setup-Guide).