added 'mirrors' option to config for giving official mirror URLs

[fdroidserver.git] / examples / config.py

diff --git a/examples/config.py b/examples/config.py
index 339e99609267558fcf7157284772a93f3f49d164..54c326fe584736f3d0731f40dfc49e58222e5aa3 100644 (file)
--- a/examples/config.py
+++ b/examples/config.py
@@ -149,6 +149,18 @@ The repository of older versions of applications from the main demo repository.
 #     'bar.info:/var/www/fdroid',
 #     }
 
+# Any mirrors of this repo, for example all of the servers declared in
+# serverwebroot, will automatically be used by the client.  If one
+# mirror is not working, then the client will try another.  If the
+# client has Tor enabled, then the client will prefer mirrors with
+# .onion addresses. This base URL will be used for both the main repo
+# and the archive, if it is enabled.  So these URLs should end in the
+# 'fdroid' base of the F-Droid part of the web server like serverwebroot.
+#
+# mirrors = {
+#     'https://foo.bar/fdroid',
+#     'http://foobarfoobarfoobar.onion/fdroid',
+# }
 
 # optionally specific which identity file to use when using rsync over SSH
 #