Difference between revisions of "Mozilla Firefox Sync Server"

From ArchWiki
Jump to: navigation, search
(Add set email section)
(recategorize to avoid redirect after the old category has been renamed (https://github.com/lahwaacz/wiki-scripts/blob/master/recategorize-over-redirect.py))
 
(17 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:Web Server]]
+
[[Category:Web server]]
 +
{{Poor writing|Various [[Help:Style|style]] problems. Personal comments should go in the Discussion page.}}
 
From [[Wikipedia:Firefox_Sync|Wikipedia]]:
 
From [[Wikipedia:Firefox_Sync|Wikipedia]]:
 
: ''Firefox Sync, originally branded Mozilla Weave, is a browser synchronization feature that allows users to partially synchronize bookmarks, browsing history, preferences, passwords, filled forms, add-ons and the last 25 opened tabs across multiple computers.''
 
: ''Firefox Sync, originally branded Mozilla Weave, is a browser synchronization feature that allows users to partially synchronize bookmarks, browsing history, preferences, passwords, filled forms, add-ons and the last 25 opened tabs across multiple computers.''
Line 5: Line 6:
 
: ''It keeps user data on Mozilla servers, but the data is encrypted in such a way that no third party, not even Mozilla, can access user information. It is also possible for the user to host their own Firefox Sync servers, or indeed, for any entity to do so.''
 
: ''It keeps user data on Mozilla servers, but the data is encrypted in such a way that no third party, not even Mozilla, can access user information. It is also possible for the user to host their own Firefox Sync servers, or indeed, for any entity to do so.''
  
This page details how you should proceed to host your own (Mozilla) Firefox Sync Server (shortened to FFSync).
+
This page details how you should proceed to host your own (Mozilla) Firefox Sync Server (shortened to FFSync), version 1.1 or version 1.5, and how to host your own Firefox Account server.
  
==Installation==
+
{{Note| The 1.1 version of the Mozilla Firefox Sync Server has been deprecated in Firefox 29 and support has been removed from version 32. Version 1.5 of the Mozilla Firefox Sync Server is available for Firefox 29+. However, this now requires users create a Firefox Account. See the following links for details:
 +
* https://wiki.mozilla.org/Identity/Firefox_Accounts
 +
* https://blog.mozilla.org/blog/2014/02/07/introducing-mozilla-firefox-accounts/
 +
* https://blog.mozilla.org/services/2014/02/07/a-better-firefox-sync/
 +
* https://blog.mozilla.org/futurereleases/2014/02/07/test-the-new-firefox-sync-and-customize-the-new-ui-in-firefox-aurora/
 +
}}
 +
{{Note| The 1.1 and 1.5 versions are currently conflicting for simplicity but one could have the two versions alongside on the same server with some changes. The databases should probably not be shared between different versions however.}}
 +
{{Tip| Enter {{ic|about:sync-log}} in the Firefox URL bar to get a list of logs related to Firefox Sync.}}
 +
 
 +
==Version 1.5==
 +
 
 +
This is for Firefox version 29 and onward.
 +
{{Warning| I could not get the 1.5 version to work when running behind nginx with HTTPS. I'm affected by the bug described in https://mail.mozilla.org/pipermail/sync-dev/2014-August/000955.html and I do not understand how the problem got resolved. It works for me with plain HTTP connexions though. [[User:Siosm|Siosm]] ([[User talk:Siosm|talk]]) 09:32, 12 September 2014 (UTC)
 +
}}
 +
 
 +
===Installation===
 +
 
 +
{{AUR|mozilla-firefox-sync-server-git}} is available in the [[AUR]].
 +
 
 +
The setup creates an isolated Python environment in which all necessary dependencies are downloaded and installed. Afterwards, running the server only relies on the isolated Python environment, independently of the system-wide Python.
 +
 
 +
===Server configuration===
 +
 
 +
One file is available to configure a FFsync server: {{ic|/opt/mozilla-firefox-sync-server/syncserver.ini}}. Most options are explained clearly in the [http://docs.services.mozilla.com/howtos/run-sync-1.5.html official documentation]. Here is a full example with comments:
 +
 
 +
{{bc|1=
 +
# Use a Unix socket and the Gunicorn server
 +
[server:main]
 +
use = egg:gunicorn#main
 +
bind = unix:/run/ffsync/syncserver.sock
 +
workers = 2
 +
timeout = 60
 +
syslog = true
 +
syslog_prefix = ffsync
 +
syslog_facility = daemon
 +
 
 +
[app:main]
 +
use = egg:syncserver
 +
 
 +
[syncserver]
 +
# This must be edited to point to the public URL of your server,
 +
# i.e. the URL as seen by Firefox.
 +
public_url = <nowiki>http://example.com/ffsync/</nowiki>
 +
 
 +
# This defines the database in which to store all server data.
 +
sqluri = sqlite:////var/lib/ffsync/sync_storage.db
 +
 
 +
# This is a secret key used for signing authentication tokens.
 +
# It should be long and randomly-generated.
 +
# The following command will give a suitable value on *nix systems:
 +
#
 +
#    head -c 20 /dev/urandom | sha1sum
 +
#
 +
# If not specified then the server will generate a temporary one at startup.
 +
secret = AZERTYUIOPQSDFGHJKLMWXCVBN
 +
 
 +
# Set this to "false" to disable new-user signups on the server.
 +
# Only request by existing accounts will be honoured.
 +
allow_new_users = true
 +
 
 +
# Uncomment and edit the following to use a local BrowserID verifier
 +
# rather than posing assertions to the mozilla-hosted verifier.
 +
# Audiences should be set to your public_url without a trailing slash.
 +
#[browserid]
 +
#backend = tokenserver.verifiers.LocalVerifier
 +
#audiences = <nowiki>https://localhost:5000</nowiki>
 +
}}
 +
 
 +
===Running behind nginx===
 +
 
 +
A sample from the nginx config:
 +
 
 +
{{bc|1=
 +
        # Firefox sync config
 +
        location /ffsync/ {
 +
            rewrite  ^/ffsync(.+)$ $1 break;
 +
            proxy_pass <nowiki>http://unix:/run/ffsync/syncserver.sock;</nowiki>
 +
            proxy_set_header Host $http_host;
 +
            proxy_set_header X-Real-IP $remote_addr;
 +
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
 +
            proxy_set_header X-Forwarded-Proto $scheme;
 +
            proxy_redirect off;
 +
            proxy_read_timeout 120;
 +
            proxy_connect_timeout 10;
 +
            gzip        off;
 +
        }
 +
}}
 +
 
 +
===Client configuration===
 +
 
 +
To configure desktop Firefox to talk to your new Sync server, go to {{ic|about:config}}, search for {{ic|services.sync.tokenServerURI}} and change its value to the URL of your server with a path of {{ic|token/1.0/sync/1.5}}:
 +
{{bc|1=
 +
services.sync.tokenServerURI: <nowiki>http://example.com/ffsync/token/1.0/sync/1.5</nowiki>
 +
}}
 +
 
 +
===Firefox Account Server===
 +
 
 +
Until this section is completed, you will have to use the official Firefox Accounts service provided by Mozilla. You can try running your own by following the instructions from the [http://docs.services.mozilla.com/howtos/run-fxa.html official documentation].
 +
 
 +
==Version 1.1==
 +
 
 +
This is for Firefox version up to but not including version 32.
 +
 
 +
===Installation===
  
 
{{AUR|mozilla-firefox-sync-server-hg}} is available in the [[AUR]].
 
{{AUR|mozilla-firefox-sync-server-hg}} is available in the [[AUR]].
Line 13: Line 117:
 
The setup creates an isolated Python environment in which all necessary dependencies are downloaded and installed. Afterwards, running the server only relies on the isolated Python environment, independently of the system-wide Python.
 
The setup creates an isolated Python environment in which all necessary dependencies are downloaded and installed. Afterwards, running the server only relies on the isolated Python environment, independently of the system-wide Python.
  
==Server configuration==
+
===Server configuration===
  
 
Two files are used to configure a FFsync server: {{ic|/opt/mozilla-firefox-sync-server/development.ini}} and {{ic|/opt/mozilla-firefox-sync-server/etc/sync.conf}}.
 
Two files are used to configure a FFsync server: {{ic|/opt/mozilla-firefox-sync-server/development.ini}} and {{ic|/opt/mozilla-firefox-sync-server/etc/sync.conf}}.
  
===Basic configuration===
+
====Basic configuration====
  
 
The fallback node URL must reflect the server's visible URL (here {{ic|<nowiki>https://example.com/ffsync/</nowiki>}}). In {{ic|/opt/mozilla-firefox-sync-server/etc/sync.conf}}, change:
 
The fallback node URL must reflect the server's visible URL (here {{ic|<nowiki>https://example.com/ffsync/</nowiki>}}). In {{ic|/opt/mozilla-firefox-sync-server/etc/sync.conf}}, change:
Line 30: Line 134:
 
}}
 
}}
  
