config.py 14 KB
Newer Older
Daniel Martí's avatar
Daniel Martí committed
1
#!/usr/bin/env python3
2

3 4
# Copy this file to config.py, then amend the settings below according to
# your system configuration.
Ciaran Gultnieks's avatar
Ciaran Gultnieks committed
5

6
# Custom path to the Android SDK, defaults to $ANDROID_HOME
Daniel Martí's avatar
Daniel Martí committed
7
# sdk_path = "$ANDROID_HOME"
8

Boris Kraut's avatar
Boris Kraut committed
9
# Custom paths to various versions of the Android NDK, defaults to 'r12b' set
10 11
# 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
12 13
# not installed.
# ndk_paths = {
Daniel Martí's avatar
Daniel Martí committed
14
#     'r10e': None,
Boris Kraut's avatar
Boris Kraut committed
15
#     'r11c': None,
Daniel Martí's avatar
Daniel Martí committed
16
#     'r12b': "$ANDROID_NDK",
est's avatar
est committed
17
#     'r13b': None,
18
#     'r14b': None,
19
#     'r15c': None,
20
#     'r16b': None,
21
#     'r17c': None,
Licaon_Kter's avatar
Licaon_Kter committed
22
#     'r18b': None,
23
#     'r19c': None,
Licaon_Kter's avatar
Licaon_Kter committed
24
#     'r20b': None,
TacoTheDank's avatar
TacoTheDank committed
25
#     'r21d': None,
26
# }
27

Marcus's avatar
Marcus committed
28 29 30 31
# Directory to store downloaded tools in (i.e. gradle versions)
# By default, these are stored in ~/.cache/fdroidserver
# cachedir = cache

32
# java_paths = {
Gio's avatar
Gio committed
33
#     '8': "/usr/lib/jvm/java-8-openjdk",
34 35
# }

36
# Build tools version to be used
37
# build_tools = "28.0.3"
38

39 40 41 42
# 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

43
# Command or path to binary for running Ant
44
# ant = "ant"
45

46
# Command or path to binary for running maven 3
47
# mvn3 = "mvn"
Daniel Martí's avatar
Daniel Martí committed
48

49
# Command or path to binary for running Gradle
Marcus's avatar
Marcus committed
50
# Defaults to using an internal gradle wrapper (gradlew-fdroid).
51
# gradle = "gradle"
52

53 54 55 56 57
# 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.
58
# repo_maxage = 0
59

60
repo_url = "https://MyFirstFDroidRepo.org/fdroid/repo"
61
repo_name = "My First F-Droid Repo Demo"
Ciaran Gultnieks's avatar
Ciaran Gultnieks committed
62
repo_icon = "fdroid-icon.png"
63
repo_description = """
64
This is a repository of apps to be used with F-Droid. Applications in this
65 66 67 68
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.
"""
Ciaran Gultnieks's avatar
Ciaran Gultnieks committed
69

70 71 72 73 74 75
# As above, but for the archive repo.
# archive_older sets the number of versions kept in the main repo, with all
# older ones going to the archive. Set it to 0, and there will be no archive
# repository, and no need to define the other archive_ values.
archive_older = 3
archive_url = "https://f-droid.org/archive"
76
archive_name = "My First F-Droid Archive Demo"
77
archive_icon = "fdroid-icon.png"
78 79 80
archive_description = """
The repository of older versions of applications from the main demo repository.
"""
81

82 83 84 85 86 87 88 89 90
# This allows a specific kind of insecure APK to be included in the
# 'repo' section.  Since April 2017, APK signatures that use MD5 are
# no longer considered valid, jarsigner and apksigner will return an
# error when verifying.  `fdroid update` will move APKs with these
# disabled signatures to the archive.  This option stops that
# behavior, and lets those APKs stay part of 'repo'.
#
# allow_disabled_algorithms = True

91
# Normally, all apps are collected into a single app repository, like on
92 93
# 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
94 95 96
# build server that publishes nightly builds.
# per_app_repos = True

97
# `fdroid update` will create a link to the current version of a given app.
98
# This provides a static path to the current APK. To disable the creation of
99 100 101 102
# this link, uncomment this:
# make_current_version_link = False

# By default, the "current version" link will be based on the "Name" of the
103
# app from the metadata. You can change it to use a different field from the
104
# metadata here:
105
# current_version_name_source = 'packageName'
106

107
# Optionally, override home directory for gpg
108
# gpghome = '/home/fdroid/somewhere/else/.gnupg'
109

110
# The ID of a GPG key for making detached signatures for apks. Optional.
Daniel Martí's avatar
Daniel Martí committed
111
# gpgkey = '1DBA2E89'
112

113
# The key (from the keystore defined below) to be used for signing the
114 115
# repository itself. This is the same name you would give to keytool or
# jarsigner using -alias. (Not needed in an unsigned repository).
Daniel Martí's avatar
Daniel Martí committed
116
# repo_keyalias = "fdroidrepo"
117

118 119 120 121 122 123 124
# 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 = "..."

