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 = "21.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 repository.
  53 """
  54
  55 # `fdroid update` will create a link to the current version of a given app.
  56 # This provides a static path to the current APK.  To disable the creation of
  57 # this link, uncomment this:
  58 # make_current_version_link = False
  59
  60 # By default, the "current version" link will be based on the "Name" of the
  61 # app from the metadata.  You can change it to use a different field from the
  62 # metadata here:
  63 # current_version_name_source = 'id'
  64
  65 # The ID of a GPG key for making detached signatures for apks. Optional.
  66 # gpgkey = '1DBA2E89'
  67
  68 # The key (from the keystore defined below) to be used for signing the
  69 # repository itself.  This is the same name you would give to keytool or
  70 # jarsigner using -alias.  (Not needed in an unsigned repository).
  71 # repo_keyalias = "fdroidrepo"
  72
  73 # The keystore to use for release keys when building. This needs to be
  74 # somewhere safe and secure, and backed up!  The best way to manage these
  75 # sensitive keys is to use a "smartcard" (aka Hardware Security Module). To
  76 # configure FDroid to use a smartcard, set the keystore file using the keyword
  77 # "NONE" (i.e. keystore = "NONE").  That makes Java find the keystore on the
  78 # smartcard based on 'smartcardoptions' below.
  79 # keystore = "~/.local/share/fdroidserver/keystore.jks"
  80
  81 # You should not need to change these at all, unless you have a very
  82 # customized setup for using smartcards in Java with keytool/jarsigner
  83 # smartcardoptions = "-storetype PKCS11 -providerName SunPKCS11-OpenSC \
  84 #    -providerClass sun.security.pkcs11.SunPKCS11 \
  85 #    -providerArg opensc-fdroid.cfg"
  86
  87 # The password for the keystore (at least 6 characters).  If this password is
  88 # different than the keypass below, it can be OK to store the password in this
  89 # file for real use.  But in general, sensitive passwords should not be stored
  90 # in text files!
  91 # keystorepass = "password1"
  92
  93 # The password for keys - the same is used for each auto-generated key as well
  94 # as for the repository key.  You should not normally store this password in a
  95 # file since it is a sensitive password.
  96 # keypass = "password2"
  97
  98 # The distinguished name used for all keys.
  99 keydname = "CN=Birdman, OU=Cell, O=Alcatraz, L=Alcatraz, S=California, C=US"
 100
 101 # Use this to override the auto-generated key aliases with specific ones
 102 # for particular applications. Normally, just leave it empty.
 103 keyaliases = {}
 104 keyaliases['com.example.app'] = 'example'
 105 # You can also force an app to use the same key alias as another one, using
 106 # the @ prefix.
 107 keyaliases['com.example.another.plugin'] = '@com.example.another'
 108
 109
 110 # The full path to the root of the repository.  It must be specified in
 111 # rsync/ssh format for a remote host/path. This is used for syncing a locally
 112 # generated repo to the server that is it hosted on.  It must end in the
 113 # standard public repo name of "/fdroid", but can be in up to three levels of
 114 # sub-directories (i.e. /var/www/packagerepos/fdroid).  You can include
 115 # multiple servers to sync to by wrapping the whole thing in {} or [], and
 116 # including the serverwebroot strings in a comma-separated list.
 117 #
 118 # serverwebroot = 'user@example:/var/www/fdroid'
 119 # serverwebroot = {
 120 #     'foo.com:/usr/share/nginx/www/fdroid',
 121 #     'bar.info:/var/www/fdroid',
 122 #     }
 123
 124
 125 # optionally specific which identity file to use when using rsync over SSH
 126 #
 127 # identity_file = '~/.ssh/fdroid_id_rsa'
 128
 129
 130 # If you are running the repo signing process on a completely offline machine,
 131 # which provides the best security, then you can specify a folder to sync the
 132 # repo to when running `fdroid server update`.  This is most likely going to
 133 # be a USB thumb drive, SD Card, or some other kind of removable media.  Make
 134 # sure it is mounted before running `fdroid server update`.  Using the
 135 # standard folder called 'fdroid' as the specified folder is recommended, like
 136 # with serverwebroot.
 137 #
 138 # local_copy_dir = '/media/MyUSBThumbDrive/fdroid'
 139
 140
 141 # If you are using local_copy_dir on an offline build/signing server, once the
 142 # thumb drive has been plugged into the online machine, it will need to be
 143 # synced to the copy on the online machine.  To make that happen
 144 # automatically, set sync_from_local_copy_dir to True:
 145 #
 146 # sync_from_local_copy_dir = True
 147
 148
 149 # To upload the repo to an Amazon S3 bucket using `fdroid server update`.
 150 # Warning, this deletes and recreates the whole fdroid/ directory each
 151 # time. This is based on apache-libcloud, which supports basically all cloud
 152 # storage services, so it should be easy to port the fdroid server tools to
 153 # any of them.
 154 #
 155 # awsbucket = 'myawsfdroid'
 156 # awsaccesskeyid = 'SEE0CHAITHEIMAUR2USA'
 157 # awssecretkey = 'yourverysecretkeywordpassphraserighthere'
 158
 159
 160 # If you want to force 'fdroid server' to use a non-standard serverwebroot
 161 #
 162 # nonstandardwebroot = False
 163
 164
 165 # Wiki details
 166 wiki_protocol = "http"
 167 wiki_server = "server"
 168 wiki_path = "/wiki/"
 169 wiki_user = "login"
 170 wiki_password = "1234"
 171
 172 # Only set this to true when running a repository where you want to generate
 173 # stats, and only then on the master build servers, not a development
 174 # machine.
 175 update_stats = False
 176
 177 # When used with stats, this is a list of IP addresses that are ignored for
 178 # calculation purposes.
 179 stats_ignore = []
 180
 181 # Server stats logs are retrieved from. Required when update_stats is True.
 182 stats_server = "example.com"
 183
 184 # User stats logs are retrieved from. Required when update_stats is True.
 185 stats_user = "bob"
 186
 187 # Use the following to push stats to a Carbon instance:
 188 stats_to_carbon = False
 189 carbon_host = '0.0.0.0'
 190 carbon_port = 2003
 191
 192 # Set this to true to always use a build server. This saves specifying the
 193 # --server option on dedicated secure build server hosts.
 194 build_server_always = False
 195
 196 # Limit in number of characters that fields can take up
 197 # Only the fields listed here are supported, defaults shown
 198 char_limits = {
 199     'Summary': 50,
 200     'Description': 1500
 201 }