===Disable debug mode===
+
====Disable debug mode====
  
 
In {{ic|/opt/mozilla-firefox-sync-server/development.ini}}, set:
 
In {{ic|/opt/mozilla-firefox-sync-server/development.ini}}, set:
Line 38: Line 142:
 
}}
 
}}
  
===Set email===
+
====Set email====
  
 
In {{ic|/opt/mozilla-firefox-sync-server/etc/sync.conf}}, set:
 
In {{ic|/opt/mozilla-firefox-sync-server/etc/sync.conf}}, set:
Line 46: Line 150:
 
}}
 
}}
  
===Storage backend===
+
====Storage backend====
  
The default storage backend is sqlite which should be fine if you don't have a lot of users. To split the various databases into several files, edit the {{ic|sqluri}} fields in {{ic|/opt/mozilla-firefox-sync-server/etc/sync.conf}}.
+
The default storage backend is sqlite which should be fine if you do not have a lot of users. To split the various databases into several files, edit the {{ic|sqluri}} fields in {{ic|/opt/mozilla-firefox-sync-server/etc/sync.conf}}.
  
 
The [http://docs.services.mozilla.com/howtos/run-sync.html Official FFsync server Howto] details setup with MySQL or LDAP as a backend.
 
The [http://docs.services.mozilla.com/howtos/run-sync.html Official FFsync server Howto] details setup with MySQL or LDAP as a backend.
  
===Disk quota===
+
====Disk quota====
  
 
The default disk quota is quite restrictive and will quickly be filled if a lot of bookmarks are stored. Bump the disk quota from 5 to 25 MB in {{ic|/opt/mozilla-firefox-sync-server/etc/sync.conf}}:
 
The default disk quota is quite restrictive and will quickly be filled if a lot of bookmarks are stored. Bump the disk quota from 5 to 25 MB in {{ic|/opt/mozilla-firefox-sync-server/etc/sync.conf}}:
Line 62: Line 166:
 
}}
 
}}
  
