This article is a summary of all the changes made on Automated Gentoo System Updater project during weeks 11 and 12 of GSoC.
Progress on Weeks 11 and 12
During last 2 weeks I’ve completed app UI and Firebase backend. Most of the work is done!
I’m not entirely pleased with how the backend works. In Firebase, I ended up using:
After a user authenticates using anonymous login, a token is automatically registered in Firestore. This token is later used by
gentoo_update to send reports. Cloud Functions manage the token’s creation. In fact, all database write operations are handled by Cloud Functions, with users having read-only access to the data they’ve created. Here is how to send the report via token:
export GU_TOKEN="<token ID>" gentoo-update --send-report mobile
Internally, gentoo-update talks to a Cloud Function. This function checks the token, then saves the report in Firestore for the user to access.
This differs from the original idea, where I didn’t intend to save reports in Firestore. The initial plan was to have the client side listen and let Firebase route report content from the Gentoo system to the app. But this method often missed reports or stored them incorrectly, causing them to vanish from the app. To solve this, I chose to save the reports and tokens, but with encryption.
I’ve came up with a solution to create a custom backend for the app, which users will be to self-host, more about in the Challenges section.
Apart from the web app, I’ve fixed some minor issues in
gentoo-update and pushed the latest ebuild version to GURU repository (commit link).
While Firebase offers a quick way to set up a backend, it has its drawbacks:
- Not all its best features are free.
- Some of its operations aren’t transparent.
- It doesn’t offer self-hosting.
- Its rate-limiting and security features aren’t as strong as needed. To tackle these concerns, I’m considering a custom backend using this tech stack: Linux + Docker + Python/Django + MongoDB + Nginx.
Here’s a breakdown:
- Django will serve as the backend, handling tasks similar to Cloud Functions.
- MongoDB, a document database, will take Firestore’s place.
- Nginx adds extra capabilities for rate-limiting, load balancing, and security checks.
If necessary, MongoDB can be swapped out for a relational database because the backend will heavily utilize ORM. The same flexibility applies to Nginx.
A highlight of this approach is that everything can be defined in a Docker Compose file, simplifying self-hosting for users.
Plans for Week 13 (final week 🎉)
Here is my plan for the final week of GSoC’2023:
- Add encryption to the Firestore. I don’t want any user data to be stored in plain text.
- Improve some UI elements and add a pop-up with commands to copy/paste.
- Publish mobile app to Playstore.
- Write a detailed blog post on how to use the whole thing.
- Writa a post on forums.