config.py 9.57 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 = {
14
#     'r9b': None,
Daniel Martí's avatar
Daniel Martí committed
15
#     'r10e': None,
Boris Kraut's avatar
Boris Kraut committed
16
#     'r11c': None,
Daniel Martí's avatar
Daniel Martí committed
17
#     'r12b': "$ANDROID_NDK",
18
# }
19

20
# java_paths = {
Daniel Martí's avatar
Daniel Martí committed
21
#     '1.8': "/usr/lib/jvm/java-8-openjdk",
22 23
# }

24
# Build tools version to be used
25
# build_tools = "24.0.1"
26

27 28 29 30
# 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

31
# Command or path to binary for running Ant
32
# ant = "ant"
33

34
# Command or path to binary for running maven 3
35
# mvn3 = "mvn"
Daniel Martí's avatar
Daniel Martí committed
36

37
# Command or path to binary for running Gradle
38
# gradle = "gradle"
39

40 41 42 43 44
# 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.
45
# repo_maxage = 0
46

47
repo_url = "https://MyFirstFDroidRepo.org/fdroid/repo"
48
repo_name = "My First F-Droid Repo Demo"
Ciaran Gultnieks's avatar
Ciaran Gultnieks committed
49
repo_icon = "fdroid-icon.png"
50
repo_description = """
51
This is a repository of apps to be used with F-Droid. Applications in this
52 53 54 55
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
56

57 58 59 60 61 62
# 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"
63
archive_name = "My First F-Droid Archive Demo"
64
archive_icon = "fdroid-icon.png"
65 66 67
archive_description = """
The repository of older versions of applications from the main demo repository.
"""
68

69
# Normally, all apps are collected into a single app repository, like on
70 71
# 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
72 73 74
# build server that publishes nightly builds.
# per_app_repos = True

75
# `fdroid update` will create a link to the current version of a given app.
76
# This provides a static path to the current APK. To disable the creation of
77 78 79 80
# this link, uncomment this:
# make_current_version_link = False

# By default, the "current version" link will be based on the "Name" of the
81
# app from the metadata. You can change it to use a different field from the
82 83
# metadata here:
# current_version_name_source = 'id'
84

85 86 87
# Optionally, override home directory for gpg
# gpghome = /home/fdroid/somewhere/else/.gnupg

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

91
# The key (from the keystore defined below) to be used for signing the
92 93
# 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
94
# repo_keyalias = "fdroidrepo"
95

96 97 98 99 100 101 102
# 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 = "..."

103 104 105
# 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
106
# configure F-Droid to use a smartcard, set the keystore file using the keyword
107
# "NONE" (i.e. keystore = "NONE"). That makes Java find the keystore on the
108
# smartcard based on 'smartcardoptions' below.
Daniel Martí's avatar
Daniel Martí committed
109
# keystore = "~/.local/share/fdroidserver/keystore.jks"
110 111 112

# 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
113
# smartcardoptions = "-storetype PKCS11 -providerName SunPKCS11-OpenSC \
114 115
#    -providerClass sun.security.pkcs11.SunPKCS11 \
#    -providerArg opensc-fdroid.cfg"
116

117
# The password for the keystore (at least 6 characters). If this password is
118
# different than the keypass below, it can be OK to store the password in this
119
# file for real use. But in general, sensitive passwords should not be stored
120
# in text files!
Daniel Martí's avatar
Daniel Martí committed
121
# keystorepass = "password1"
122 123

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

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

Daniel Martí's avatar
Daniel Martí committed
131 132
# Use this to override the auto-generated key aliases with specific ones
# for particular applications. Normally, just leave it empty.
133 134
# keyaliases = {}
# keyaliases['com.example.app'] = 'example'
Daniel Martí's avatar
Daniel Martí committed
135 136
# You can also force an app to use the same key alias as another one, using
# the @ prefix.
137
# keyaliases['com.example.another.plugin'] = '@com.example.another'
138

139

140
# The full path to the root of the repository. It must be specified in
141
# rsync/ssh format for a remote host/path. This is used for syncing a locally
142
# generated repo to the server that is it hosted on. It must end in the
143
# standard public repo name of "/fdroid", but can be in up to three levels of
144
# sub-directories (i.e. /var/www/packagerepos/fdroid). You can include
145 146
# multiple servers to sync to by wrapping the whole thing in {} or [], and
# including the serverwebroot strings in a comma-separated list.
147
#
Daniel Martí's avatar
Daniel Martí committed
148
# serverwebroot = '[email protected]:/var/www/fdroid'
149 150 151 152
# serverwebroot = {
#     'foo.com:/usr/share/nginx/www/fdroid',
#     'bar.info:/var/www/fdroid',
#     }
153

154 155 156 157 158 159 160 161 162 163 164 165
# 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',
# }
166

167
# optionally specific which identity file to use when using rsync over SSH
168
#
169 170
# identity_file = '~/.ssh/fdroid_id_rsa'

171 172 173

# 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
174 175 176
# 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
177 178 179 180 181 182
# standard folder called 'fdroid' as the specified folder is recommended, like
# with serverwebroot.
#
# local_copy_dir = '/media/MyUSBThumbDrive/fdroid'


183 184
# 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
185
# synced to the copy on the online machine. To make that happen
186 187 188 189 190
# automatically, set sync_from_local_copy_dir to True:
#
# sync_from_local_copy_dir = True


191 192 193 194 195
# 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 is based on apache-libcloud, which supports basically all cloud
# storage services, so it should be easy to port the fdroid server tools to
# any of them.
196
#
Daniel Martí's avatar
Daniel Martí committed
197 198 199
# awsbucket = 'myawsfdroid'
# awsaccesskeyid = 'SEE0CHAITHEIMAUR2USA'
# awssecretkey = 'yourverysecretkeywordpassphraserighthere'
200

201

202
# If you want to force 'fdroid server' to use a non-standard serverwebroot
203
#
Daniel Martí's avatar
Daniel Martí committed
204
# nonstandardwebroot = False
205

206

207 208 209 210 211 212
# 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
213

Daniel Martí's avatar
Daniel Martí committed
214 215 216
# 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.
217
# update_stats = True
218

219 220
# When used with stats, this is a list of IP addresses that are ignored for
# calculation purposes.
221
# stats_ignore = []
222

223
# Server stats logs are retrieved from. Required when update_stats is True.
224
# stats_server = "example.com"
225 226

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

Daniel Martí's avatar
Daniel Martí committed
229
# Use the following to push stats to a Carbon instance:
230 231 232
# stats_to_carbon = False
# carbon_host = '0.0.0.0'
# carbon_port = 2003
233

Daniel Martí's avatar
Daniel Martí committed
234 235
# Set this to true to always use a build server. This saves specifying the
# --server option on dedicated secure build server hosts.
236
# build_server_always = True
237

238
# By default, fdroid will use YAML .yml and the custom .txt metadata formats. It
239 240
# is also possible to have metadata in JSON and XML by adding 'json' and
# 'xml'.
241
# accepted_formats = ['txt', 'yml']
242

243 244
# Limit in number of characters that fields can take up
# Only the fields listed here are supported, defaults shown
245 246 247 248
# char_limits = {
#     'Summary': 80,
#     'Description': 4000,
# }