WSU-Software-Development-Club / WSU-Software-Development-Club/self-hosting

Move compose credentials and ports into a .env file

Open Beginner friendly
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
JavaScript
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Why

Postgres credentials and ports are hardcoded in docker-compose.yml. A .env file lets everyone configure their local setup without editing tracked files, and mirrors how real deployments handle config.

Files to touch

  • docker-compose.yml
  • .env.example (new)
  • .gitignore

Definition of done

  • Compose reads POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_DB, and any exposed ports from .env
  • .env.example is committed with a comment explaining every variable
  • .env is gitignored
  • cp .env.example .env && docker compose up works on a fresh clone

Hints

Compose automatically loads a .env file from the project root. Use ${VAR} syntax in the YAML. Docs: https://docs.docker.com/compose/environment-variables/

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docker-compose.yml and inspect the existing hardcoded Postgres credentials and exposed ports. Read Docker's Compose environment-variable documentation, then update docker-compose.yml, add the documented variables to .env.example, and check .gitignore. Verify the definition of done with cp .env.example .env && docker compose up from a fresh-clone setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, docker-compose
Domain
devops, infrastructure
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.