Skip to content

Lack of setup instructions for Augur on Windows using WSL #3108

Open
@Akshatb2006

Description

@Akshatb2006

Issue

There are no specific setup instructions for running Augur on Windows using WSL (Windows Subsystem for Linux). I attempted to set up Augur using WSL with Ubuntu and faced several issues due to missing or unclear steps in the documentation.

What I Tried

  • Used WSL2 with Ubuntu 22.04
  • Followed the general setup guide from the README
  • Faced issues during augur backend start, including dependency problems, unclear DB setup steps, and configuration issues.
  • Had to manually troubleshoot a lot, which could’ve been avoided with a dedicated WSL section.

Suggested Improvements

  • Add a section in the documentation (README or a new file like SETUP_WSL.md) for WSL-based setup.
  • Mention prerequisites like Docker Desktop with WSL integration, PostgreSQL handling inside/outside WSL, and .env config.
  • Share common errors and solutions (e.g., how to handle port conflicts or PostgreSQL access).

Environment

  • OS: Windows 11
  • WSL: Ubuntu 22.04 (WSL2)
  • Docker Desktop (with WSL backend)
  • Command that caused issues: augur backend start, DB connection setup

Happy to help contribute to this if needed!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions