Skip to content

Conversation

@Shubhamx404
Copy link

Documentation pages for Setup (Linux, Windows, macOS , manual , docker ) are empty on ReadTheDocs #4826

path : Cloud-CV/EvalAI/tree/master/docs/source/01-getting-started/setup

issue : there is no Docker setup guide ( issue #4826 )

What this PR Does

This PR adds complete Docker-based setup documentation for EvalAI to address missing and empty setup pages and improve the onboarding experience.

Added Documentation Includes

  • Clear prerequisites

    • Docker
    • Docker Compose
    • Git
  • Step-by-step setup instructions

    • Forking the EvalAI repository
    • Cloning the fork locally
    • Building and running EvalAI using Docker Compose
  • Default login credentials

    • Admin, Host, and Participant accounts for local development
  • Optional service profiles

    • Worker services for local evaluation testing
    • StatsD exporter for monitoring
  • Container verification steps

    • Validating running services using docker ps
  • Common issues & troubleshooting

    • Port conflicts (e.g., port 8888 already in use)
    • Database and volume reset instructions
    • Viewing service logs for debugging

Next step : i will make more Setup documentation for (Linux , MacOs , Manual Installation , Windows )

@RishabhJain2018 @gchhablani sir , Please review my Pr

Thanks
Shubham Kumar sharma

@Shubhamx404 Shubhamx404 marked this pull request as draft December 17, 2025 10:32
@Shubhamx404 Shubhamx404 marked this pull request as ready for review December 17, 2025 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant