chiark / gitweb /
464528db682ed42a3c2c68cc6ea89c3687897b83
[fdroidserver.git] / examples / config.py
1 #!/usr/bin/env python3
2
3 # Copy this file to config.py, then amend the settings below according to
4 # your system configuration.
5
6 # Custom path to the Android SDK, defaults to $ANDROID_HOME
7 # sdk_path = "$ANDROID_HOME"
8
9 # Custom paths to various versions of the Android NDK, defaults to 'r10e' set
10 # to $ANDROID_NDK. Most users will have the latest at $ANDROID_NDK, which is
11 # used by default. If a version is missing or assigned to None, it is assumed
12 # not installed.
13 # ndk_paths = {
14 #     'r9b': None,
15 #     'r10e': None,
16 #     'r12b': "$ANDROID_NDK",
17 # }
18
19 # java_paths = {
20 #     '1.8': "/usr/lib/jvm/java-8-openjdk",
21 # }
22
23 # Build tools version to be used
24 # build_tools = "24.0.1"
25
26 # Force all build to use the above version of build -tools, good for testing
27 # builds without having all of the possible build-tools installed.
28 # force_build_tools = True
29
30 # Command or path to binary for running Ant
31 # ant = "ant"
32
33 # Command or path to binary for running maven 3
34 # mvn3 = "mvn"
35
36 # Command or path to binary for running Gradle
37 # gradle = "gradle"
38
39 # Set the maximum age (in days) of an index that a client should accept from
40 # this repo. Setting it to 0 or not setting it at all disables this
41 # functionality. If you do set this to a non-zero value, you need to ensure
42 # that your index is updated much more frequently than the specified interval.
43 # The same policy is applied to the archive repo, if there is one.
44 # repo_maxage = 0
45
46 repo_url = "https://MyFirstFDroidRepo.org/fdroid/repo"
47 repo_name = "My First F-Droid Repo Demo"
48 repo_icon = "fdroid-icon.png"
49 repo_description = """
50 This is a repository of apps to be used with F-Droid. Applications in this
51 repository are either official binaries built by the original application
52 developers, or are binaries built from source by the admin of f-droid.org
53 using the tools on https://gitlab.com/u/fdroid.
54 """
55
56 # As above, but for the archive repo.
57 # archive_older sets the number of versions kept in the main repo, with all
58 # older ones going to the archive. Set it to 0, and there will be no archive
59 # repository, and no need to define the other archive_ values.
60 archive_older = 3
61 archive_url = "https://f-droid.org/archive"
62 archive_name = "My First F-Droid Archive Demo"
63 archive_icon = "fdroid-icon.png"
64 archive_description = """
65 The repository of older versions of applications from the main demo repository.
66 """
67
68 # Normally, all apps are collected into a single app repository, like on
69 # https://f-droid.org. For certain situations, it is better to make a repo
70 # that is made up of APKs only from a single app. For example, an automated
71 # build server that publishes nightly builds.
72 # per_app_repos = True
73
74 # `fdroid update` will create a link to the current version of a given app.
75 # This provides a static path to the current APK. To disable the creation of
76 # this link, uncomment this:
77 # make_current_version_link = False
78
79 # By default, the "current version" link will be based on the "Name" of the
80 # app from the metadata. You can change it to use a different field from the
81 # metadata here:
82 # current_version_name_source = 'id'
83
84 # Optionally, override home directory for gpg
85 # gpghome = /home/fdroid/somewhere/else/.gnupg
86
87 # The ID of a GPG key for making detached signatures for apks. Optional.
88 # gpgkey = '1DBA2E89'
89
90 # The key (from the keystore defined below) to be used for signing the
91 # repository itself. This is the same name you would give to keytool or
92 # jarsigner using -alias. (Not needed in an unsigned repository).
93 # repo_keyalias = "fdroidrepo"
94
95 # Optionally, the public key for the key defined by repo_keyalias above can
96 # be specified here. There is no need to do this, as the public key can and
97 # will be retrieved from the keystore when needed. However, specifying it
98 # manually can allow some processing to take place without access to the
99 # keystore.
100 # repo_pubkey = "..."
101
102 # The keystore to use for release keys when building. This needs to be
103 # somewhere safe and secure, and backed up!  The best way to manage these
104 # sensitive keys is to use a "smartcard" (aka Hardware Security Module). To
105 # configure F-Droid to use a smartcard, set the keystore file using the keyword
106 # "NONE" (i.e. keystore = "NONE"). That makes Java find the keystore on the
107 # smartcard based on 'smartcardoptions' below.
108 # keystore = "~/.local/share/fdroidserver/keystore.jks"
109
110 # You should not need to change these at all, unless you have a very
111 # customized setup for using smartcards in Java with keytool/jarsigner
112 # smartcardoptions = "-storetype PKCS11 -providerName SunPKCS11-OpenSC \
113 #    -providerClass sun.security.pkcs11.SunPKCS11 \
114 #    -providerArg opensc-fdroid.cfg"
115
116 # The password for the keystore (at least 6 characters). If this password is
117 # different than the keypass below, it can be OK to store the password in this
118 # file for real use. But in general, sensitive passwords should not be stored
119 # in text files!
120 # keystorepass = "password1"
121
122 # The password for keys - the same is used for each auto-generated key as well
123 # as for the repository key. You should not normally store this password in a
124 # file since it is a sensitive password.
125 # keypass = "password2"
126
127 # The distinguished name used for all keys.
128 # keydname = "CN=Birdman, OU=Cell, O=Alcatraz, L=Alcatraz, S=California, C=US"
129
130 # Use this to override the auto-generated key aliases with specific ones
131 # for particular applications. Normally, just leave it empty.
132 # keyaliases = {}
133 # keyaliases['com.example.app'] = 'example'
134 # You can also force an app to use the same key alias as another one, using
135 # the @ prefix.
136 # keyaliases['com.example.another.plugin'] = '@com.example.another'
137
138
139 # The full path to the root of the repository. It must be specified in
140 # rsync/ssh format for a remote host/path. This is used for syncing a locally
141 # generated repo to the server that is it hosted on. It must end in the
142 # standard public repo name of "/fdroid", but can be in up to three levels of
143 # sub-directories (i.e. /var/www/packagerepos/fdroid). You can include
144 # multiple servers to sync to by wrapping the whole thing in {} or [], and
145 # including the serverwebroot strings in a comma-separated list.
146 #
147 # serverwebroot = 'user@example:/var/www/fdroid'
148 # serverwebroot = {
149 #     'foo.com:/usr/share/nginx/www/fdroid',
150 #     'bar.info:/var/www/fdroid',
151 #     }
152
153 # Any mirrors of this repo, for example all of the servers declared in
154 # serverwebroot, will automatically be used by the client.  If one
155 # mirror is not working, then the client will try another.  If the
156 # client has Tor enabled, then the client will prefer mirrors with
157 # .onion addresses. This base URL will be used for both the main repo
158 # and the archive, if it is enabled.  So these URLs should end in the
159 # 'fdroid' base of the F-Droid part of the web server like serverwebroot.
160 #
161 # mirrors = {
162 #     'https://foo.bar/fdroid',
163 #     'http://foobarfoobarfoobar.onion/fdroid',
164 # }
165
166 # optionally specific which identity file to use when using rsync over SSH
167 #
168 # identity_file = '~/.ssh/fdroid_id_rsa'
169
170
171 # If you are running the repo signing process on a completely offline machine,
172 # which provides the best security, then you can specify a folder to sync the
173 # repo to when running `fdroid server update`. This is most likely going to
174 # be a USB thumb drive, SD Card, or some other kind of removable media. Make
175 # sure it is mounted before running `fdroid server update`. Using the
176 # standard folder called 'fdroid' as the specified folder is recommended, like
177 # with serverwebroot.
178 #
179 # local_copy_dir = '/media/MyUSBThumbDrive/fdroid'
180
181
182 # If you are using local_copy_dir on an offline build/signing server, once the
183 # thumb drive has been plugged into the online machine, it will need to be
184 # synced to the copy on the online machine. To make that happen
185 # automatically, set sync_from_local_copy_dir to True:
186 #
187 # sync_from_local_copy_dir = True
188
189
190 # To upload the repo to an Amazon S3 bucket using `fdroid server update`.
191 # Warning, this deletes and recreates the whole fdroid/ directory each
192 # time. This is based on apache-libcloud, which supports basically all cloud
193 # storage services, so it should be easy to port the fdroid server tools to
194 # any of them.
195 #
196 # awsbucket = 'myawsfdroid'
197 # awsaccesskeyid = 'SEE0CHAITHEIMAUR2USA'
198 # awssecretkey = 'yourverysecretkeywordpassphraserighthere'
199
200
201 # If you want to force 'fdroid server' to use a non-standard serverwebroot
202 #
203 # nonstandardwebroot = False
204
205
206 # The build logs can be posted to a mediawiki instance, like on f-droid.org.
207 # wiki_protocol = "http"
208 # wiki_server = "server"
209 # wiki_path = "/wiki/"
210 # wiki_user = "login"
211 # wiki_password = "1234"
212
213 # Only set this to true when running a repository where you want to generate
214 # stats, and only then on the master build servers, not a development
215 # machine.
216 # update_stats = True
217
218 # When used with stats, this is a list of IP addresses that are ignored for
219 # calculation purposes.
220 # stats_ignore = []
221
222 # Server stats logs are retrieved from. Required when update_stats is True.
223 # stats_server = "example.com"
224
225 # User stats logs are retrieved from. Required when update_stats is True.
226 # stats_user = "bob"
227
228 # Use the following to push stats to a Carbon instance:
229 # stats_to_carbon = False
230 # carbon_host = '0.0.0.0'
231 # carbon_port = 2003
232
233 # Set this to true to always use a build server. This saves specifying the
234 # --server option on dedicated secure build server hosts.
235 # build_server_always = True
236
237 # By default, fdroid will use YAML .yml and the custom .txt metadata formats. It
238 # is also possible to have metadata in JSON and XML by adding 'json' and
239 # 'xml'.
240 # accepted_formats = ['txt', 'yml']
241
242 # Limit in number of characters that fields can take up
243 # Only the fields listed here are supported, defaults shown
244 # char_limits = {
245 #     'Summary': 80,
246 #     'Description': 4000,
247 # }