Table of Contents

• Prerequisites
• Building the Sync Server
• Create Unix User and MySQL Database
• Sync Server Configuration
• Apache Configuration
• DNS Configuration
• Mail Configuration
• Testing the Mozilla Custom Sync Server
• Firefox Configuration
• Updating the Sync Server
• Troubleshooting
• Support
• Other Documentation
• Alternate Installation
  • Installation with mod_fcgid
• References (MySQL table details)

portinstall devel/py-virtualenv
portinstall devel/mercurial
portinstall devel/gmake           # GNU make, may already be installed
portinstall www/mod_wsgi3

mkdir -p /opt/mozilla
cd /opt/mozilla
hg clone https://hg.mozilla.org/services/server-full server-full
# the above command does the checkout from the Mozilla repository,
# the last option (server-full) is only needed if you would like
# to have it in a different sub directory
cd server-full
gmake build			# on Linux system use 'make' instead of 'gmake'
bin/easy_install Mysql-Python	# to be able to use the MySQL backend

adduser -D			# -D = Do not attempt to create the home directory.
Username: mozsync
Full name: Mozilla SyncServer
Uid [1001]: 10xx		# adjust to your environment or use the recommendation
Login group [mozsync]: 
Login group is mozsync. Invite mozsync into other groups? []: 
Login class [default]: 
Shell (sh csh tcsh bash ftponly bash rbash nologin) [bash]: nologin
Home directory [/home/mozsync]: /opt/mozilla/server-full
Home directory permissions (Leave empty for default): 
Use password-based authentication? [yes]: no
Lock out the account after creation? [no]: yes
Username   : mozsync
Password   : <disabled>
Full Name  : Mozilla SyncServer
Uid        : 10xx
Class      : 
Groups     : mozsync 
Home       : /opt/mozilla/server-full
Home Mode  : 
Shell      : /usr/sbin/nologin
Locked     : no
OK? (yes/no): yes
adduser: INFO: Successfully added (mozsync) to the user database.
adduser: INFO: Account (mozsync) is locked.
Add another user? (yes/no): no
Goodbye!

cp -p etc/sync.conf etc/mozilla-sync.conf
cp -p development.ini production.ini
cp -p sync.wsgi mozilla-sync.wsgi
$EDITOR etc/mozilla-sync.conf

-use_ssl = false
+use_ssl = true

 [storage]
 backend = syncstorage.storage.sql.SQLStorage
-sqluri = sqlite:////tmp/test.db
+sqluri = mysql://mozsync:<password>@localhost:3306/mozilla_sync
 standard_collections = false
 use_quota = true
-quota_size = 5120
+quota_size = 10240
-pool_size = 100
+pool_size = 20    # reduced, because MySQL max_connections is set to 100 (default)

 [auth]
 backend = services.user.sql.SQLUser
-sqluri = sqlite:////tmp/test.db
+sqluri = mysql://mozsync:<password>@localhost:3306/mozilla_sync
-pool_size = 100
+pool_size = 20    # reduced, because MySQL max_connections is set to 100 (default)
 pool_recycle = 3600
 create_tables = true
+
+[reset_codes]
+backend = services.resetcodes.rc_sql.ResetCodeSQL
+sqluri = mysql://mozsync:<password>@localhost:3306/mozilla_sync
+create_tables = true
  
 [nodes]
-fallback_node = http://localhost:5000/
+fallback_node = https://mozilla-sync.example.com/

 [smtp]
 host = localhost
 port = 25
-sender = weave@mozilla.com
+sender = mozilla-sync@example.com

chmod 640 etc/mozilla-sync.conf
chgrp mozsync etc/mozilla-sync.conf
$EDITOR production.ini

 [DEFAULT]
-debug = True
+debug = False

 [app:main]
 use = egg:SyncServer
-configuration = file:%(here)s/etc/sync.conf
+configuration = file:%(here)s/etc/mozilla-sync.conf

 [handler_syncserver_errors]
 class = handlers.RotatingFileHandler
-args = ('/tmp/sync-error.log',)
+args = ('/opt/mozilla/server-full/tmp/sync-error.log',)

 # setting up the egg cache to a place where apache can write
-os.environ['PYTHON_EGG_CACHE'] = '/tmp/python-eggs'
+os.environ['PYTHON_EGG_CACHE'] = '/opt/mozilla/server-full/tmp/python-eggs'
 
 # setting up logging
-ini_file = os.path.join(_CURDIR, 'development.ini')
+ini_file = os.path.join(_CURDIR, 'production.ini')

mkdir tmp
chown mozsync:mozsync tmp
chmod 750 tmp
chgrp mozsync deps/server-reg/syncreg/templates
chmod 775 deps/server-reg/syncreg/templates
chgrp mozsync syncserver/templates
chmod 775 syncserver/templates

