Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Maxime Alza committed Jul 30, 2024
1 parent 4d4becc commit a58c960
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,44 @@ If you use application with Firebase authentication (and not with OIDC mechanism
![img.png](images/img5.png)
![img.png](images/img6.png)

## Firebase setup for microservices

### Cleanup microservice

#### Purpose

The cleanup microservice is, among other things, responsible for deleting users who have not connected to the application for more than a year. This is achieved by connecting to Firebase and accessing user data to perform cleanup operations.

#### New Method

To facilitate this, you need to set up a JSON secret file containing the Firebase credentials.

#### Steps

1. Obtain the Firebase service account key JSON file from your Firebase project settings.
2. Save this JSON file securely on GCP secrets with the following name : **firebase-config**
3. Configure roles so that your secret file is accessible by your microservice


### Cleanup microservice

#### Purpose

The cleanup microservice is, among other things, responsible for deleting users who have not connected to the application for more than a year. This is achieved by connecting to Firebase and accessing user data to perform cleanup operations.

#### New Method

To facilitate this, you need to set up a JSON secret file containing the Firebase credentials.

#### Steps

1. Obtain the Firebase service account key JSON file from your Firebase project settings.
2. Save this JSON file securely on GCP secrets with the following name : **firebase-config**
3. Configure roles so that your secret file is accessible by your microservice




## Contribute to this project

For active contributors who want to use this repository as their main one, we have an active push functionality on our [internal repository](https://gitlab.com/petranslate/TradEmploi-backend) which contains our CI/CD to directly deploy the application on our [open-source domain](https://pole-emploi-trad-open.firebaseapp.com/).
Expand Down Expand Up @@ -182,3 +220,5 @@ jobs:
5 - Verify in the github actions that you workflow succeed

6 - Create a Merge Request to merge your changes in master, after the validation of the development team


0 comments on commit a58c960

Please sign in to comment.