Cloud storage integration with Firebase
This tutorial explains how to integrate Firebase with Kuroco.
Through the integration with Firebase, Kuroco can upload, store, and use image or video files stored in Firebase.
Create a Firebase project
Create a Firebase project from the Firebase official website.
For this tutorial, we'll use the Free "Spark Plan" for the test implementation. Feel free to upgrade to the paid plan if necessary.
1. Apply for Firebase(Google Cloud Platform)
Go to the Firebase official website and click [Get Started].
2. Create a project
Click [Create a project] on the "Welcome to Firebase" screen.
3. Enter the project name and click Continue
Enter the project name, check [I accept the Firebase terms], and click [Continue].
Please note that the project name cannot be changed later.
4. Set up Google Analytics
Enable or disable Google Analytics.
If Google Analytics is enabled, the next screen will take you to the account settings page for Google Analytics. For this tutorial, select [Disable].
5. Click Continue after the project has been created
Click [Continue] on the project creation completion screen.
This completes the Firebase project setup.
Firebase settings / acquiring credentials
We will be focusing on the Firebase management screen for the following steps.
6. Access the [Project Settings]
Click [Project Settings] from the gear icon on the Firebase dashboard.
7. Download the private key
Under the [Service accounts] tab, click [Generate new private key].
Click [Generate key] in the pop-up and the file will be downloaded.
8. Set up to start using Firebase storage
Click [Storage] on the side menu, then click [Get started] on the Storage screen.
Select a location that is most suitable for your organization.
In this example, "asia-northeast1" was selected for the Cloud Storage location.
After selecting the desired location, click [Finish].
9. Additional settings for Firebase app
Select [Project Overview] on the side menu to return to the project main page, and click the WEB type application [</>] icon.
Enter the app nickname and click [Register App].
The "Add Firebase SDK" screen will be displayed. Click [Continue to the console].
10. Get the FirebaseConfig
Click the gear icon next to "Project Overview" to access the [Project settings] screen.
Scroll down the page, under "Your apps" -> "SDK setup and configuration", select "Config".
The firebaseConfig will be displayed. Copy it, it will be used later.
We will be focusing on the Kuroco's management screen in the following steps.
11. Set up the credentials, obtained in steps 7 and 10 above, on the Firebase's setting screen
Click [External system cooperation]-> [Firebase] on the side menu of Kuroco's management screen.
Upload the file obtained in "7. Download the private key" to 'Credentials'.
Next, paste the FirebaseConfig obtained in "10. Get FirebaseConfig" in the 'App Config' field.
12. Enable Storage
Check [Enable] for "Storage" and click [Update].
This completes the integration with Firebase.
How to use in content definition
From Content Definitions on Kuroco's management screen, select [File on GSC] in the item settings.
The file upload field will be displayed on the content edit screen.
If a file is uploaded from here, it will be uploaded to Firebase Storage.