Firefox/RemoteSettings

From MozillaWiki
Jump to: navigation, search

Firefox Remote Settings

Remote Settings is a Mozilla service that makes it easy to manage evergreen settings data in Firefox. Firefox/Kinto is used for syncing of data. A simple API is available in Firefox for accessing the synchronized data.

Key Features

  • Admin UI (generated from data schema)
  • Data history
  • Preview data (QA)
  • Sign-off (review)
  • File attachments
  • Email notifications
  • Content signature (Autograph integration)
  • Single endpoint for polling for changes
  • Client synchronization (diff based, local db)
  • Client-side target filtering (JEXL a-la Normandy)
  • Client Telemetry
  • Robust protocol (retry, precondition headers, backoff, …)
const { RemoteSettings } = ChromeUtils.import("resource://services-settings/remote-settings.js", {});

RemoteSettings("my-collection")
  .on("sync", (e) => {
    // e.data.current = [ Record, Record, ... ]
  });

Resources

RemoteSettings DevTools

An addon is available to diagnose remote settings synchronization and state. See https://github.com/mozilla/remote-settings-devtools