chiark / gitweb /
Revert "all: add NDK r12b and set it as default"
[fdroidserver.git] / examples / config.py
index f1c6f7b94dc0b672041a83c890d8c98005b45259..97628e7e0ad8f97d394c75ac1dae9262d667716b 100644 (file)
@@ -1,40 +1,52 @@
-#!/usr/bin/env python2
+#!/usr/bin/env python3
 
 # Copy this file to config.py, then amend the settings below according to
 # your system configuration.
 
-# Override the path to the Android SDK, $ANDROID_HOME by default
-# sdk_path = "/path/to/android-sdk"
+# Custom path to the Android SDK, defaults to $ANDROID_HOME
+# 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
+# used by default. If a version is missing or assigned to None, it is assumed
+# not installed.
+# ndk_paths = {
+#     'r9b': None,
+#     'r10e': "$ANDROID_NDK",
+# }
+
+# java_paths = {
+#     '1.8': "/usr/lib/jvm/java-8-openjdk",
+# }
 
-# Override the path to the Android NDK, $ANDROID_NDK by default
-# ndk_path = "/path/to/android-ndk"
 # Build tools version to be used
-# build_tools = "21.1.2"
+# build_tools = "24.0.0"
 
-# Command for running Ant
-# ant = "/path/to/ant"
-ant = "ant"
+# Force all build to use the above version of build -tools, good for testing
+# builds without having all of the possible build-tools installed.
+# force_build_tools = True
 
-# Command for running maven 3
-# mvn3 = "/path/to/mvn"
-mvn3 = "mvn"
+# Command or path to binary for running Ant
+# ant = "ant"
 
