chiark / gitweb /
server: --sync-from-local-copy-dir for updating from offline signing repo
[fdroidserver.git] / examples / config.py
1 #!/usr/bin/env python2
2
3 # Copy this file to config.py, then amend the settings below according to
4 # your system configuration.
5
6 # Override the path to the Android SDK, $ANDROID_HOME by default
7 # sdk_path = "/path/to/android-sdk"
8
9 # Override the path to the Android NDK, $ANDROID_NDK by default
10 # ndk_path = "/path/to/android-ndk"
11 # Build tools version to be used
12 build_tools = "19.0.2"
13
14 # Command for running Ant
15 # ant = "/path/to/ant"
16 ant = "ant"
17
18 # Command for running maven 3
19 # mvn3 = "/path/to/mvn"
20 mvn3 = "mvn"
21
22 # Command for running Gradle
23 # gradle = "/path/to/gradle"
24 gradle = "gradle"
25
26 # Set the maximum age (in days) of an index that a client should accept from
27 # this repo. Setting it to 0 or not setting it at all disables this
28 # functionality. If you do set this to a non-zero value, you need to ensure
29 # that your index is updated much more frequently than the specified interval.
30 # The same policy is applied to the archive repo, if there is one.
31 repo_maxage = 0
32
33 repo_url = "https://MyFirstFDroidRepo.org/fdroid/repo"
34 repo_name = "My First FDroid Repo Demo"
35 repo_icon = "fdroid-icon.png"
36 repo_description = """
37 This is a repository of apps to be used with FDroid. Applications in this
38 repository are either official binaries built by the original application
39 developers, or are binaries built from source by the admin of f-droid.org
40 using the tools on https://gitlab.com/u/fdroid.
41 """
42
43 # As above, but for the archive repo.
44 # archive_older sets the number of versions kept in the main repo, with all
45 # older ones going to the archive. Set it to 0, and there will be no archive
46 # repository, and no need to define the other archive_ values.
47 archive_older = 3
48 archive_url = "https://f-droid.org/archive"
49 archive_name = "My First FDroid Archive Demo"
50 archive_icon = "fdroid-icon.png"
51 archive_description = """
52 The repository of older versions of applications from the main demo
53 repository.
54 """
55
56
57 # The ID of a GPG key for making detached signatures for apks. Optional.
58 # gpgkey = '1DBA2E89'
59
60 # The key (from the keystore defined below) to be used for signing the
61 # repository itself.  This is the same name you would give to keytool or
62 # jarsigner using -alias.  (Not needed in an unsigned repository).
63 # repo_keyalias = "fdroidrepo"
64
65 # The keystore to use for release keys when building. This needs to be
66 # somewhere safe and secure, and backed up!  The best way to manage these
67 # sensitive keys is to use a "smartcard" (aka Hardware Security Module). To
68 # configure FDroid to use a smartcard, set the keystore file using the keyword
69 # "NONE" (i.e. keystore = "NONE").  That makes Java find the keystore on the
70 # smartcard based on 'smartcardoptions' below.
71 # keystore = "~/.local/share/fdroidserver/keystore.jks"
72
73 # You should not need to change these at all, unless you have a very
74 # customized setup for using smartcards in Java with keytool/jarsigner
75 # smartcardoptions = "-storetype PKCS11 -providerName SunPKCS11-OpenSC \
76 #    -providerClass sun.security.pkcs11.SunPKCS11 \
77 #    -providerArg opensc-fdroid.cfg"
78
79 # The password for the keystore (at least 6 characters).  If this password is
80 # different than the keypass below, it can be OK to store the password in this
81 # file for real use.  But in general, sensitive passwords should not be stored
82 # in text files!
83 # keystorepass = "password1"
84
85 # The password for keys - the same is used for each auto-generated key as well
86 # as for the repository key.  You should not normally store this password in a
87 # file since it is a sensitive password.
88 # keypass = "password2"
89
90 # The distinguished name used for all keys.
91 keydname = "CN=Birdman, OU=Cell, O=Alcatraz, L=Alcatraz, S=California, C=US"
92
93 # Use this to override the auto-generated key aliases with specific ones
94 # for particular applications. Normally, just leave it empty.
95 keyaliases = {}
96 keyaliases['com.example.app'] = 'example'
97 # You can also force an app to use the same key alias as another one, using
98 # the @ prefix.
99 keyaliases['com.example.another.plugin'] = '@com.example.another'
100
101
102 # The full path to the root of the repository.  It must be specified in
103 # rsync/ssh format for a remote host/path. This is used for syncing a locally
104 # generated repo to the server that is it hosted on.  It must end in the
105 # standard public repo name of "/fdroid", but can be in up to three levels of
106 # sub-directories (i.e. /var/www/packagerepos/fdroid).
107 #
108 # serverwebroot = 'user@example:/var/www/fdroid'
109
110
111 # optionally specific which identity file to use when using rsync over SSH
112 #
113 # identity_file = '~/.ssh/fdroid_id_rsa'
114
115
116 # If you are running the repo signing process on a completely offline machine,
117 # which provides the best security, then you can specify a folder to sync the
118 # repo to when running `fdroid server update`.  This is most likely going to
119 # be a USB thumb drive, SD Card, or some other kind of removable media.  Make
120 # sure it is mounted before running `fdroid server update`.  Using the
121 # standard folder called 'fdroid' as the specified folder is recommended, like
122 # with serverwebroot.
123 #
124 # local_copy_dir = '/media/MyUSBThumbDrive/fdroid'
125
126
127 # If you are using local_copy_dir on an offline build/signing server, once the
128 # thumb drive has been plugged into the online machine, it will need to be
129 # synced to the copy on the online machine.  To make that happen
130 # automatically, set sync_from_local_copy_dir to True:
131 #
132 # sync_from_local_copy_dir = True
133
134
135 # To upload the repo to an Amazon S3 bucket using `fdroid server update`.
136 # Warning, this deletes and recreates the whole fdroid/ directory each
137 # time. This is based on apache-libcloud, which supports basically all cloud
138 # storage services, so it should be easy to port the fdroid server tools to
139 # any of them.
140 #
141 # awsbucket = 'myawsfdroid'
142 # awsaccesskeyid = 'SEE0CHAITHEIMAUR2USA'
143 # awssecretkey = 'yourverysecretkeywordpassphraserighthere'
144
145
146 # If you want to force 'fdroid server' to use a non-standard serverwebroot
147 #
148 # nonstandardwebroot = False
149
150
151 # Wiki details
152 wiki_protocol = "http"
153 wiki_server = "server"
154 wiki_path = "/wiki/"
155 wiki_user = "login"
156 wiki_password = "1234"
157
158 # Only set this to true when running a repository where you want to generate
159 # stats, and only then on the master build servers, not a development
160 # machine.
161 update_stats = False
162
163 # Use the following to push stats to a Carbon instance:
164 stats_to_carbon = False
165 carbon_host = '0.0.0.0'
166 carbon_port = 2003
167
168 # Set this to true to always use a build server. This saves specifying the
169 # --server option on dedicated secure build server hosts.
170 build_server_always = False
171
172 # Limit in number of characters that fields can take up
173 # Only the fields listed here are supported, defaults shown
174 char_limits = {
175     'Summary': 50,
176     'Description': 1500
177 }