CloudServices/Sync

Summary

Welcome to the developer home of Firefox Sync. For end-user (non-technical) information, please see the official Sync web site.

Firefox Sync is a set of software components and specifications that synchronize data between multiple Mozilla product instances. The software is open source and the specifications are all public. This means that others are free to implement components or run the software on their own.

User Support

We have some pages we use to help our "advanced" users get us diagnostic information

• For desktop users.
• For iOS users.
• For Android users.

We also have some canned responses for bugzilla bugs.

Products and Services

The Sync family consists of the following products and services:

Sync client

integrated in the Firefox and Firefox Mobile browsers, this client coordinates the syncing of all selected syncable data via their engines.

Server

Server component used for cross-client communication – this is where client-side encrypted data is stored for all clients to synchronize with.

Server Instance

A Sync server operated by Mozilla available for use by anybody in the world, free of charge. This is where Firefox sends data by default, unless you specify a different server.

Send / Close Tabs

the Sync key is used to secure a Sent Tab (to encrypt the Send Tab key), so we generally include Sending and Closing remote tabs as part of Sync.

Previous services:

Firefox Home

An iOS application (iPhone, iPad) that allows you to view Sync data from these devices

Specifications

The Specifications of Sync cover:

HTTP API

Implemented by the Sync Server. Used by clients to exchange data.

Cryptography Model

How encryption is used to securely store data in the Sync Server (the Sync Server can't even read user data).

Data Storage Formats

How existing clients (like Firefox) format synchronized data.

Client APIs

These include the JavaScript API available in Firefox.

Get Involved

Matrix

Shout out in the #sync:mozilla.org room on Mozilla's Matrix server.

Most team members are geographically located in North America and Australia. If you don't hear a response, try asking again in a few hours.

Mailing List

See services-dev for email contact info.

Report Bugs

Sync bugs should be reported in Bugzilla, depending on the nature of the bug.

For general issues, each platform has its own component:

• File here for Desktop
• File here for Android
• File here for iOS

If you know that a more specific component is more appropriate, such as individual engines or the Sync-related UIs in Firefox:

• File here for shared Sync components in the Application Services library
• File here for Sync-/Account-related UIs in Firefox desktop

Source Code and Development

Source code for all products and services is available and open source. Public contributions and feedback for product direction is encouraged and very welcome.

General development information is available at Getting Started. Production-specific information can be found at the linked product page from the list of products above. There is also a trove of documentation at Mozilla Services Documentation.

Team Docs

FAQ

• Low level sync FAQ

• Sync internals video | slides

Telemetry

• Definitions of data available in Re:Dash under main Sync ping
• Firefox Sync extended logging for fetching successful sync event logfiles

Working Docs

• Themes and Initiative OKRs

• Feature Tracker/Trello Board

• Current Work - Sprint 1

Bug Queries

• Bug process for sprints
• Backlog (all priorities)
• Triage (unprioritized)
• P1s Desktop
• View Bugs by Feature

iOS Triage

• iOS issues doc

• Bi-Directional bookmarks reference doc

Cross Team Projects

Device Manager

• Problem
  • Currently sync uses the 'clients' sync data collection as a list of active devices. This list has no state and difficult to 'delete' an device off list. Most client display a device if it's been active within the last two weeks. This design creates a number of bugs visible to the user.
• Plan
  • All devices, Desktop, Android, iOS register with FxA
  • There should be events that removed devices from this list, such as uninstall, reinstall, or devices with the same name conflicts.
  • FxA device manager endpoint provides real-time list of active devices to sync clients to display.
• FxA device manager *WIP*
• Github Issue in Waffle board
• Feature Document

• Current Status
  • Pending device registration on iOS and fixing issues - bug 1250783 - active WIP
  • Pending fixes to settings display
  • Pending work to improve the accuracy of the device list controlled by user events.
  • Pending management UI of devices.

Send Tab

• PRD
• Design
  • Architecture and discussion
  • Implementation
• Send Tab Tasks

Plan

• Aug 9 - push send tab between desktop
• Next - send tab to fennec with push
  • Android must have device registration
• Next2 - sent tab to iOS with push
  • iOS must have device registration

Atomic IO

• Atomic IO

Other Info

If you are coming from Xmarks, see our Xmarks quick reference.