perfood / couch-auth

Powerful authentication for APIs and apps using CouchDB (or Cloudant) with Node >= 14
MIT License
66 stars 19 forks source link

Added comments for username login to example config #41

Closed Achder closed 2 years ago

Achder commented 2 years ago

I was having some trouble setting the project up. I was expecting username login to work out of the box. The errors I got were confusing. First I got no matching identifier and later invalid username or password. Especially since the README mentions logging in with username and password.

I had to dive into the code to find the missing options. To avoid this kind of confusion I thought mentioning the necessary options in the example config could help new users and prevent frustration.

fynnlyte commented 2 years ago

Yeah, quite a bit has changed and the documentation isn't quite up to date. I really need to provide an example project that uses the more secure defaults but also explain how to use the username approach. I'll look into the MR later and add some more docs.