Menginstal Ekstensi Firebase

Anda dapat menginstal (dan mengelola) ekstensi Firebase resmi menggunakan Firebase console atau Firebase CLI (antarmuka command line).

Pastikan untuk meninjau perbedaan tindakan yang didukung antara Firebase CLI dan Firebase console.


Untuk menginstal atau mengelola ekstensi, salah satu peran berikut harus ditetapkan untuk Anda: Pemilik atau Editor atau Firebase Admin.

Untuk menginstal ekstensi, project Anda harus menggunakan paket Blaze (bayar sesuai penggunaan). Meskipun penginstalan ekstensi dapat dilakukan secara gratis, Anda mungkin akan dikenai biaya atas penggunaan layanan Firebase atau layanan Cloud seperti [Cloud Secret Manager][harga-rahasia], jika penggunaan Anda melebihi paket gratis layanan tersebut.

Sebelum memulai

  1. Tambahkan Firebase ke project, jika belum melakukannya.

  2. Upgrade project Anda ke paket Blaze (bayar sesuai penggunaan), jika belum melakukannya.

  3. Instal Firebase CLI atau update ke versi terbaru.

  4. Catat project ID Firebase Anda atau alias project yang dikonfigurasi sebelumnya.

    • Project ID — Jalankan firebase projects:list dari mana saja di komputer Anda.
    • Alias project — Jalankan firebase use dari direktori aplikasi lokal Anda.

Langkah 1: Lihat informasi mendetail tentang ekstensi

Langkah ini bersifat opsional, tetapi sangat direkomendasikan.

Sebelum menginstal ekstensi Firebase, sebaiknya Anda meninjau informasi mendetail tentang ekstensi tersebut, termasuk:

  • Cara kerja ekstensi, tugas pra-penginstalan, dan detail tentang ekstensi
  • Informasi dan deskripsi pengidentifikasi umum
  • Apakah tugas ekstensi memerlukan akun penagihan atau tidak
  • Layanan Google (API) dan peran akses yang diperlukan untuk operasi
  • Resource yang dibuat untuk ekstensi (seperti fungsi)
  • Deskripsi parameter yang dapat dikonfigurasi oleh pengguna

Untuk melihat informasi mendetail tentang ekstensi:

  1. Pastikan Anda telah menyiapkan lingkungan dan memilih ekstensi.

  2. Jalankan perintah extension-info dari mana saja di komputer Anda:

    firebase ext:info publisher-id/extension-id

    Argumen publisher-id dan extension-id diperlukan dan dapat ditemukan di halaman detail pra-penginstalan ekstensi.

Langkah 2: Instal ekstensi

Selama proses penginstalan, Anda akan diminta untuk meninjau spesifikasi dasar ekstensi (seperti API yang diaktifkan, resource yang dibuat, akses yang diberikan, dll.). Anda akan diberi tahu tentang persyaratan penagihan, dan juga akan diminta menentukan nilai parameter yang dapat dikonfigurasi untuk ekstensi tersebut.

  1. Pastikan Anda telah menyiapkan lingkungan dan memilih ekstensi.

  2. Jalankan perintah extension-install. Jika diminta, masukkan parameter value untuk menyesuaikan instance ekstensi.

    firebase ext:install publisher-id/extension-id --project=projectId-or-alias

    Argumen publisher-id dan extension-id diperlukan dan dapat ditemukan di halaman detail pra-penginstalan ekstensi.

Langkah 3: Selesaikan penyiapan pasca-penginstalan

Beberapa ekstensi memiliki langkah wajib atau opsional yang harus Anda selesaikan sebelum menggunakannya. Temukan petunjuk ini di halaman detail pasca-penginstalan ekstensi di dasbor Extensions pada Firebase console (link spesifik ke dasbor akan ditampilkan di terminal setelah penginstalan).

Anda juga dapat menemukan petunjuk ini dalam file POSTINSTALL.md yang disertakan di direktori sumber ekstensi.

Membuat resource Firebase

Jika Anda mengonfigurasi ekstensi untuk menggunakan resource Firebase (koleksi Cloud Firestore, jalur Realtime Database, bucket Cloud Storage) yang belum ada, buat ekstensi sebelum menggunakan ekstensi.

Membuat pengendali peristiwa Eventarc

Beberapa ekstensi dipublikasikan ke Eventarc saat peristiwa penting terjadi selama eksekusi. Jika ekstensi memublikasikan peristiwa dan mengaktifkan peristiwa selama penginstalan, Anda dapat menulis fungsi yang bereaksi terhadap peristiwa tersebut dengan logika kustom Anda sendiri. Hal ini dapat berguna, misalnya, untuk memberi tahu pengguna saat tugas yang berjalan lama selesai, atau untuk pasca-proses output fungsi ekstensi.

Lihat dokumentasi ekstensi untuk daftar peristiwa (jika ada) yang dipublikasikan.

Kemudian, lihat Pemicu peristiwa kustom untuk mengetahui informasi tentang cara menulis pengendali peristiwa Eventarc.

Menginstal beberapa instance ekstensi

Catatan: Anda dapat menginstal ekstensi yang sama beberapa kali dalam project yang sama. Setiap instance yang diinstal dapat memiliki konfigurasi yang disesuaikan sendiri dan resource ekstensinya sendiri. Anda mengidentifikasi dan merujuk ke setiap instance yang diinstal menggunakan ID instance yang bersifat unik dalam project Anda. Anda akan diminta untuk mengonfirmasi atau mengedit ID instance dari setiap instance tambahan ekstensi yang Anda instal.

Langkah Berikutnya

  • Lihat detail dan konfigurasi ekstensi yang diinstal di Firebase console.

  • Pantau aktivitas ekstensi yang diinstal, termasuk memeriksa respons, penggunaan, dan log-nya.

  • Kelola ekstensi yang diinstal menggunakan Firebase CLI. Anda dapat mengonfigurasi ulang atau meng-uninstal ekstensi, serta mengupdate ekstensi ke versi terbaru.

  • Kelola ekstensi yang diinstal menggunakan Firebase console. Untuk ekstensi Firebase resmi, Anda dapat mengonfigurasi ulang atau meng-uninstal ekstensi, serta mengupdate ekstensi ke versi terbaru.

  • Sebagai praktik terbaik untuk semua project, pastikan Anda menyiapkan pemberitahuan anggaran untuk project Anda dan memantau dasbor Penggunaan dan penagihan di Firebase console.