micropython-firebase-realtime-database icon indicating copy to clipboard operation
micropython-firebase-realtime-database copied to clipboard

Beta branch

Open BrandonHowe opened this issue 1 year ago • 2 comments

What is the status of the beta branch? Is it in a usable state? What are the differences between the master branch and the beta?

BrandonHowe avatar Aug 05 '24 14:08 BrandonHowe

The beta branch adds support for firebase authentication. See ufirebase.py class auth This is necessary when only specific "users" should be able to read and/or write to or from a specific realtime database path. See Understand Firebase Realtime Database Security Rules. If you make your realtime database available for public, you should (i highly recommend it) use authentication, so that the realtime database url alone, isn't the only GRAND KEY to access all information stored in the database. Use authentication instead, use the beta branch.

The reason why i the beta branch with auth is not pushed to main is that documentation is missing/wrong so you need to take a look at the source code yourself to use the functions. examples: main branch --> beta branch get(...) --> rtdb.get(...) seturl(...) --> rtdb.conf.seturl(...) [...]

new functions in beta branch rtdb.conf.setsecret(...) auth.selauth(...) auth.desauth(...) auth.sign_in_ep(email, passwd, ...) auth.send_password_reset_email(...) auth.verify_password_reset_code(...) [... and more]

as most of the new code in beta branch is created according to this documentation, you can orient yourself on that.

ckoever avatar Aug 06 '24 12:08 ckoever

Please also note that authentication is not completely implemented, so most features in this documentation are missing.

ckoever avatar Aug 06 '24 12:08 ckoever