mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-11-11 18:23:18 +01:00
a975ab0752
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.
78 lines
3.2 KiB
Markdown
78 lines
3.2 KiB
Markdown
# Firefox Sync server {#module-services-firefox-syncserver}
|
|
|
|
A storage server for Firefox Sync that you can easily host yourself.
|
|
|
|
## Quickstart {#module-services-firefox-syncserver-quickstart}
|
|
|
|
The absolute minimal configuration for the sync server looks like this:
|
|
|
|
```nix
|
|
{
|
|
services.mysql.package = pkgs.mariadb;
|
|
|
|
services.firefox-syncserver = {
|
|
enable = true;
|
|
secrets = builtins.toFile "sync-secrets" ''
|
|
SYNC_MASTER_SECRET=this-secret-is-actually-leaked-to-/nix/store
|
|
'';
|
|
singleNode = {
|
|
enable = true;
|
|
hostname = "localhost";
|
|
url = "http://localhost:5000";
|
|
};
|
|
};
|
|
}
|
|
```
|
|
|
|
This will start a sync server that is only accessible locally on the following url: `http://localhost:5000/1.0/sync/1.5`.
|
|
See [the dedicated section](#module-services-firefox-syncserver-clients) to configure your browser to use this sync server.
|
|
|
|
::: {.warning}
|
|
This configuration should never be used in production. It is not encrypted and
|
|
stores its secrets in a world-readable location.
|
|
:::
|
|
|
|
## More detailed setup {#module-services-firefox-syncserver-configuration}
|
|
|
|
The `firefox-syncserver` service provides a number of options to make setting up
|
|
small deployment easier. These are grouped under the `singleNode` element of the
|
|
option tree and allow simple configuration of the most important parameters.
|
|
|
|
Single node setup is split into two kinds of options: those that affect the sync
|
|
server itself, and those that affect its surroundings. Options that affect the
|
|
sync server are `capacity`, which configures how many accounts may be active on
|
|
this instance, and `url`, which holds the URL under which the sync server can be
|
|
accessed. The `url` can be configured automatically when using nginx.
|
|
|
|
Options that affect the surroundings of the sync server are `enableNginx`,
|
|
`enableTLS` and `hostname`. If `enableNginx` is set the sync server module will
|
|
automatically add an nginx virtual host to the system using `hostname` as the
|
|
domain and set `url` accordingly. If `enableTLS` is set the module will also
|
|
enable ACME certificates on the new virtual host and force all connections to
|
|
be made via TLS.
|
|
|
|
For actual deployment it is also recommended to store the `secrets` file in a
|
|
secure location.
|
|
|
|
## Configuring clients to use this server {#module-services-firefox-syncserver-clients}
|
|
|
|
### Firefox desktop {#module-services-firefox-syncserver-clients-desktop}
|
|
To configure a desktop version of Firefox to use your server, navigate to
|
|
`about:config` in your Firefox profile and set
|
|
`identity.sync.tokenserver.uri` to `https://myhostname:5000/1.0/sync/1.5`.
|
|
|
|
### Firefox Android {#module-services-firefox-syncserver-clients-android}
|
|
To configure an Android version of Firefox to use your server:
|
|
* First ensure that you are disconnected from you Mozilla account.
|
|
* Go to App Menu > Settings > About Firefox and click the logo 5 times. You
|
|
should see a “debug menu enabled” notification.
|
|
* Back to the main menu, a new menu "sync debug" should have appeared.
|
|
* In this menu, set "custom sync server" to `https://myhostname:5000/1.0/sync/1.5`.
|
|
|
|
::: {.warning}
|
|
Changes to this configuration value are ignored if you are currently connected to your account.
|
|
:::
|
|
|
|
* Restart the application.
|
|
* Log in to your account.
|