-
Notifications
You must be signed in to change notification settings - Fork 8
Feat: Auth Setup Wizard #discuss #270
Copy link
Copy link
Open
Labels
T25mTime Estimate 25 MinutesTime Estimate 25 Minuteschorea tedious but necessary task often paying technical debta tedious but necessary task often paying technical debtdiscussShare your constructive thoughts on how to make progress with this issueShare your constructive thoughts on how to make progress with this issuedocumentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedIf you can help make progress with this issue, please comment!If you can help make progress with this issue, please comment!tech-debtA feature/requirement implemented in a sub-optimal way & must be re-writtenA feature/requirement implemented in a sub-optimal way & must be re-writtentechnicalA technical issue that requires understanding of the code, infrastructure or dependenciesA technical issue that requires understanding of the code, infrastructure or dependenciesuser-feedbackFeedback from people using the AppFeedback from people using the App
Description
Metadata
Metadata
Assignees
Labels
T25mTime Estimate 25 MinutesTime Estimate 25 Minuteschorea tedious but necessary task often paying technical debta tedious but necessary task often paying technical debtdiscussShare your constructive thoughts on how to make progress with this issueShare your constructive thoughts on how to make progress with this issuedocumentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedIf you can help make progress with this issue, please comment!If you can help make progress with this issue, please comment!tech-debtA feature/requirement implemented in a sub-optimal way & must be re-writtenA feature/requirement implemented in a sub-optimal way & must be re-writtentechnicalA technical issue that requires understanding of the code, infrastructure or dependenciesA technical issue that requires understanding of the code, infrastructure or dependenciesuser-feedbackFeedback from people using the AppFeedback from people using the App
Type
Projects
StatusShow more project fields
No status
At present, when a required environment variable is not set, the
auth(v1.6.6) app will not start.Instead we see an error message of the form:
This is a lot better than the old (cryptic) error messages we had before
envarbut it's still lame. 🤦♀️Someone
newrunning theauthapp on theirlocalhostfor the first time shouldn't see this kind of thing!!What we should have instead is:
Story
As a prospective contributor or deployer of the
authproject,I want a Web UI-based Setup Wizard
that helpfully and progressively guides me
through the process of inputing the required values
So that I know what I need to do to get everything working!
/initis nice but not enough ...At present we have the following "init" page: https://authdemo.fly.dev/init #176

That informs people which environment variables are defined.
This was a make-shift page we created just for our own deployment needs.
But if more people are going to run and contribute to the
authapp,the "onboarding" for new devs needs to be significantly streamlined.
Only 2 Environment Variables Required to Startup
Of the environment variables currently listed on the
/initpage,the only two that are really needed are
DATABASE_URLandSECRET_KEY_BASE.And even these two shouldn't be required to boot the
authapp ... 💭We have demo Apps running on Fly.io that don't use
PostgreSQLand therefor don't need aDATABASE_URL...But given that
authwill always have DB tables in order to work ...and we know from experience of deploying to Fly.io (and on
localhost)that the
mix ecto.setupormix ecto.migratefails when there is no DB, so the app simply won't boot.So the
DATABASE_URLandSECRET_KEY_BASEare probably "baseline" ... 🙄OK, Let's operate under the assumption/understanding that these two are the only require environment variables.
And that everything
elseis defined progressively. i.e. when added they "unlock" features in theauthApp.Thoughts? 💭