Skip to content

Commit a975ab0

Browse files
committed
nixos/doc: explain how to use the ff sync module with ff android
source https://mozilla-services.readthedocs.io/en/latest/howtos/run-sync-1.5.html#howto-run-sync15 Quotation: ``` Firefox for Android (“Daylight”, versions 79 and later) does support using a non-Mozilla-hosted Sync server. Before logging in, go to App Menu > Settings > About Firefox and click the logo 5 times. You should see a “debug menu enabled” notification. Go back to the main menu and you will see two options for a custom account server and a custom Sync server. Set the Sync server to the URL given above and then log in. To configure Android Firefox 44 up to 78 to talk to your new Sync server, just set the “identity.sync.tokenserver.uri” exactly as above before signing in to Mozilla accounts and Sync on your Android device. Important: after creating the Android account, changes to “identity.sync.tokenserver.uri” will be ignored. (If you need to change the URI, delete the Android account using the Settings > Sync > Disconnect… menu item, update the pref, and sign in again.) Non-default TokenServer URLs are displayed in the Settings > Sync panel in Firefox for Android, so you should be able to verify your URL there. ``` the /token/ prefix is experimentally wrong.
1 parent 910796c commit a975ab0

File tree

2 files changed

+33
-4
lines changed

2 files changed

+33
-4
lines changed

nixos/doc/manual/redirects.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,15 @@
5050
"module-services-crab-hole-upstream-options": [
5151
"index.html#module-services-crab-hole-upstream-options"
5252
],
53+
"module-services-firefox-syncserver-clients": [
54+
"index.html#module-services-firefox-syncserver-clients"
55+
],
56+
"module-services-firefox-syncserver-clients-android": [
57+
"index.html#module-services-firefox-syncserver-clients-android"
58+
],
59+
"module-services-firefox-syncserver-clients-desktop": [
60+
"index.html#module-services-firefox-syncserver-clients-desktop"
61+
],
5362
"module-services-opencloud": [
5463
"index.html#module-services-opencloud"
5564
],

nixos/modules/services/networking/firefox-syncserver.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,8 @@ The absolute minimal configuration for the sync server looks like this:
2424
}
2525
```
2626

27-
This will start a sync server that is only accessible locally. Once the services is
28-
running you can navigate to `about:config` in your Firefox profile and set
29-
`identity.sync.tokenserver.uri` to `http://localhost:5000/1.0/sync/1.5`. Your browser
30-
will now use your local sync server for data storage.
27+
This will start a sync server that is only accessible locally on the following url: `http://localhost:5000/1.0/sync/1.5`.
28+
See [the dedicated section](#module-services-firefox-syncserver-clients) to configure your browser to use this sync server.
3129

3230
::: {.warning}
3331
This configuration should never be used in production. It is not encrypted and
@@ -55,3 +53,25 @@ be made via TLS.
5553

5654
For actual deployment it is also recommended to store the `secrets` file in a
5755
secure location.
56+
57+
## Configuring clients to use this server {#module-services-firefox-syncserver-clients}
58+
59+
### Firefox desktop {#module-services-firefox-syncserver-clients-desktop}
60+
To configure a desktop version of Firefox to use your server, navigate to
61+
`about:config` in your Firefox profile and set
62+
`identity.sync.tokenserver.uri` to `https://myhostname:5000/1.0/sync/1.5`.
63+
64+
### Firefox Android {#module-services-firefox-syncserver-clients-android}
65+
To configure an Android version of Firefox to use your server:
66+
* First ensure that you are disconnected from you Mozilla account.
67+
* Go to App Menu > Settings > About Firefox and click the logo 5 times. You
68+
should see a “debug menu enabled” notification.
69+
* Back to the main menu, a new menu "sync debug" should have appeared.
70+
* In this menu, set "custom sync server" to `https://myhostname:5000/1.0/sync/1.5`.
71+
72+
::: {.warning}
73+
Changes to this configuration value are ignored if you are currently connected to your account.
74+
:::
75+
76+
* Restart the application.
77+
* Log in to your account.

0 commit comments

Comments
 (0)