CINXE.COM

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Sync Client Documentation — Mozilla Services</title> <link rel="stylesheet" href="../_static/mozilla.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="https://media.readthedocs.org/css/badge_only.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/jquery/jquery-2.0.3.min.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/jquery/jquery-migrate-1.2.1.min.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/underscore.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/doctools.js"></script> <script type="text/javascript" src="https://media.readthedocs.org/javascript/readthedocs-doc-embed.js"></script> <link rel="author" title="About these documents" href="../about.html" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Overview" href="overview.html" /> <link rel="prev" title="Metrics Collection" href="../metrics/index.html" />   <link rel="canonical" href="http://moz-services-docs.readthedocs.io/en/latest/sync/" /> <link rel="stylesheet" href="https://media.readthedocs.org/css/readthedocs-doc-embed.css" type="text/css" /> <script type="text/javascript" src="../_static/readthedocs-data.js"></script>  <script type="text/javascript"> READTHEDOCS_DATA['page'] = 'sync/index' READTHEDOCS_DATA['source_suffix'] = '.rst' </script> <script type="text/javascript" src="../_static/readthedocs-dynamic-include.js"></script> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="moz-services-docs" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/sync/" /><meta name="readthedocs-http-status" content="200" /></head> <body role="document"><a href="http://www.mozilla.org/" id="tabzilla">mozilla</a> <div class="document"> <div class="documentwrapper"> <div class="sphinxsidebar"> <nav> <h2><a href="../index.html">Mozilla Services</a></h2> <ul> <li class="toctree-l1"><a class="reference internal" href="../howtos/run-sync.html">Run your own Sync-1.1 Server</a></li> <li class="toctree-l1"><a class="reference internal" href="../howtos/run-sync-1.5.html">Run your own Sync-1.5 Server</a></li> <li class="toctree-l1"><a class="reference internal" href="../howtos/run-fxa.html">Run your own Firefox Accounts Server</a></li> <li class="toctree-l1"><a class="reference internal" href="../howtos/configure-tls.html">Configure your Sync server for TLS</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../fxa/index.html">Firefox Accounts Server</a></li> <li class="toctree-l1"><a class="reference internal" href="../storage/index.html">Storage Service</a></li> <li class="toctree-l1"><a class="reference internal" href="../reg/index.html">Registration</a></li> <li class="toctree-l1"><a class="reference internal" href="../keyexchange/index.html">Easy Setup</a></li> <li class="toctree-l1"><a class="reference internal" href="../sreg/index.html">Secure-Registration (Mozilla specific)</a></li> <li class="toctree-l1"><a class="reference internal" href="../token/index.html">Token Server</a></li> <li class="toctree-l1"><a class="reference internal" href="../heka/index.html">Heka</a></li> <li class="toctree-l1"><a class="reference internal" href="../loop/index.html">Loop Server</a></li> <li class="toctree-l1"><a class="reference internal" href="../msisdn-gateway/index.html">MSISDN Gateway</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../server-devguide/index.html">Python Server Development Guide</a></li> </ul> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../healthreport/index.html">Firefox Health Report</a></li> <li class="toctree-l1"><a class="reference internal" href="../metrics/index.html">Metrics Collection</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Sync Client Documentation</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../overview.html">Overview of the services</a></li> <li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> <li class="toctree-l1"><a class="reference internal" href="../respcodes.html">Response codes</a></li> <li class="toctree-l1"><a class="reference internal" href="../tos.html">Term of Services</a></li> <li class="toctree-l1"><a class="reference internal" href="../about.html">About this Website</a></li> </ul> </nav> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <div><input type="text" name="q" /></div> <div><input type="submit" value="Go" /></div> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> <div class="bodywrapper"> <div class="body"> <div class="section" id="sync-client-documentation"> <h1>Sync Client Documentation<a class="headerlink" href="#sync-client-documentation" title="Permalink to this headline">露</a></h1> <p>This section is intended to provide a comprehensive guide to how Firefox Sync clients interact with the server and ultimately with each other to provide the functionality of syncing browser data between clients.</p> <p>It is a somewhat technical document, but should require no in-depth knowledge. Links to more detailed API docs offer an opportunity to dig deeper.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul> <li class="toctree-l2"><a class="reference internal" href="overview.html#introduction">Introduction</a></li> <li class="toctree-l2"><a class="reference internal" href="overview.html#the-sync-server">The Sync Server</a></li> <li class="toctree-l2"><a class="reference internal" href="overview.html#collections-and-records">Collections and records</a></li> <li class="toctree-l2"><a class="reference internal" href="overview.html#sync-clients">Sync Clients</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="lifeofasync.html">The Life of a Sync</a><ul> <li class="toctree-l2"><a class="reference internal" href="lifeofasync.html#initial-client-configuration">Initial Client Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="lifeofasync.html#performing-a-sync">Performing a Sync</a></li> <li class="toctree-l2"><a class="reference internal" href="lifeofasync.html#old-content">OLD CONTENT</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="storageformats.html">Sync Storage Formats</a><ul> <li class="toctree-l2"><a class="reference internal" href="storageformats.html#global-storage-version">Global Storage Version</a></li> <li class="toctree-l2"><a class="reference internal" href="storageformats.html#collection-object-format-versions">Collection/Object Format Versions</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="storageformat5.html">Global Storage Version 5</a><ul> <li class="toctree-l2"><a class="reference internal" href="storageformat5.html#overview">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="storageformat5.html#cryptography">Cryptography</a></li> <li class="toctree-l2"><a class="reference internal" href="storageformat5.html#metaglobal-record">Metaglobal Record</a></li> <li class="toctree-l2"><a class="reference internal" href="storageformat5.html#crypto-keys-record">crypto/keys record</a></li> <li class="toctree-l2"><a class="reference internal" href="storageformat5.html#collection-records">Collection Records</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="storageformat6.html">Global Storage Version 6</a><ul> <li class="toctree-l2"><a class="reference internal" href="storageformat6.html#cryptographic-model">Cryptographic Model</a></li> <li class="toctree-l2"><a class="reference internal" href="storageformat6.html#global-metadata-record">Global Metadata Record</a></li> <li class="toctree-l2"><a class="reference internal" href="storageformat6.html#crypto-collection">crypto Collection</a></li> <li class="toctree-l2"><a class="reference internal" href="storageformat6.html#changes-since-version-5">Changes Since Version 5</a></li> <li class="toctree-l2"><a class="reference internal" href="storageformat6.html#sync-key-stored-on-server">Sync Key Stored on Server</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="objectformats.html">Firefox object formats</a><ul> <li class="toctree-l2"><a class="reference internal" href="objectformats.html#add-ons">Add-ons</a></li> <li class="toctree-l2"><a class="reference internal" href="objectformats.html#bookmarks">Bookmarks</a></li> <li class="toctree-l2"><a class="reference internal" href="objectformats.html#clients">Clients</a></li> <li class="toctree-l2"><a class="reference internal" href="objectformats.html#commands">Commands</a></li> <li class="toctree-l2"><a class="reference internal" href="objectformats.html#forms">Forms</a></li> <li class="toctree-l2"><a class="reference internal" href="objectformats.html#history">History</a></li> <li class="toctree-l2"><a class="reference internal" href="objectformats.html#passwords">Passwords</a></li> <li class="toctree-l2"><a class="reference internal" href="objectformats.html#preferences">Preferences</a></li> <li class="toctree-l2"><a class="reference internal" href="objectformats.html#tabs">Tabs</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="mozilla.html">Mozilla’s Sync Service</a><ul> <li class="toctree-l2"><a class="reference internal" href="mozilla.html#architecture">Architecture</a></li> <li class="toctree-l2"><a class="reference internal" href="mozilla.html#easy-setup-service">Easy Setup Service</a></li> <li class="toctree-l2"><a class="reference internal" href="mozilla.html#crypto-record-semantics">Crypto Record Semantics</a></li> </ul> </li> </ul> </div> </div> </div> </div> </div> <div class="clearer"></div> </div> <div class="footer" role="contentinfo"> © Copyright 2017, Mozilla Foundation, CC BY-SA 2.5. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.3. </div> <script src="//www.mozilla.org/tabzilla/media/js/tabzilla.js"></script> </body> </html>