===Running behind a Web Server===
+
====Running behind a Web Server====
  
 
The default configuration runs a built-in server which should not be used in production.
 
The default configuration runs a built-in server which should not be used in production.
  
====Apache combined with mod_wsgi====
+
=====Apache combined with mod_wsgi=====
  
 
See the [http://docs.services.mozilla.com/howtos/run-sync.html Official FFsync server Howto].
 
See the [http://docs.services.mozilla.com/howtos/run-sync.html Official FFsync server Howto].
  
====nginx with Gunicorn====
+
=====nginx with Gunicorn=====
  
 
The [[PKGBUILD]] available in the [[AUR]] installs the Gunicorn server, in the python {{ic|virtualenv}}, by default. Enable it by changing the following lines in {{ic|/opt/mozilla-firefox-sync-server/development.ini}}:
 
The [[PKGBUILD]] available in the [[AUR]] installs the Gunicorn server, in the python {{ic|virtualenv}}, by default. Enable it by changing the following lines in {{ic|/opt/mozilla-firefox-sync-server/development.ini}}:
Line 110: Line 214:
 
}}
 
}}
  
===Not recommended setup with default web server===
+
====Not recommended setup with default web server====
 +
 
 +
{{Style|vague statement ("outdated"), see [[Help:Style#Language register]]}}
  
 
(Outdated) systemd service unit:
 
(Outdated) systemd service unit:
Line 133: Line 239:
 
}}
 
}}
  
==Client configuration==
+
===Client configuration===
  