# http://mozilla-sync.example.com/
<VirtualHost *:80>
ServerName mozilla-sync.example.com
ServerAdmin webmaster@example.com
Redirect permanent / https://mozilla-sync.example.com/
ErrorLog /usr/local/www/mozilla-sync.example.com/logs/error.log
CustomLog /usr/local/www/mozilla-sync.example.com/logs/access.log combined
</VirtualHost>

apachectl configtest    # (Linux: 'apache2ctl configtest') should return "Syntax OK"
/usr/local/etc/rc.d/apache22 restart    # (Linux: '/etc/init.d/apache2 restart')

mozilla-sync	IN CNAME	<servername>.example.com.

mozilla-sync	IN A	<IP-address>
mozilla-sync	IN AAAA	<IPv6-address>	# if you also have IPv6

rndc reload

mozsync

/etc/rc.d/sendmail restart

• https://mozilla-sync.example.com/
  This should give you the message 404 Not Found - The resource could not be found.
• https://mozilla-sync.example.com/__heartbeat__
  This will show an empty page, even if you look at the source code, it is empty. This is a special URL which could be used in monitoring to check if the sync server is properly working. It returns code 200 when running and error code 503 when something failed
• https://mozilla-sync.example.com/weave-password-reset
  This is the URL which is used to reset the password and should display a nice web page where you can enter your username (e-mail address) and then request a reset key. I do not know if this web page already will be displayed at this point, as the database is still empty.
• https://mozilla-sync.example.com/weave-delete-account
  This is the URL which is used to permanently delete an account and should display a nice web page where you can enter your username (e-mail address) and password to delete an existing account. I do not know if this web page already will be displayed at this point, as the database is still empty.

cd /opt/mozilla
cp -pr server-full server-full-`date +%Y.%m.%d-%H%M`	# backup the folder
cd /opt/mozilla/server-full
hg pull -uv			# this will update the local repository

virtualenv --no-site-packages --distribute .
gmake update                    # on Linux system use 'make' instead of 'gmake'

gmake build                     # on Linux system use 'make' instead of 'gmake'

apachectl graceful              # (Linux: 'apache2ctl graceful')

cd /opt/mozilla
mv server-full server-full-`date +%Y.%m.%d-%H%M`-broken     # rename the broken folder
cp -pr server-full-2012.05.25-1608 server-full	     # use the right folder as source!
apachectl graceful    				     # (Linux: 'apache2ctl graceful')

gmake build CHANNEL=dev         # on Linux system use 'make' instead of 'gmake'

apachectl graceful              # (Linux: 'apache2ctl graceful')

Sync Server

 [DEFAULT]
-debug = False
+debug = True

apachectl graceful    # (Linux: 'apache2ctl graceful')

MySQL Server

mysql -u root -p
mysql> use mozilla_sync
mysql> show tables;
+------------------------+
| Tables_in_mozilla_sync |
+------------------------+
| collections            |
| reset_codes            |
| user                   |
| users                  |
| wbo                    |
+------------------------+
5 rows in set (0.00 sec)

mysql> select * from user \G
*************************** 1. row ***************************
       userid: 1
     username: <random-characters-and-numbers>
     password: {SSHA-256}<random-characters-and-numbers-but-a-little-bit-longer>==
accountStatus: 1
         mail: user@example.com
 mailVerified: 0
     syncNode: NULL
1 row in set (0.00 sec)

mysql> select * from collections;
+--------+--------------+-----------+
| userid | collectionid | name      |
+--------+--------------+-----------+
|      1 |            0 | meta      | 
|      1 |            1 | crypto    | 
|      1 |            2 | clients   | 
|      1 |            3 | bookmarks | 
|      1 |            4 | forms     | 
|      1 |            5 | history   | 
|      1 |            6 | passwords | 
|      1 |            7 | prefs     | 
|      1 |            8 | tabs      | 
+--------+--------------+-----------+
9 rows in set (0.00 sec)

mysql> select count(*) from wbo;
+----------+
| count(*) |
+----------+
|     6345 | 
+----------+
1 row in set (0.02 sec)

mysql> exit

• Mozilla Services Documentation
• Run your own Sync Server (Mozilla Services)
• Firefox Sync (Mozilla Developer Network)
• Building Mozilla Sync Server RPMs (March 2012, Jethro Carr)
• Setting up a local Firefox Sync server (Dec 2011, Dave Koelmeyer)
• Set up Firefox Sync to connect to a PostgreSQL database (Dec 2011, Dave Koelmeyer)

• Installation with mod_fcgid

portinstall www/mod_fcgid

bin/easy_install flup

cp -p sync.wsgi mozilla-sync.fcgi