125 126 127
# 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
128
# configure F-Droid to use a smartcard, set the keystore file using the keyword
129
# "NONE" (i.e. keystore = "NONE"). That makes Java find the keystore on the
130
# smartcard based on 'smartcardoptions' below.
Daniel Martí's avatar
Daniel Martí committed
131
# keystore = "~/.local/share/fdroidserver/keystore.jks"
132 133 134

# You should not need to change these at all, unless you have a very
# customized setup for using smartcards in Java with keytool/jarsigner
Daniel Martí's avatar
Daniel Martí committed
135
# smartcardoptions = "-storetype PKCS11 -providerName SunPKCS11-OpenSC \
136 137
#    -providerClass sun.security.pkcs11.SunPKCS11 \
#    -providerArg opensc-fdroid.cfg"
138

139
# The password for the keystore (at least 6 characters). If this password is
140
# different than the keypass below, it can be OK to store the password in this
141
# file for real use. But in general, sensitive passwords should not be stored
142
# in text files!
Daniel Martí's avatar
Daniel Martí committed
143
# keystorepass = "password1"
144 145

# The password for keys - the same is used for each auto-generated key as well
146
# as for the repository key. You should not normally store this password in a
147
# file since it is a sensitive password.
Daniel Martí's avatar
Daniel Martí committed
148
# keypass = "password2"
149

Daniel Martí's avatar
Daniel Martí committed
150
# The distinguished name used for all keys.
151
# keydname = "CN=Birdman, OU=Cell, O=Alcatraz, L=Alcatraz, S=California, C=US"
152

Daniel Martí's avatar
Daniel Martí committed
153 154
# Use this to override the auto-generated key aliases with specific ones
# for particular applications. Normally, just leave it empty.
155 156
# keyaliases = {}
# keyaliases['com.example.app'] = 'example'
Daniel Martí's avatar
Daniel Martí committed
157 158
# You can also force an app to use the same key alias as another one, using
# the @ prefix.
159
# keyaliases['com.example.another.plugin'] = '@com.example.another'
160

161

162
# The full path to the root of the repository. It must be specified in
163
# rsync/ssh format for a remote host/path. This is used for syncing a locally
164
# generated repo to the server that is it hosted on. It must end in the
165
# standard public repo name of "/fdroid", but can be in up to three levels of
166
# sub-directories (i.e. /var/www/packagerepos/fdroid). You can include
167 168
# multiple servers to sync to by wrapping the whole thing in {} or [], and
# including the serverwebroot strings in a comma-separated list.
169
#
Daniel Martí's avatar
Daniel Martí committed
170
# serverwebroot = '[email protected]:/var/www/fdroid'
171 172 173 174
# serverwebroot = {
#     'foo.com:/usr/share/nginx/www/fdroid',
#     'bar.info:/var/www/fdroid',
#     }
175

176 177 178 179 180 181 182 183
# When running fdroid processes on a remote server, it is possible to
# publish extra information about the status.  Each fdroid sub-command
# can create repo/status/running.json when it starts, then a
# repo/status/<sub-command>.json when it completes.  The builds logs
# and other processes will also get published, if they are running in
# a buildserver VM.  The build logs name scheme is:
# .../repo/$APPID_$VERCODE.log.gz.  These files are also pushed to all
# servers configured in 'serverwebroot'.
184
#
185
# deploy_process_logs = True
186

TheZ3ro's avatar
TheZ3ro committed
187 188 189 190 191 192 193 194 195 196 197
# The full URL to a git remote repository. You can include
# multiple servers to mirror to by wrapping the whole thing in {} or [], and
# including the servergitmirrors strings in a comma-separated list.
# Servers listed here will also be automatically inserted in the mirrors list.
#
# servergitmirrors = 'https://github.com/user/repo'
# servergitmirrors = {
#     'https://github.com/user/repo',
#     'https://gitlab.com/user/repo',
#     }

198 199 200 201 202 203 204
# Most git hosting services have hard size limits for each git repo.
# `fdroid deploy` will delete the git history when the git mirror repo
# approaches this limit to ensure that the repo will still fit when
# pushed.  GitHub recommends 1GB, gitlab.com recommends 10GB.
#
# git_mirror_size_limit = '10GB'

205
# Any mirrors of this repo, for example all of the servers declared in
TheZ3ro's avatar
TheZ3ro committed
206 207
# serverwebroot and all the servers declared in servergitmirrors,
# will automatically be used by the client.  If one
208 209 210 211 212 213
# 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.
#
214
# mirrors = (
215 216
#     'https://foo.bar/fdroid',
#     'http://foobarfoobarfoobar.onion/fdroid',
217
# )
218

219
# optionally specify which identity file to use when using rsync or git over SSH
220
#
221 222
# identity_file = '~/.ssh/fdroid_id_rsa'

223 224 225

# 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
226 227 228
# 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
229 230 231 232 233 234
# standard folder called 'fdroid' as the specified folder is recommended, like
# with serverwebroot.
#
# local_copy_dir = '/media/MyUSBThumbDrive/fdroid'


235 236
# 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
237
# synced to the copy on the online machine. To make that happen
238 239 240 241 242
# automatically, set sync_from_local_copy_dir to True:
#
# sync_from_local_copy_dir = True


243 244 245 246 247 248
# To upload the repo to an Amazon S3 bucket using `fdroid server
# update`.  Warning, this deletes and recreates the whole fdroid/
# directory each time. This prefers s3cmd, but can also use
# apache-libcloud.  To customize how s3cmd interacts with the cloud
# provider, create a 's3cfg' file next to this file (config.py), and
# those settings will be used instead of any 'aws' variable below.
249
#
Daniel Martí's avatar
Daniel Martí committed
250 251 252
# awsbucket = 'myawsfdroid'
# awsaccesskeyid = 'SEE0CHAITHEIMAUR2USA'
# awssecretkey = 'yourverysecretkeywordpassphraserighthere'
253

254

255 256 257 258
# If you want to force 'fdroid server' to use a non-standard serverwebroot.
# This will allow you to have 'serverwebroot' entries which do not end in
# '/fdroid'. (Please note that some client features expect repository URLs
# to end in '/fdroid/repo'.)
259
#
Daniel Martí's avatar
Daniel Martí committed
260
# nonstandardwebroot = False
261

262

263 264
# If you want to upload the release apk file to androidobservatory.org
#
265
# androidobservatory = False
266 267


TheZ3ro's avatar
TheZ3ro committed
268 269 270 271 272 273
# If you want to upload the release apk file to virustotal.com
# You have to enter your profile apikey to enable the upload.
#
# virustotal_apikey = "virustotal_apikey"


274 275 276 277 278 279
# 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"
Ciaran Gultnieks's avatar
Ciaran Gultnieks committed
280

281 282 283 284 285 286 287
# Keep a log of all generated index files in a git repo to provide a
# "binary transparency" log for anyone to check the history of the
# binaries that are published.  This is in the form of a "git remote",
# which this machine where `fdroid update` is run has already been
# configured to allow push access (e.g. ssh key, username/password, etc)
# binary_transparency_remote = "[email protected]:fdroid/binary-transparency-log.git"

Daniel Martí's avatar
Daniel Martí committed
288 289
# 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
290 291
# machine. If you want to keep the "added" and "last updated" dates for each
# app and APK in your repo, then you should enable this.
292
# update_stats = True
293

294 295
# When used with stats, this is a list of IP addresses that are ignored for
# calculation purposes.
296
# stats_ignore = []
297

298
# Server stats logs are retrieved from. Required when update_stats is True.
299
# stats_server = "example.com"
300 301

# User stats logs are retrieved from. Required when update_stats is True.
302
# stats_user = "bob"
303

Daniel Martí's avatar
Daniel Martí committed
304
# Use the following to push stats to a Carbon instance:
305 306 307
# stats_to_carbon = False
# carbon_host = '0.0.0.0'
# carbon_port = 2003
308

Daniel Martí's avatar
Daniel Martí committed
309 310
# Set this to true to always use a build server. This saves specifying the
# --server option on dedicated secure build server hosts.
311
# build_server_always = True
312

313
# By default, fdroid will use YAML .yml and the custom .txt metadata formats. It
314
# is also possible to have metadata in JSON by adding 'json'.
315
# accepted_formats = ('txt', 'yml')
316

317 318
# Limit in number of characters that fields can take up
# Only the fields listed here are supported, defaults shown
319
# char_limits = {
320
#     'author': 256,
Marcus's avatar
Marcus committed
321
#     'name': 50,
322 323 324 325
#     'summary': 80,
#     'description': 4000,
#     'video': 256,
#     'whatsNew': 500,
326
# }
327 328

# It is possible for the server operator to specify lists of apps that
329 330 331
# must be installed or uninstalled on the client (aka "push installs).
# If the user has opted in, or the device is already setup to respond
# to these requests, then F-Droid will automatically install/uninstall
332 333 334
# the packageNames listed.  This is protected by the same signing key
# as the app index metadata.
#
335
# install_list = (
336 337 338
#     'at.bitfire.davdroid',
#     'com.fsck.k9',
#     'us.replicant',
339
# )
340
#
341
# uninstall_list = (
342 343
#     'com.facebook.orca',
#     'com.android.vending',
344
# )
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361

# `fdroid lint` checks licenses in metadata against a built white list.  By
# default we will require license metadata to be present and only allow
# licenses approved either by FSF or OSI.  We're using the standardized SPDX
# license IDs.  (https://spdx.org/licenses/)
#
# We use `python3 -m spdx-license-list print --filter-fsf-or-osi` for
# generating our default list.  (https://pypi.org/project/spdx-license-list)
#
# You can override our default list of allowed licenes by setting this option.
# Just supply a custom list of licene names you would like to allow. Setting
# this to `None` disables this lint check.
#
# lint_licenses = (
#     'Custom-License-A',
#     'Another-License',
# )