mirrors/syncstorage-rs
1
0
Fork 0
mirror of https://github.com/mozilla-services/syncstorage-rs.git synced 2026-05-05 20:26:26 +02:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Merge pull request #374 from mozilla-services/docs/examples-for-local-dev

Browse Source 
docs: add instructions on how to connect to local firefox
This commit is contained in:
Rachel Tublitz 2019-12-16 12:52:53 -05:00 committed by GitHub
commit 0bc4e7ac1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -7,6 +7,7 @@
- [Local Setup](#local-setup)
- [MySQL](#mysql)
- [Spanner](#spanner)
- [Connecting to Firefox](#connecting-to-firefox)
- [Logging](#logging)
- [Tests](#tests)
- [Unit tests](#unit-tests)
@ -97,6 +98,35 @@ RUST_LOG=warn GOOGLE_APPLICATION_CREDENTIALS=`pwd`/keys/sync-spanner.json` cargo
Note, that unlike MySQL, there is no automatic migrations facility. Currently Spanner schema must be hand edited and modified.
### Connecting to Firefox
This will walk you through the steps to connect this project to your local copy of Firefox.
1. Follow the steps outlined above for running this project using [MySQL](https://github.com/mozilla-services/syncstorage-rs#mysql).
2. Setup a local copy of [syncserver](https://github.com/mozilla-services/syncserver), with a few special changes to [syncserver.ini](https://github.com/mozilla-services/syncserver/blob/master/syncserver.ini); make sure that you're using the following values (in addition to all of the other defaults):
```
[server:main]
port = 5000
[syncserver]
public_url = http://localhost:5000/
# This value needs to match your "master_secret" for syncstorage-rs!
secret = INSERT_SECRET_KEY_HERE
[tokenserver]
node_url = http://localhost:8000
sqluri = pymysql://sample_user:sample_password@127.0.0.1/syncstorage_rs
[endpoints]
sync-1.5 = "http://localhost:8000/1.5/1"```
3. In Firefox, go to `about:config`. Change `identity.sync.tokenserver.uri` to `http://localhost:5000/token/1.0/sync/1.5`.
4. Restart Firefox. Now, try syncing. You should see new BSOs in your local MySQL instance.
## Logging
- If you want to connect to the existing [Sentry project](https://sentry.prod.mozaws.net/operations/syncstorage-dev/) for local development, login to Sentry, and go to the page with [api keys](https://sentry.prod.mozaws.net/settings/operations/syncstorage-dev/keys/). Copy the `DSN` value, and `export SENTRY_DSN=DSN_VALUE_GOES_HERE` to the environment when running this project.