+#!/opt/mozilla/server-full/bin/python
 # -*- coding: utf8 -*-
 # ***** BEGIN LICENSE BLOCK *****

 # setting up the egg cache to a place where apache can write
-os.environ['PYTHON_EGG_CACHE'] = '/tmp/python-eggs'
+os.environ['PYTHON_EGG_CACHE'] = '/opt/mozilla/server-full/tmp/python-eggs'
 
 # setting up logging
-ini_file = os.path.join(_CURDIR, 'development.ini')
+ini_file = os.path.join(_CURDIR, 'production.ini')

 # running the app using Paste
 from paste.deploy import loadapp
 application = loadapp('config:%s'% ini_file)
+
+if __name__ == '__main__':
+    from flup.server.fcgi import WSGIServer
+    WSGIServer(application).run()

chmod a+x mozilla-sync.fcgi

# http://mozilla-sync.example.com/
<VirtualHost *:80>
ServerName mozilla-sync.example.com
ServerAdmin webmaster@example.com
Redirect permanent / https://mozilla-sync.example.com/
ErrorLog /usr/local/www/mozilla-sync.example.com/logs/error.log
CustomLog /usr/local/www/mozilla-sync.example.com/logs/access.log combined
</VirtualHost>

# https://mozilla-sync.example.com/
<VirtualHost *:443>
Servername mozilla-sync.example.com
ServerAdmin webmaster@example.com
DocumentRoot /opt/mozilla/server-full

AddHandler fcgid-script .fcgi
#caution! if you don't pass header it won't be able to auth:
FcgidPassHeader Authorization
RewriteEngine On
RewriteRule ^(.*)$ /opt/mozilla/server-full/server-full/mozilla-sync.fcgi/$1

ErrorLog /usr/local/www/mozilla-sync.example.com/logs/error-https.log
CustomLog /usr/local/www/mozilla-sync.example.com/logs/access-https.log combined
CustomLog /usr/local/www/mozilla-sync.example.com/logs/ssl_request.log \
	"%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"SSLEngine on
SSLProtocol -ALL +SSLv3 +TLSv1
SSLHonorCipherOrder On
SSLCipherSuite ECDHE-RSA-AES128-SHA256:AES128-GCM-SHA256:HIGH:!RC4:!MD5:!aNULL:!EDH
SSLCertificateFile /usr/local/etc/apache22/ssl.crt/wildcard.example.com.crt
SSLCertificateKeyFile /usr/local/etc/apache22/ssl.key/wildcard.example.com.key
SSLCertificateChainFile /usr/local/etc/apache22/ssl.crt/intermediate_and_root_CA.crt

<Directory /opt/mozilla/server-full>
 Options +ExecCGI
 AllowOverride all
 Order allow,deny
 Allow from all
</Directory>

mysql -u root -p
mysql> use mozilla_sync
mysql> show tables;
+------------------------+
| Tables_in_mozilla_sync |
+------------------------+
| collections            |
| reset_codes            |
| user                   |
| users                  |
| wbo                    |
+------------------------+
5 rows in set (0.00 sec)

mysql> 

mysql> show create table collections\G
*************************** 1. row ***************************
       Table: collections
