993527 - [meta] Documentation issues for DIY FxA and SyncServer

Status: RESOLVED WONTFIX

(Cloud Services Graveyard :: Server: Sync, defect)

Description

[James Bonacci [:jbonacci]]

1. We should give more details on the Python version pre-req for this.
For example, most current/recent rhel flavors still do system installs of Python 2.6.6 (or 2.6.x) by default. Only ubuntu flavors and custom linux installs normally use 2.7.x.
If we are compatible with 2.6.6 and newer, we should say so.
If we are not compatible with 3.x, we should say so.


REFs:
https://github.com/mozilla-services/syncserver
https://docs.services.mozilla.com/howtos/run-sync-1.5.html

Comment 1

[James Bonacci [:jbonacci]]

2. Also let's add an rhel example to this:
For example, under a fresh Ubuntu, you can run this command to meet all requirements:
$ sudo apt-get install python-dev git-core python-virtualenv

It's easy enough to add a line like this:
$ sudo yum install python-devel git virtualenv

Comment 2

[Ryan Kelly [:rfkelly]]

To get `make build` to work on OSX I had to:

  * install the command-line dev tools (which fortunately OSX does automatically if you type e.g. `git` in the terminal)
  * install pip and virtualenv by hand
  * `export CFLAGS=-Qunused-arguments` to get greenlet to compile properly

With that I get a clean `make build` and `make test` run.

Comment 3

[James Bonacci [:jbonacci]]

4. Add information about the use of the server-syncstorage repo and the tokenserver repo.

5. Add information about running your Verifier

Comment 4

[James Bonacci [:jbonacci]]

6. Make the tokenserver-specific message from "make test" more meaningful:
"# Testcases from tokenserver app; broken due to incorrect file paths"

Comment 5

[James Bonacci [:jbonacci]]

7. Update the following line "By default the server will use an in-memory database for storage, meaning that any sync data will be lost on server restart. " to include the absolute path to the local sqlite db file.

Comment 6

[James Bonacci [:jbonacci]]

8. Correct the following line "Open “etc/sync.conf” and locate the following lines:"
It should say the following:
"Open "syncserver.ini" and locate the following lines:"

Comment 7

[James Bonacci [:jbonacci]]

TBD - some very excellent feedback and debug in #sync for 4/29/2014...

Comment 8

[Ryan Kelly [:rfkelly]]

Need to document how to deal with URL prefix stripping, pending outcome of https://github.com/mozilla-services/syncserver/issues/18

Comment 9

[Ryan Kelly [:rfkelly]]

<kiu> rfkelly: my feedback so far: works fine, i would add a warning to the user when disconnecting the sync as FF resets the token url to default even though i had specified a custom one.

Comment 10

[James Bonacci [:jbonacci]]

Yea, that's a painful one. I think we have a bug open already about this.
If I can't find it though, I will open a new bug so this gets addressed...

Comment 11

[Daniel Steinke]

(In reply to James Bonacci [:jbonacci] from comment #6)
> 8. Correct the following line "Open “etc/sync.conf” and locate the following
> lines:"
> It should say the following:
> "Open "syncserver.ini" and locate the following lines:"

Seconding this, had to confirm in IRC I wasn't missing etc/sync.conf somewhere.

Comment 12

[Ryan Kelly [:rfkelly]]

Add some notes about common errors, e.g. "audience_mismatch_error" usually means to check your public_url, and your nginx forwarding settings.

Comment 13

[Ryan Kelly [:rfkelly]]

document how to set the quota

Comment 14

[Ryan Kelly [:rfkelly]]

gunicorn may need to adjust the http://gunicorn-docs.readthedocs.org/en/latest/settings.html#forwarded-allow-ips setting for running over https

Comment 15

[Ryan Kelly [:rfkelly]]

mod_wsgi will give sporadic 401s unless you set a secret key, since it spawns multiple independent sub-processes that auto-generate independent keys by default.

Comment 16

[Ryan Kelly [:rfkelly]]

The FxA client code checks that your FxA server is running on https, and errors out if it is not.

Comment 17

[Ryan Kelly [:rfkelly]]

Explicitly instruct people to accept self-signed certs before thing to do anything, because otherwise you gets lots of mysterious and silent failures.

Comment 18

[Ryan Kelly [:rfkelly]]

Mention that you can use PyBrowserID for local assertion verification.

Comment 19

[Ryan Kelly [:rfkelly]]

nginx needs to accept headers > 2k in length:  https://github.com/mozilla-services/tokenserver/issues/69

Comment 20

[Ryan Kelly [:rfkelly]]

Make a note of the newly-added error message in https://github.com/mozilla-services/syncserver/pull/41, and include some tips for debugging common causes (e.g. gunicorn not forwarding the ssl state)

Comment 21

[Sylvestre Ledru [:Sylvestre]]

No assignee, updating the status.

Comment 22

[Sylvestre Ledru [:Sylvestre]]

No assignee, updating the status.

Comment 23

[Sylvestre Ledru [:Sylvestre]]

No assignee, updating the status.

Comment 24

[Sylvestre Ledru [:Sylvestre]]

No assignee, updating the status.

Comment 25

[David Durst [:ddurst]]

Will address this with the self-hosting work to come, but with the new architecture.