diff options
author | Nicolas B. Pierron <nicolas.b.pierron@gmail.com> | 2015-01-18 12:21:23 +0100 |
---|---|---|
committer | Nicolas B. Pierron <nicolas.b.pierron@gmail.com> | 2015-01-18 12:21:23 +0100 |
commit | 8196727fad8a7eabf26313bd3175c1ee9e8cca43 (patch) | |
tree | 618f0867be45982b031f7135e0b7243e8af6d3ee /nixos/modules/services/networking/firefox/sync-server.nix | |
parent | 0d13ea0131cf43e7adccc437df4be8fa75ed9d3e (diff) | |
download | nixlib-8196727fad8a7eabf26313bd3175c1ee9e8cca43.tar nixlib-8196727fad8a7eabf26313bd3175c1ee9e8cca43.tar.gz nixlib-8196727fad8a7eabf26313bd3175c1ee9e8cca43.tar.bz2 nixlib-8196727fad8a7eabf26313bd3175c1ee9e8cca43.tar.lz nixlib-8196727fad8a7eabf26313bd3175c1ee9e8cca43.tar.xz nixlib-8196727fad8a7eabf26313bd3175c1ee9e8cca43.tar.zst nixlib-8196727fad8a7eabf26313bd3175c1ee9e8cca43.zip |
Improve the documentation of the syncserver module.
Diffstat (limited to 'nixos/modules/services/networking/firefox/sync-server.nix')
-rw-r--r-- | nixos/modules/services/networking/firefox/sync-server.nix | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/nixos/modules/services/networking/firefox/sync-server.nix b/nixos/modules/services/networking/firefox/sync-server.nix index 58b07e51387e..6ed7a6beb9e8 100644 --- a/nixos/modules/services/networking/firefox/sync-server.nix +++ b/nixos/modules/services/networking/firefox/sync-server.nix @@ -41,7 +41,8 @@ in replicate the following change <screen> - services.sync.tokenServerURI: http://localhost:5000/token/1.0/sync/1.5</screen> + services.sync.tokenServerURI: http://localhost:5000/token/1.0/sync/1.5 + </screen> where <option>http://localhost:5000/</option> corresponds to the public url of the server. @@ -95,7 +96,10 @@ in <option>mysql</option>, <option>oracle</option>, <option>postgresql</option>, etc., and <option>driver</option> the name of a DBAPI, such as <option>psycopg2</option>, <option>pyodbc</option>, <option>cx_oracle</option>, - etc. + etc. The <link + xlink:href="http://docs.sqlalchemy.org/en/rel_0_9/core/engines.html#database-urls"> + SQLAlchemy documentation</link> provides more examples and describe the syntax of + the expected URL. ''; }; @@ -103,12 +107,14 @@ in type = types.str; default = "/etc/firefox/syncserver-secret.ini"; description = '' - If defined, this file would be used to set all fields which were omitted in the - generated ini files used for configuring the syncserver. This file is useful - for storing secrets, such as the syncserver.secret or the syncserver.sqluri. - - If this file does not exists, it would be created with a unique secret. - ''; + The private config file is used to extend the generated config with confidential + information, such as the <option>syncserver.sqlUri</option> setting if it contains a + password, and the <option>syncserver.secret</option> setting is used by the server to + generate cryptographically-signed authentication tokens. + + If this file does not exists, then it is created with a generated + <option>syncserver.secret</option> settings. + ''; }; }; }; |