Create Table: CREATE TABLE `collections` (
  `userid` int(11) NOT NULL auto_increment,
  `collectionid` int(11) NOT NULL,
  `name` varchar(32) NOT NULL,
  PRIMARY KEY  (`userid`,`collectionid`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=latin1
1 row in set (0.01 sec)

mysql> describe collections;
+--------------+-------------+------+-----+---------+----------------+
| Field        | Type        | Null | Key | Default | Extra          |
+--------------+-------------+------+-----+---------+----------------+
| userid       | int(11)     | NO   | PRI | NULL    | auto_increment | 
| collectionid | int(11)     | NO   | PRI | NULL    |                | 
| name         | varchar(32) | NO   |     | NULL    |                | 
+--------------+-------------+------+-----+---------+----------------+
3 rows in set (0.01 sec)

mysql> 

mysql> show create table reset_codes\G
*************************** 1. row ***************************
       Table: reset_codes
Create Table: CREATE TABLE `reset_codes` (
  `username` varchar(32) NOT NULL,
  `product` varchar(32) NOT NULL,
  `reset` varchar(32) default NULL,
  `expiration` datetime default NULL,
  PRIMARY KEY  (`username`,`product`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1
1 row in set (0.00 sec)

mysql> describe reset_codes;
+------------+-------------+------+-----+---------+-------+
| Field      | Type        | Null | Key | Default | Extra |
+------------+-------------+------+-----+---------+-------+
| username   | varchar(32) | NO   | PRI | NULL    |       | 
| product    | varchar(32) | NO   | PRI | NULL    |       | 
| reset      | varchar(32) | YES  |     | NULL    |       | 
| expiration | datetime    | YES  |     | NULL    |       | 
+------------+-------------+------+-----+---------+-------+
4 rows in set (0.00 sec)

mysql> 

mysql> show create table user\G
*************************** 1. row ***************************
       Table: user
Create Table: CREATE TABLE `user` (
  `userid` int(11) NOT NULL auto_increment,
  `username` varchar(32) NOT NULL,
  `password` varchar(128) default NULL,
  `accountStatus` int(11) default NULL,
  `mail` varchar(64) default NULL,
  `mailVerified` int(11) default NULL,
  `syncNode` varchar(64) default NULL,
  PRIMARY KEY  (`userid`),
  UNIQUE KEY `username` (`username`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=latin1
1 row in set (0.00 sec)

mysql> describe user;
+---------------+--------------+------+-----+---------+----------------+
| Field         | Type         | Null | Key | Default | Extra          |
+---------------+--------------+------+-----+---------+----------------+
| userid        | int(11)      | NO   | PRI | NULL    | auto_increment | 
| username      | varchar(32)  | NO   | UNI | NULL    |                | 
| password      | varchar(128) | YES  |     | NULL    |                | 
| accountStatus | int(11)      | YES  |     | NULL    |                | 
| mail          | varchar(64)  | YES  |     | NULL    |                | 
| mailVerified  | int(11)      | YES  |     | NULL    |                | 
| syncNode      | varchar(64)  | YES  |     | NULL    |                | 
+---------------+--------------+------+-----+---------+----------------+
7 rows in set (0.01 sec)

mysql> 

mysql> show create table users\G
*************************** 1. row ***************************
       Table: users
Create Table: CREATE TABLE `users` (
  `id` int(11) NOT NULL auto_increment,
  `username` varchar(32) default NULL,
  `password_hash` varchar(128) default NULL,
  `email` varchar(64) default NULL,
  `status` int(11) default NULL,
  `alert` text,
  `reset` varchar(32) default NULL,
  `reset_expiration` datetime default NULL,
  PRIMARY KEY  (`id`),
  UNIQUE KEY `username` (`username`,`password_hash`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1
1 row in set (0.00 sec)

mysql> describe users;
+------------------+--------------+------+-----+---------+----------------+
| Field            | Type         | Null | Key | Default | Extra          |
+------------------+--------------+------+-----+---------+----------------+
| id               | int(11)      | NO   | PRI | NULL    | auto_increment | 
| username         | varchar(32)  | YES  | MUL | NULL    |                | 
| password_hash    | varchar(128) | YES  |     | NULL    |                | 
| email            | varchar(64)  | YES  |     | NULL    |                | 
| status           | int(11)      | YES  |     | NULL    |                | 
| alert            | text         | YES  |     | NULL    |                | 
| reset            | varchar(32)  | YES  |     | NULL    |                | 
| reset_expiration | datetime     | YES  |     | NULL    |                | 
+------------------+--------------+------+-----+---------+----------------+
8 rows in set (0.00 sec)

mysql> 

mysql> show create table wbo\G
*************************** 1. row ***************************
       Table: wbo
Create Table: CREATE TABLE `wbo` (
  `id` varchar(64) NOT NULL,
  `username` int(11) NOT NULL auto_increment,
  `collection` int(11) NOT NULL,
  `parentid` varchar(64) default NULL,
  `predecessorid` varchar(64) default NULL,
  `sortindex` int(11) default NULL,
  `modified` bigint(20) default NULL,
  `payload` text,
  `payload_size` int(11) NOT NULL,
  `ttl` int(11) default NULL,
  PRIMARY KEY  (`id`,`username`,`collection`),
  KEY `idx_autoinc_username` (`username`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=latin1
1 row in set (0.01 sec)

mysql> describe wbo;
+---------------+-------------+------+-----+---------+----------------+
| Field         | Type        | Null | Key | Default | Extra          |
+---------------+-------------+------+-----+---------+----------------+
| id            | varchar(64) | NO   | PRI | NULL    |                | 
| username      | int(11)     | NO   | PRI | NULL    | auto_increment | 
| collection    | int(11)     | NO   | PRI | NULL    |                | 
| parentid      | varchar(64) | YES  |     | NULL    |                | 
| predecessorid | varchar(64) | YES  |     | NULL    |                | 
| sortindex     | int(11)     | YES  |     | NULL    |                | 
| modified      | bigint(20)  | YES  |     | NULL    |                | 
| payload       | text        | YES  |     | NULL    |                | 
| payload_size  | int(11)     | NO   |     | NULL    |                | 
| ttl           | int(11)     | YES  |     | NULL    |                | 
+---------------+-------------+------+-----+---------+----------------+
10 rows in set (0.01 sec)

mysql> 

Document History