Feat: Auth Setup Wizard #discuss
#270
Labels
chore
a tedious but necessary task often paying technical debt
discuss
Share your constructive thoughts on how to make progress with this issue
documentation
Improvements or additions to documentation
help wanted
If you can help make progress with this issue, please comment!
T25m
Time Estimate 25 Minutes
tech-debt
A feature/requirement implemented in a sub-optimal way & must be re-written
technical
A technical issue that requires understanding of the code, infrastructure or dependencies
user-feedback
Feedback from people using the App
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
envar
but it's still lame. 🤦♀️Someone
new
running theauth
app on theirlocalhost
for 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
auth
project,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!
/init
is 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
auth
app,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
/init
page,the only two that are really needed are
DATABASE_URL
andSECRET_KEY_BASE
.And even these two shouldn't be required to boot the
auth
app ... 💭We have demo Apps running on Fly.io that don't use
PostgreSQL
and therefor don't need aDATABASE_URL
...But given that
auth
will 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.setup
ormix ecto.migrate
fails when there is no DB, so the app simply won't boot.So the
DATABASE_URL
andSECRET_KEY_BASE
are probably "baseline" ... 🙄OK, Let's operate under the assumption/understanding that these two are the only require environment variables.
And that everything
else
is defined progressively. i.e. when added they "unlock" features in theauth
App.Thoughts? 💭
The text was updated successfully, but these errors were encountered: