Switch all headers to python3

[fdroidserver.git] / examples / config.py

diff --git a/examples/config.py b/examples/config.py
index cf8bf886639b96a45d23b61c4e1059f625a21f64..f022c2b0a76010aa5992eb0b1f444d2de671b888 100644 (file)
--- a/examples/config.py
+++ b/examples/config.py
@@ -1,10 +1,10 @@
-#!/usr/bin/env python2
+#!/usr/bin/env python3
 
 # Copy this file to config.py, then amend the settings below according to
 # your system configuration.
 
 # Custom path to the Android SDK, defaults to $ANDROID_HOME
-# sdk_path = "/opt/android-sdk"
+# sdk_path = "$ANDROID_HOME"
 
 # Custom paths to various versions of the Android NDK, defaults to 'r10e' set
 # to $ANDROID_NDK. Most users will have the latest at $ANDROID_NDK, which is
@@ -15,24 +15,31 @@
 #     'r10e': "$ANDROID_NDK",
 # }
 
+# If you want to build apps that use retrolambda and Java 1.8, you'll need to
+# have both 1.7 and 1.8 installed.
+# java_paths = {
+#     '1.7': "/usr/lib/jvm/java-7-openjdk",
+#     '1.8': None,
+# }
+
 # Build tools version to be used
-build_tools = "23.0.0"
+# build_tools = "23.0.2"
 
 # Command or path to binary for running Ant
-ant = "ant"
+# ant = "ant"
 
 # Command or path to binary for running maven 3
-mvn3 = "mvn"
+# mvn3 = "mvn"
 
 # Command or path to binary for running Gradle
-gradle = "gradle"
+# gradle = "gradle"
 
 # Set the maximum age (in days) of an index that a client should accept from
 # this repo. Setting it to 0 or not setting it at all disables this
 # functionality. If you do set this to a non-zero value, you need to ensure
 # that your index is updated much more frequently than the specified interval.
 # The same policy is applied to the archive repo, if there is one.
-repo_maxage = 0
+# repo_maxage = 0
 
 repo_url = "https://MyFirstFDroidRepo.org/fdroid/repo"
 repo_name = "My First F-Droid Repo Demo"
@@ -116,15 +123,15 @@ The repository of older versions of applications from the main demo repository.
 # keypass = "password2"
 
 # The distinguished name used for all keys.
-keydname = "CN=Birdman, OU=Cell, O=Alcatraz, L=Alcatraz, S=California, C=US"
+# keydname = "CN=Birdman, OU=Cell, O=Alcatraz, L=Alcatraz, S=California, C=US"
 
 # Use this to override the auto-generated key aliases with specific ones
 # for particular applications. Normally, just leave it empty.
-keyaliases = {}
-keyaliases['com.example.app'] = 'example'
+# keyaliases = {}
+# keyaliases['com.example.app'] = 'example'
 # You can also force an app to use the same key alias as another one, using
 # the @ prefix.
-keyaliases['com.example.another.plugin'] = '@com.example.another'
+# keyaliases['com.example.another.plugin'] = '@com.example.another'
 
 
 # The full path to the root of the repository. It must be specified in
@@ -141,6 +148,18 @@ keyaliases['com.example.another.plugin'] = '@com.example.another'
 #     '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
 #
@@ -182,36 +201,36 @@ keyaliases['com.example.another.plugin'] = '@com.example.another'
 # nonstandardwebroot = False
 
 
-# Wiki details
-wiki_protocol = "http"
-wiki_server = "server"
-wiki_path = "/wiki/"
-wiki_user = "login"
-wiki_password = "1234"
+# The build logs can be posted to a mediawiki instance, like on f-droid.org.
+# wiki_protocol = "http"
+# wiki_server = "server"
+# wiki_path = "/wiki/"
+# wiki_user = "login"
+# wiki_password = "1234"
 
 # Only set this to true when running a repository where you want to generate
 # stats, and only then on the master build servers, not a development
 # machine.
-update_stats = False
+# update_stats = True
 
 # When used with stats, this is a list of IP addresses that are ignored for
 # calculation purposes.
-stats_ignore = []
+# stats_ignore = []
 
 # Server stats logs are retrieved from. Required when update_stats is True.
-stats_server = "example.com"
+# stats_server = "example.com"
 
 # User stats logs are retrieved from. Required when update_stats is True.
-stats_user = "bob"
+# stats_user = "bob"
 
 # Use the following to push stats to a Carbon instance:
-stats_to_carbon = False
-carbon_host = '0.0.0.0'
-carbon_port = 2003
+# stats_to_carbon = False
+# carbon_host = '0.0.0.0'
+# carbon_port = 2003
 
 # Set this to true to always use a build server. This saves specifying the
 # --server option on dedicated secure build server hosts.
-build_server_always = False
+# build_server_always = True
 
 # By default, fdroid will use YAML and the custom .txt metadata formats. It
 # is also possible to have metadata in JSON and XML by adding 'json' and
@@ -220,7 +239,7 @@ build_server_always = False
 
 # Limit in number of characters that fields can take up
 # Only the fields listed here are supported, defaults shown
-char_limits = {
-    'Summary': 80,
-    'Description': 4000,
-}
+# char_limits = {
+#     'Summary': 80,
+#     'Description': 4000,
+# }