config.py 6.93 KB
Newer Older
1 2
#!/usr/bin/env python2

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

Daniel Martí's avatar
Daniel Martí committed
6
# Override the path to the Android SDK, $ANDROID_HOME by default
Daniel Martí's avatar
Daniel Martí committed
7
# sdk_path = "/path/to/android-sdk"
8

Daniel Martí's avatar
Daniel Martí committed
9
# Override the path to the Android NDK, $ANDROID_NDK by default
Daniel Martí's avatar
Daniel Martí committed
10
# ndk_path = "/path/to/android-ndk"
11
# Build tools version to be used
Daniel Martí's avatar
Daniel Martí committed
12
build_tools = "20.0.0"
13

Daniel Martí's avatar
Daniel Martí committed
14
# Command for running Ant
Daniel Martí's avatar
Daniel Martí committed
15
# ant = "/path/to/ant"
Daniel Martí's avatar
Daniel Martí committed
16
ant = "ant"
17

Daniel Martí's avatar
Daniel Martí committed
18
# Command for running maven 3
Daniel Martí's avatar
Daniel Martí committed
19
# mvn3 = "/path/to/mvn"
Daniel Martí's avatar
Daniel Martí committed
20 21 22
mvn3 = "mvn"

# Command for running Gradle
Daniel Martí's avatar
Daniel Martí committed
23
# gradle = "/path/to/gradle"
24 25
gradle = "gradle"

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

33 34
repo_url = "https://MyFirstFDroidRepo.org/fdroid/repo"
repo_name = "My First FDroid Repo Demo"
Ciaran Gultnieks's avatar
Ciaran Gultnieks committed
35
repo_icon = "fdroid-icon.png"
36 37 38 39 40 41
repo_description = """
This is a repository of apps to be used with FDroid. 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.
"""
Ciaran Gultnieks's avatar
Ciaran Gultnieks committed
42

43 44 45 46 47 48
# 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"
49
archive_name = "My First FDroid Archive Demo"
50
archive_icon = "fdroid-icon.png"
51 52 53
archive_description = """
The repository of older versions of applications from the main demo repository.
"""
54 55


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

59 60 61
# 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).
Daniel Martí's avatar
Daniel Martí committed
62
# repo_keyalias = "fdroidrepo"
63

64 65 66 67 68 69
# 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
# smartcard based on 'smartcardoptions' below.
Daniel Martí's avatar
Daniel Martí committed
70
# keystore = "~/.local/share/fdroidserver/keystore.jks"
71 72 73

# 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
74
# smartcardoptions = "-storetype PKCS11 -providerName SunPKCS11-OpenSC \
75 76
#    -providerClass sun.security.pkcs11.SunPKCS11 \
#    -providerArg opensc-fdroid.cfg"
77

78 79 80 81
# 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
# in text files!
Daniel Martí's avatar
Daniel Martí committed
82
# keystorepass = "password1"
83 84 85 86

# 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
# file since it is a sensitive password.
Daniel Martí's avatar
Daniel Martí committed
87
# keypass = "password2"
88

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

Daniel Martí's avatar
Daniel Martí committed
92 93
# Use this to override the auto-generated key aliases with specific ones
# for particular applications. Normally, just leave it empty.
94 95
keyaliases = {}
keyaliases['com.example.app'] = 'example'
Daniel Martí's avatar
Daniel Martí committed
96 97
# You can also force an app to use the same key alias as another one, using
# the @ prefix.
98
keyaliases['com.example.another.plugin'] = '@com.example.another'
99

100

101 102 103 104
# 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
# standard public repo name of "/fdroid", but can be in up to three levels of
105 106 107
# 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.
108
#
Daniel Martí's avatar
Daniel Martí committed
109
# serverwebroot = '[email protected]:/var/www/fdroid'
110 111 112 113
# serverwebroot = {
#     'foo.com:/usr/share/nginx/www/fdroid',
#     'bar.info:/var/www/fdroid',
#     }
114

115

116
# optionally specific which identity file to use when using rsync over SSH
117
#
118 119
# identity_file = '~/.ssh/fdroid_id_rsa'

120 121 122 123 124 125 126 127 128 129 130 131

# 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
# standard folder called 'fdroid' as the specified folder is recommended, like
# with serverwebroot.
#
# local_copy_dir = '/media/MyUSBThumbDrive/fdroid'


132 133 134 135 136 137 138 139
# 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
# automatically, set sync_from_local_copy_dir to True:
#
# sync_from_local_copy_dir = True


140 141 142 143 144
# 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.
145
#
Daniel Martí's avatar
Daniel Martí committed
146 147 148
# awsbucket = 'myawsfdroid'
# awsaccesskeyid = 'SEE0CHAITHEIMAUR2USA'
# awssecretkey = 'yourverysecretkeywordpassphraserighthere'
149

150

151
# If you want to force 'fdroid server' to use a non-standard serverwebroot
152
#
Daniel Martí's avatar
Daniel Martí committed
153
# nonstandardwebroot = False
154

155

Daniel Martí's avatar
Daniel Martí committed
156
# Wiki details
Ciaran Gultnieks's avatar
Ciaran Gultnieks committed
157
wiki_protocol = "http"
Ciaran Gultnieks's avatar
Ciaran Gultnieks committed
158 159 160 161 162
wiki_server = "server"
wiki_path = "/wiki/"
wiki_user = "login"
wiki_password = "1234"

Daniel Martí's avatar
Daniel Martí committed
163 164 165
# 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.
166 167
update_stats = False

168 169 170 171
# When used with stats, this is a list of IP addresses that are ignored for
# calculation purposes.
stats_ignore = []

Daniel Martí's avatar
Daniel Martí committed
172
# Use the following to push stats to a Carbon instance:
173 174 175 176
stats_to_carbon = False
carbon_host = '0.0.0.0'
carbon_port = 2003

Daniel Martí's avatar
Daniel Martí committed
177 178
# Set this to true to always use a build server. This saves specifying the
# --server option on dedicated secure build server hosts.
179
build_server_always = False
180 181 182

# Limit in number of characters that fields can take up
# Only the fields listed here are supported, defaults shown
183
char_limits = {
184 185
    'Summary': 50,
    'Description': 1500
186
}