-# Command for running Gradle
-# gradle = "/path/to/gradle"
-gradle = "gradle"
+# Command or path to binary for running maven 3
+# mvn3 = "mvn"
+
+# Command or path to binary for running 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 FDroid Repo Demo"
+repo_name = "My First F-Droid Repo Demo"
 repo_icon = "fdroid-icon.png"
 repo_description = """
-This is a repository of apps to be used with FDroid. Applications in this
+This is a repository of apps to be used with F-Droid. Applications in this
 repository are either official binaries built by the original application
 developers, or are binaries built from source by the admin of f-droid.org
 using the tools on https://gitlab.com/u/fdroid.
@@ -46,35 +58,51 @@ using the tools on https://gitlab.com/u/fdroid.
 # repository, and no need to define the other archive_ values.
 archive_older = 3
 archive_url = "https://f-droid.org/archive"
-archive_name = "My First FDroid Archive Demo"
+archive_name = "My First F-Droid Archive Demo"
 archive_icon = "fdroid-icon.png"
 archive_description = """
 The repository of older versions of applications from the main demo repository.
 """
 
+# Normally, all apps are collected into a single app repository, like on
+# https://f-droid.org. For certain situations, it is better to make a repo
+# that is made up of APKs only from a single app. For example, an automated
+# build server that publishes nightly builds.
+# per_app_repos = True
+
 # `fdroid update` will create a link to the current version of a given app.
-# This provides a static path to the current APK.  To disable the creation of
+# This provides a static path to the current APK. To disable the creation of
 # this link, uncomment this:
 # make_current_version_link = False
 
 # By default, the "current version" link will be based on the "Name" of the
-# app from the metadata.  You can change it to use a different field from the
+# app from the metadata. You can change it to use a different field from the
 # metadata here:
 # current_version_name_source = 'id'
 
+# Optionally, override home directory for gpg
+# gpghome = /home/fdroid/somewhere/else/.gnupg
+
 # The ID of a GPG key for making detached signatures for apks. Optional.
 # gpgkey = '1DBA2E89'
 
 # The key (from the keystore defined below) to be used for signing the
-# repository itself.  This is the same name you would give to keytool or
-# jarsigner using -alias.  (Not needed in an unsigned repository).
+# repository itself. This is the same name you would give to keytool or
+# jarsigner using -alias. (Not needed in an unsigned repository).
 # repo_keyalias = "fdroidrepo"
 
+# Optionally, the public key for the key defined by repo_keyalias above can
+# be specified here. There is no need to do this, as the public key can and
+# will be retrieved from the keystore when needed. However, specifying it
+# manually can allow some processing to take place without access to the
+# keystore.
+# repo_pubkey = "..."
+
 # The keystore to use for release keys when building. This needs to be
 # somewhere safe and secure, and backed up!  The best way to manage these
 # sensitive keys is to use a "smartcard" (aka Hardware Security Module). To
-# configure FDroid to use a smartcard, set the keystore file using the keyword
-# "NONE" (i.e. keystore = "NONE").  That makes Java find the keystore on the
+# configure F-Droid to use a smartcard, set the keystore file using the keyword
+# "NONE" (i.e. keystore = "NONE"). That makes Java find the keystore on the
 # smartcard based on 'smartcardoptions' below.
 # keystore = "~/.local/share/fdroidserver/keystore.jks"
 
@@ -84,34 +112,34 @@ The repository of older versions of applications from the main demo repository.
 #    -providerClass sun.security.pkcs11.SunPKCS11 \
 #    -providerArg opensc-fdroid.cfg"
 
-# The password for the keystore (at least 6 characters).  If this password is
+# The password for the keystore (at least 6 characters). If this password is
 # different than the keypass below, it can be OK to store the password in this
-# file for real use.  But in general, sensitive passwords should not be stored
+# file for real use. But in general, sensitive passwords should not be stored
 # in text files!
 # keystorepass = "password1"
 
 # The password for keys - the same is used for each auto-generated key as well
-# as for the repository key.  You should not normally store this password in a
+# as for the repository key. You should not normally store this password in a
 # file since it is a sensitive password.
 # 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
+# The full path to the root of the repository. It must be specified in
 # rsync/ssh format for a remote host/path. This is used for syncing a locally
-# generated repo to the server that is it hosted on.  It must end in the
+# generated repo to the server that is it hosted on. It must end in the
 # standard public repo name of "/fdroid", but can be in up to three levels of
-# sub-directories (i.e. /var/www/packagerepos/fdroid).  You can include
+# sub-directories (i.e. /var/www/packagerepos/fdroid). You can include
 # multiple servers to sync to by wrapping the whole thing in {} or [], and
 # including the serverwebroot strings in a comma-separated list.
 #
@@ -121,6 +149,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
 #
@@ -129,9 +169,9 @@ keyaliases['com.example.another.plugin'] = '@com.example.another'
 
 # If you are running the repo signing process on a completely offline machine,
 # which provides the best security, then you can specify a folder to sync the
-# repo to when running `fdroid server update`.  This is most likely going to
-# be a USB thumb drive, SD Card, or some other kind of removable media.  Make
-# sure it is mounted before running `fdroid server update`.  Using the
+# repo to when running `fdroid server update`. This is most likely going to
+# be a USB thumb drive, SD Card, or some other kind of removable media. Make
+# sure it is mounted before running `fdroid server update`. Using the
 # standard folder called 'fdroid' as the specified folder is recommended, like
 # with serverwebroot.
 #
@@ -140,7 +180,7 @@ keyaliases['com.example.another.plugin'] = '@com.example.another'
 
 # If you are using local_copy_dir on an offline build/signing server, once the
 # thumb drive has been plugged into the online machine, it will need to be
-# synced to the copy on the online machine.  To make that happen
+# synced to the copy on the online machine. To make that happen
 # automatically, set sync_from_local_copy_dir to True:
 #
 # sync_from_local_copy_dir = True
@@ -162,40 +202,45 @@ 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 .yml and the custom .txt metadata formats. It
+# is also possible to have metadata in JSON and XML by adding 'json' and
+# 'xml'.
+# accepted_formats = ['txt', 'yml']
 
 # Limit in number of characters that fields can take up
 # Only the fields listed here are supported, defaults shown
-char_limits = {
-    'Summary': 50,
-    'Description': 1500
-}
+char_limits = {
+#     'Summary': 80,
+#     'Description': 4000,
+}