monuelo/cast-sh

Document options to set login password in Readme

chmreid opened this issue · 4 comments

chmreid commented

Describe the bug

A user first downloads and starts cast-sh following the instructions in the Readme (pip install -r requirements.txt then python -m cast). They encounter a login page asking for a password. The Readme does not mention anything about how to set the password, so it requires looking into the source code, specifically cast/app.py lines 286-290, to find that a user can either set a password with --password <password> on the command line or by setting the PASSWORD environment variable.

This issue can be considered closed when the Readme mentions these two options.

vladdoster commented

Hi @chmreid ,

You are 100% correct. I will fix the readme right now. Thanks for catching this.

vladdoster commented

Describe the bug

A user first downloads and starts cast-sh following the instructions in the Readme (pip install -r requirements.txt then python -m cast). They encounter a login page asking for a password. The Readme does not mention anything about how to set the password, so it requires looking into the source code, specifically cast/app.py lines 286-290, to find that a user can either set a password with --password <password> on the command line or by setting the PASSWORD environment variable.

This issue can be considered closed when the Readme mentions these two options.

Hi @chmreid ,

I have opened a PR. Would you mind reviewing the changes to see if my proposed documentation changes would have prevented this issue?

Thanks again :)

chmreid commented

👍 Thanks for the prompt response! PR reviewed.

  • ❤️1
monuelo commented

Good, @chmreid, @vladdoster. Btw, sorry for the delay. Thank you so much! 🎉