Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect Command , Syntax and Path for talawa-api setup for Ubuntu using docker. #2719

Closed
DevyanshuNegi opened this issue Nov 28, 2024 · 3 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation duplicate This issue or pull request already exists invalid This doesn't seem right unapproved Unapproved for Pull Request

Comments

@DevyanshuNegi
Copy link

The documentation for setting up development containers on Ubuntu contains multiple incorrect command syntax and invalid paths for Docker Compose, leading to errors during setup.

  1. The command uses bash sudo which is invalid.
  2. The path /usr/libexec/docker/cli-plugins/docker-compose may not exist, causing "file not found" errors.
  3. The inconsistency between Docker Compose v1 and v2 commands isn't addressed, potentially confusing users.

Steps to reproduce the behavior:

1.Follow the Talawa API Docker Setup Documentation for Ubuntu development setup.
2.Run the following command as instructed in the documentation :
bash sudo /usr/libexec/docker/cli-plugins/docker-compose -f docker-compose.dev.yaml up --build

3.Observe the errors, including invalid command usage and path issues.

Expected behavior
The command should correctly start the development environment using Docker Compose without errors, ensuring compatibility with Ubuntu and both Docker Compose v1 and v2.

Actual behavior
The command fails with errors like:
image

  • sudo: /usr/bin/sudo: cannot execute binary file
    -bash: /usr/libexec/docker/cli-plugins/docker-compose: No such file or directory

Recommended fixes

  1. Replace bash sudo /usr/libexec/docker/cli-plugins/docker-compose with:
    sudo docker compose -f docker-compose.dev.yaml up --build # For v2
    or
    sudo docker-compose -f docker-compose.dev.yaml up --build # For v1
  2. Add instructions to verify which version of Docker Compose is installed and guide users to use the appropriate command.
  3. Include a note on how to install Docker Compose if it's missing.

Potential internship candidates

Please read this if you are planning to apply for a Palisadoes Foundation internship

@DevyanshuNegi DevyanshuNegi added the bug Something isn't working label Nov 28, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation invalid This doesn't seem right unapproved Unapproved for Pull Request labels Nov 28, 2024
Copy link

Congratulations on making your first Issue! 🎊 If you haven't already, check out our Contributing Guidelines and Issue Reporting Guidelines to ensure that you are following our guidelines for contributing and making issues.

@DevyanshuNegi
Copy link
Author

I can work on this issue.

@palisadoes
Copy link
Contributor

@palisadoes palisadoes added the duplicate This issue or pull request already exists label Nov 28, 2024
@palisadoes palisadoes closed this as not planned Won't fix, can't repro, duplicate, stale Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation duplicate This issue or pull request already exists invalid This doesn't seem right unapproved Unapproved for Pull Request
Projects
None yet
Development

No branches or pull requests

2 participants