Cloud Storage for Firebase lets you upload and share user generated content, such as images and video, which allows you to build rich media content into your apps. Your data is stored in a Google Cloud Storage bucket — an exabyte scale object storage solution with high availability and global redundancy. Cloud Storage for Firebase lets you securely upload these files directly from mobile devices and web browsers, handling spotty networks with ease.
Before you begin
-
If you haven't already, make sure you've completed the getting started guide for Android apps . This includes:
-
Creating a Firebase project.
-
Registering your Android app with the project, and connecting your app to Firebase by adding the Firebase dependencies, the Google services plugin, and your Firebase config file (
google-services.json
) to your app.
-
-
Make sure your Firebase project is on the pay-as-you-go Blaze pricing plan . If you're new to Firebase and Google Cloud, check if you're eligible for a $300 credit .
Create a default Cloud Storage bucket
-
From the navigation pane of the Firebase console , select Storage.
If your project is not yet on the pay-as-you-go Blaze pricing plan, then you'll be prompted to upgrade your project.
-
Click Get started.
-
Select a location for your default bucket.
-
Buckets in
US-CENTRAL1
US-EAST1
US-WEST1
-
If you'd like, you can later create multiple buckets , each with its own location.
-
-
Configure the Firebase Security Rules for your default bucket. During development, consider setting up your rules for public access .
-
Click Done.
You can now view the bucket in the Cloud Storage
Files
tab
of the Firebase
console. Your default bucket name format is PROJECT_ID
.firebasestorage.app
Set up public access
Cloud Storage for Firebase provides a declarative rules language that lets you define how your data should be structured, how it should be indexed, and when your data can be read from and written to. By default, read and write access to Cloud Storage is restricted so only authenticated users can read or write data. To get started without setting up Authentication , you can configure your rules for public access .
This does make Cloud Storage open to anyone, even people not using your app, so be sure to restrict your Cloud Storage again when you set up authentication.
Add the Cloud Storage SDK to your app
In your module (app-level) Gradle file (usually<project>/<app-module>/build.gradle.kts
or <project>/<app-module>/build.gradle
),
add the dependency for the Cloud Storage
library for Android. We recommend using the Firebase Android BoM
to control library versioning. dependencies { // Import the BoM for the Firebase platform implementation ( platform ( "com.google.firebase:firebase-bom:34.2.0" )) // Add the dependency for the Cloud Storage library // When using the BoM , you don't specify versions in Firebase library dependencies implementation ( "com.google.firebase:firebase-storage" ) }
By using the Firebase Android BoM , your app will always use compatible versions of Firebase Android libraries.
(Alternative) Add Firebase library dependencies without using the BoM
If you choose not to use the Firebase BoM , you must specify each Firebase library version in its dependency line.
Note that if you use multiple Firebase libraries in your app, we strongly recommend using the BoM to manage library versions, which ensures that all versions are compatible.
dependencies { // Add the dependency for the Cloud Storage library // When NOT using the BoM , you must specify versions in Firebase library dependencies implementation ( "com.google.firebase:firebase-storage:22.0.0" ) }
Set up Cloud Storage in your app
-
Make sure the Firebase config file (
google-services.json
) in your app's codebase is updated with the name of your default Cloud Storage bucket.-
Use this downloaded config file to replace the existing
google-services.json
file in your app's module (app-level) directory.Make sure that you only have this most recent downloaded config file in your app and that its filename isn't appended with additional characters, like
(2)
.
-
Access your Cloud Storage bucket by creating an instance of
FirebaseStorage
:Kotlin
storage = Firebase . storage . kt
// Alternatively, explicitly specify the bucket name URL. // val storage = Firebase.storage("gs:// BUCKET_NAME ")