Use the Sync Configuration Wizard in Firefox' Settings to create a new account on the server. Don't forget to choose "Custom server..." in the list, and input the server address: {{ic|<nowiki>https://example.com/ffsync/</nowiki>}}
+
Use the Sync Configuration Wizard in Firefox' Settings to create a new account on the server. Do not forget to choose "Custom server..." in the list, and input the server address: {{ic|<nowiki>https://example.com/ffsync/</nowiki>}}
  
 
The "Advanced Settings" button allows fine tuning of the synchronized elements list, and the definition of the client hostname.
 
The "Advanced Settings" button allows fine tuning of the synchronized elements list, and the definition of the client hostname.
Line 142: Line 248:
  
 
* [http://docs.services.mozilla.com/howtos/run-sync.html Official Mozilla Firefox Sync Server Howto]
 
* [http://docs.services.mozilla.com/howtos/run-sync.html Official Mozilla Firefox Sync Server Howto]
 
 
* [http://alien.slackbook.org/blog/setting-up-your-own-mozilla-sync-server/ Howto with Apache support by Eric Hameleers]
 
* [http://alien.slackbook.org/blog/setting-up-your-own-mozilla-sync-server/ Howto with Apache support by Eric Hameleers]
 
* [https://tim.siosm.fr/blog/2012/12/11/firefox-sync-nginx-systemd/ Howto with nginx and systemd support by Timothée Ravier]
 
* [https://tim.siosm.fr/blog/2012/12/11/firefox-sync-nginx-systemd/ Howto with nginx and systemd support by Timothée Ravier]
 
* [http://amnesiak.org/blog/mozilla-sync-server-with-nginx.html Howto with nginx support]
 
* [http://amnesiak.org/blog/mozilla-sync-server-with-nginx.html Howto with nginx support]
 
* [http://terminal28.com/how-to-install-and-configure-own-firefox-sync-server-weave-debian/ Howto using MySQL]
 
* [http://terminal28.com/how-to-install-and-configure-own-firefox-sync-server-weave-debian/ Howto using MySQL]
 
+
* [[OwnCloud]] has mozilla sync server application
* [[Owncloud]] has mozilla sync server application (looks outdated)
+

Latest revision as of 17:13, 26 July 2015

Tango-edit-clear.pngThis article or section needs language, wiki syntax or style improvements.Tango-edit-clear.png

Reason: Various style problems. Personal comments should go in the Discussion page. (Discuss in Talk:Mozilla Firefox Sync Server#)

From Wikipedia:

Firefox Sync, originally branded Mozilla Weave, is a browser synchronization feature that allows users to partially synchronize bookmarks, browsing history, preferences, passwords, filled forms, add-ons and the last 25 opened tabs across multiple computers.
It keeps user data on Mozilla servers, but the data is encrypted in such a way that no third party, not even Mozilla, can access user information. It is also possible for the user to host their own Firefox Sync servers, or indeed, for any entity to do so.

This page details how you should proceed to host your own (Mozilla) Firefox Sync Server (shortened to FFSync), version 1.1 or version 1.5, and how to host your own Firefox Account server.

Note: The 1.1 version of the Mozilla Firefox Sync Server has been deprecated in Firefox 29 and support has been removed from version 32. Version 1.5 of the Mozilla Firefox Sync Server is available for Firefox 29+. However, this now requires users create a Firefox Account. See the following links for details:
Note: The 1.1 and 1.5 versions are currently conflicting for simplicity but one could have the two versions alongside on the same server with some changes. The databases should probably not be shared between different versions however.
Tip: Enter about:sync-log in the Firefox URL bar to get a list of logs related to Firefox Sync.

Version 1.5

This is for Firefox version 29 and onward.

Warning: I could not get the 1.5 version to work when running behind nginx with HTTPS. I'm affected by the bug described in https://mail.mozilla.org/pipermail/sync-dev/2014-August/000955.html and I do not understand how the problem got resolved. It works for me with plain HTTP connexions though. Siosm (talk) 09:32, 12 September 2014 (UTC)

Installation

mozilla-firefox-sync-server-gitAUR is available in the AUR.

The setup creates an isolated Python environment in which all necessary dependencies are downloaded and installed. Afterwards, running the server only relies on the isolated Python environment, independently of the system-wide Python.

Server configuration

One file is available to configure a FFsync server: /opt/mozilla-firefox-sync-server/syncserver.ini. Most options are explained clearly in the official documentation. Here is a full example with comments:

# Use a Unix socket and the Gunicorn server
[server:main]
use = egg:gunicorn#main
bind = unix:/run/ffsync/syncserver.sock
workers = 2
timeout = 60
syslog = true
syslog_prefix = ffsync
syslog_facility = daemon

[app:main]
use = egg:syncserver

[syncserver]
# This must be edited to point to the public URL of your server,
# i.e. the URL as seen by Firefox.
public_url = http://example.com/ffsync/

# This defines the database in which to store all server data.
sqluri = sqlite:////var/lib/ffsync/sync_storage.db

# This is a secret key used for signing authentication tokens.
# It should be long and randomly-generated.
# The following command will give a suitable value on *nix systems:
#
#    head -c 20 /dev/urandom

Running behind nginx

A sample from the nginx config:

# Firefox sync config
        location /ffsync/ {
            rewrite  ^/ffsync(.+)$ $1 break;
            proxy_pass http://unix:/run/ffsync/syncserver.sock;
            proxy_set_header Host $http_host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;
            proxy_redirect off;
            proxy_read_timeout 120;
            proxy_connect_timeout 10;
            gzip        off;
        }

Client configuration

To configure desktop Firefox to talk to your new Sync server, go to about:config, search for services.sync.tokenServerURI and change its value to the URL of your server with a path of token/1.0/sync/1.5:

services.sync.tokenServerURI: http://example.com/ffsync/token/1.0/sync/1.5

Firefox Account Server

Until this section is completed, you will have to use the official Firefox Accounts service provided by Mozilla. You can try running your own by following the instructions from the official documentation.

Version 1.1

This is for Firefox version up to but not including version 32.

Installation

mozilla-firefox-sync-server-hgAUR is available in the AUR.

The setup creates an isolated Python environment in which all necessary dependencies are downloaded and installed. Afterwards, running the server only relies on the isolated Python environment, independently of the system-wide Python.

Server configuration

Two files are used to configure a FFsync server: /opt/mozilla-firefox-sync-server/development.ini and /opt/mozilla-firefox-sync-server/etc/sync.conf.

Basic configuration

The fallback node URL must reflect the server's visible URL (here https://example.com/ffsync/). In /opt/mozilla-firefox-sync-server/etc/sync.conf, change:

[nodes]
fallback_node = http://localhost:5000/

to:

[nodes]
fallback_node = https://example.com/ffsync/

Disable debug mode

In /opt/mozilla-firefox-sync-server/development.ini, set:

[DEFAULT]
debug = False

Set email

In /opt/mozilla-firefox-sync-server/etc/sync.conf, set:

[smtp]
sender = ffsync@example.com

Storage backend

The default storage backend is sqlite which should be fine if you do not have a lot of users. To split the various databases into several files, edit the sqluri fields in /opt/mozilla-firefox-sync-server/etc/sync.conf.

The Official FFsync server Howto details setup with MySQL or LDAP as a backend.

Disk quota

The default disk quota is quite restrictive and will quickly be filled if a lot of bookmarks are stored. Bump the disk quota from 5 to 25 MB in /opt/mozilla-firefox-sync-server/etc/sync.conf:

[storage]
...
quota_size = 25600
...

Running behind a Web Server

The default configuration runs a built-in server which should not be used in production.

Apache combined with mod_wsgi

See the Official FFsync server Howto.

nginx with Gunicorn

The PKGBUILD available in the AUR installs the Gunicorn server, in the python virtualenv, by default. Enable it by changing the following lines in /opt/mozilla-firefox-sync-server/development.ini:

[server:main]
use = egg:gunicorn#main
host = unix:/run/ffsync/syncserver.sock
use_threadpool = True
threadpool_workers = 60

Create the /etc/tmpfiles.d/ffsync.conf file to create the /run/ffsync/ folder at boot:

D /run/ffsync 0750 ffsync http

Create this folder now by running:

# systemd-tmpfiles --create ffsync.conf

Enable and start the Gunicorn serveur using the systemd service unit provided in mozilla-firefox-sync-server-hgAUR:

# systemctl enable ffsync
# systemctl start ffsync

Use this config extract to configure nginx:

# Firefox sync config
location /ffsync/ {
    rewrite  ^/ffsync(.+)$ $1 break;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header Host $http_host;
    proxy_redirect off;
    proxy_pass http://unix:/run/ffsync/syncserver.sock;
}

Not recommended setup with default web server

Tango-edit-clear.pngThis article or section needs language, wiki syntax or style improvements.Tango-edit-clear.png

Reason: vague statement ("outdated"), see Help:Style#Language register (Discuss in Talk:Mozilla Firefox Sync Server#)

(Outdated) systemd service unit:

/etc/systemd/system/ffsync.service
[Unit]
Description=Mozilla Firefox Syn Server
After=network.target

[Service]
Type=simple
User=ffsync
Group=ffsync
WorkingDirectory=/opt/mozilla-firefox-sync-server
ExecStart=/opt/mozilla-firefox-sync-server/bin/python2 /opt/mozilla-firefox-sync-server/bin/paster serve /opt/mozilla-firefox-sync-server/development.ini
StandardOutput=/var/log/ffsync/sync-messages.log

[Install]
WantedBy=multi-user.target
Alias=ffsync.service

Client configuration

Use the Sync Configuration Wizard in Firefox' Settings to create a new account on the server. Do not forget to choose "Custom server..." in the list, and input the server address: https://example.com/ffsync/

The "Advanced Settings" button allows fine tuning of the synchronized elements list, and the definition of the client hostname.

See also