1 \input texinfo @c -*-texinfo-*-
3 @setfilename fdroid.info
4 @documentencoding UTF-8
5 @settitle F-Droid Server Manual
9 This manual is for the F-Droid repository server tools.
11 Copyright @copyright{} 2010, 2011, 2012, 2013 Ciaran Gultnieks
13 Copyright @copyright{} 2011 Henrik Tunedal, Michael Haas, John Sullivan
15 Copyright @copyright{} 2013 David Black
17 Copyright @copyright{} 2013, 2014 Daniel MartÃ
20 Permission is granted to copy, distribute and/or modify this document
21 under the terms of the GNU Free Documentation License, Version 1.3
22 or any later version published by the Free Software Foundation;
23 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
24 A copy of the license is included in the section entitled "GNU
25 Free Documentation License".
30 @title F-Droid Server Manual
31 @author Ciaran Gultnieks and the F-Droid project
33 @vskip 0pt plus 1filll
49 * System Requirements::
51 * Simple Binary Repository::
52 * Building Applications::
53 * Importing Applications::
58 * GNU Free Documentation License::
65 The F-Droid server tools provide various scripts and tools that are used
66 to maintain the main F-Droid application repository. You can use these same
67 tools to create your own additional or alternative repository for publishing,
68 or to assist in creating, testing and submitting metadata to the main
72 @node System Requirements
73 @chapter System Requirements
77 The system requirements for using the tools will vary depending on your
78 intended usage. At the very least, you'll need:
86 The Android SDK Tools and Build-tools.
87 Note that F-Droid does not assume that you have the Android SDK in your
88 @code{PATH}: these directories will be specified in your repository
89 configuration. Recent revisions of the SDK have @code{aapt} located in
90 android-sdk/build-tools/ and it may be necessary to make a symlink to it in
91 android-sdk/platform-tools/
94 If you intend to build applications from source you'll also need most, if not
95 all, of the following:
99 JDK (Debian package openjdk-6-jdk): openjdk-6 is recommended though openjdk-7
102 VCS clients: svn, git, git-svn, hg, bzr
104 A keystore for holding release keys. (Safe, secure and well backed up!)
107 If you intend to use the 'Build Server' system, for secure and clean builds
108 (highly recommended), you will also need:
112 VirtualBox (debian package virtualbox)
114 Ruby (debian packages ruby and rubygems)
116 Vagrant (unpackaged, tested on v1.4.3)
118 Paramiko (debian package python-paramiko)
120 Imaging (debian package python-imaging)
122 Magic (debian package python-magic)
125 On the other hand, if you want to build the apps directly on your system
126 without the 'Build Server' system, you may need:
130 All SDK platforms requested by the apps you want to build
131 (The Android SDK is made available by Google under a proprietary license but
132 within that, the SDK platforms, support library and some other components are
133 under the Apache license and source code is provided.
134 Google APIs, used for building apps using Google Maps, are free to the extent
135 that the library comes pre-installed on the device.
136 Google Play Services, Google Admob and others are proprietary and shouldn't be
137 included in the main F-Droid repository.)
139 A version of the Android NDK
141 Ant with Contrib Tasks (Debian packages ant and ant-contrib)
143 Maven (Debian package maven)
145 JavaCC (Debian package javacc)
147 Miscellaneous packages listed in
148 buildserver/cookbooks/fdroidbuild-general/recipes/default.rb
149 of the F-Droid server repository
155 @cindex setup, installation
157 Because the tools and data will always change rapidly, you will almost
158 certainly want to work from a git clone of the tools at this stage. To
162 git clone https://gitlab.com/fdroid/fdroidserver.git
165 You now have lots of stuff in the fdroidserver directory, but the most
166 important is the 'fdroid' command script which you run to perform all tasks.
167 This script is always run from a repository data directory, so the
168 most sensible thing to do next is to put your new fdroidserver directory
173 To do anything, you'll need at least one repository data directory. It's
174 from this directory that you run the @code{fdroid} command to perform all
175 repository management tasks. You can either create a brand new one, or
176 grab a copy of the data used by the main F-Droid repository:
179 git clone https://gitlab.com/fdroid/fdroiddata.git
182 Regardless of the intended usage of the tools, you will always need to set
183 up some basic configuration details. This is done by creating a file called
184 @code{config.py} in the data directory. You should do this by copying the
185 example file (@code{./examples/config.py}) from the fdroidserver project to
186 your data directory and then editing according to the instructions within.
188 Once configured in this way, all the functionality of the tools is accessed
189 by running the @code{fdroid} command. Run it on its own to get a list of the
190 available sub-commands.
192 You can follow any command with @code{--help} to get a list of additional
193 options available for that command.
200 @node Simple Binary Repository
201 @chapter Simple Binary Repository
205 If you want to maintain a simple repository hosting only binary APKs obtained
206 and compiled elsewhere, the process is quite simple:
210 Set up the server tools, as described in Setup.
212 Make a directory for your repository. This is the directory from which you
213 will do all the work with your repository. Create a config file there, called
214 @code{config.py}, by copying @code{./examples/config.py} from the server
215 project and editing it.
217 Within that, make a directory called @code{repo} and put APK files in it.
219 Run @code{fdroid update}.
221 If it reports that any metadata files are missing, you can create them
222 in the @code{metadata} directory and run it again.
224 To ease creation of metadata files, run @code{fdroid update} with the @code{-c}
225 option. It will create 'skeleton' metadata files that are missing, and you can
226 then just edit them and fill in the details.
228 Then, if you've changed things, run @code{fdroid update} again.
230 Running @code{fdroid update} adds an Icons directory into the repo directory,
231 and also creates the repository index (index.xml, and also index.jar if you've
232 configured the system to use a signed index).
234 Publish the resulting contents of the @code{repo} directory to your web server.
237 Following the above process will result in a @code{repo} directory, which you
238 simply need to push to any HTTP (or preferably HTTPS) server to make it
241 While some information about the applications (and versions thereof) is
242 retrieved directly from the APK files, most comes from the corresponding file
243 in the @code{metadata} directory. The metadata file covering ALL versions of a
244 particular application is named @code{package.id.txt} where package.id is the
245 unique identifier for that package.
247 See the Metadata chapter for details of what goes in the metadata file. All
248 fields are relevant for binary APKs, EXCEPT for @code{Build:} entries, which
252 @node Building Applications
253 @chapter Building Applications
255 Instead of (or as well as) including binary APKs from external sources in a
256 repository, you can build them directly from the source code.
258 Using this method, it is is possible to verify that the application builds
259 correctly, corresponds to the source code, and contains only free software.
260 Unforunately, in the Android world, it seems to be very common for an
261 application supplied as a binary APK to present itself as Free Software
262 when in fact some or all of the following are true:
266 The source code (either for a particular version, or even all versions!) is
267 unavailable or incomplete.
269 The source code is not capable of producing the actual binary supplied.
271 The 'source code' contains binary files of unknown origin, or with proprietary
275 For this reason, source-built applications are the preferred method for the
276 main F-Droid repository, although occasionally for technical or historical
277 reasons, exceptions are made to this policy.
279 When building applications from source, it should be noted that you will be
280 signing them (all APK files must be signed to be installable on Android) with
281 your own key. When an application is already installed on a device, it is not
282 possible to upgrade it in place to a new version signed with a different key
283 without first uninstalling the original. This may present an inconvenience to
284 users, as the process of uninstalling loses any data associated with the
285 previous installation.
287 The process for managing a repository for built-from-source applications is
288 very similar to that described in the Simple Binary Repository chapter,
289 except now you need to:
293 Include Build entries in the metadata files.
295 Run @code{fdroid build} to build any applications that are not already built.
297 Run @code{fdroid publish} to finalise packaging and sign any APKs that have
302 @section More about "fdroid build"
304 When run without any parameters, @code{fdroid build} will build any and all
305 versions of applications that you don't already have in the @code{repo}
306 directory (or more accurately, the @code{unsigned} directory). There are various
307 other things you can do. As with all the tools, the @code{--help} option is
308 your friend, but a few annotated examples and discussion of the more common
311 To build a single version of a single application, you could run the
315 ./fdroid build org.fdroid.fdroid:16
318 This attempts to build version code 16 (which is version 0.25) of the F-Droid
319 client. Many of the tools recognise arguments as packages, allowing their
320 activity to be limited to just a limited set of packages.
322 If the build above was successful, two files will have been placed in the
323 @code{unsigned} directory:
326 org.fdroid.fdroid_16.apk
327 org.fdroid.fdroid_16_src.tar.gz
330 The first is the (unsigned) APK. You could sign this with a debug key and push
331 it direct to your device or an emulator for testing. The second is a source
332 tarball containing exactly the source that was used to generate the binary.
334 If you were intending to publish these files, you could then run:
340 The source tarball would move to the @code{repo} directory (which is the
341 directory you would push to your web server). A signed and zip-aligned version
342 of the APK would also appear there, and both files would be removed from the
343 @code{unsigned} directory.
345 If you're building purely for the purposes of testing, and not intending to
346 push the results to a repository, at least yet, the @code{--test} option can be
347 used to direct output to the @code{tmp} directory instead of @code{unsigned}.
348 A similar effect could by achieved by simply deleting the output files from
349 @code{unsigned} after the build, but with the risk of forgetting to do so!
351 Along similar lines (and only in conjunction with @code{--test}, you can use
352 @code{--force} to force a build of a Disabled application, where normally it
353 would be completely ignored. Similarly a version that was found to contain
354 ELFs or known non-free libraries can be forced to build. See also —
355 @code{scanignore=} and @code{scandelete=} in the @code{Build:} section.
357 If the build was unsuccessful, you can find out why by looking at the output
358 in the logs/ directory. If that isn't illuminating, try building the app the
359 regular way, step by step: android update project, ndk-build, ant debug.
361 Note that source code repositories often contain prebuilt libraries. If the
362 app is being considered for the main F-Droid repository, it is important that
363 all such prebuilts are built either via the metadata or by a reputable third
367 @section Direct Installation
369 You can also build and install directly to a connected device or emulator
370 using the @code{fdroid install} command. If you do this without passing
371 packages as arguments then all the latest built and signed version available
372 of each package will be installed . In most cases, this will not be what you
373 want to do, so execution will stop straight away. However, you can override
374 this if you're sure that's what you want, by using @code{--all}. Note that
375 currently, no sanity checks are performed with this mode, so if the files in
376 the signed output directory were modified, you won't be notified.
379 @node Importing Applications
380 @chapter Importing Applications
382 To help with starting work on including a new application, @code{fdroid import}
383 will take a URL and optionally some other parameters, and attempt to construct
384 as much information as possible by analysing the source code. Basic usage is:
387 ./fdroid import --url=http://address.of.project
390 For this to work, the URL must point to a project format that the script
391 understands. Currently this is limited to one of the following:
395 Gitorious - @code{https://gitorious.org/PROJECTNAME/REPONAME}
397 Github - @code{https://github.com/USER/PROJECT}
399 Google Code - @code{http://code.google.com/p/PROJECT/}
400 Supports git, svn and hg repos.
402 Some Google Code projects have multiple repositories, identified by a
403 dropdown list on the @code{source/checkout} page. To access one other than
404 the default, specify its name using the @code{--repo} switch.
406 Bitbucket - @code{https://bitbucket.org/USER/PROJECT/}
408 Git - @code{git://REPO}
411 Depending on the project type, more or less information may be gathered. For
412 example, the license will be retrieved from a Google Code project, but not a
413 GitHub one. A bare repo url, such as the git:// one, is the least preferable
414 optional of all, since you will have to enter much more information manually.
416 If the import is successful, a metadata file will be created. You will need to
417 edit this further to check the information, and fill in the blanks.
419 If it fails, you'll be told why. If it got as far as retrieving the source
420 code, you can inspect it further by looking in @code{tmp/importer} where a full
423 A frequent cause of initial failure is that the project directory is actually
424 a subdirectory in the repository. In this case, run the importer again using
425 the @code{--subdir} option to tell it where. It will not attempt to determine
426 this automatically, since there may be several options.
434 Information used by update.py to compile the public index comes from two
439 the APK files in the repo directory, and
441 the metadata files in the metadata directory.
444 The metadata files are simple, easy to edit text files, always named as the
445 application's package ID with '.txt' appended.
447 Note that although the metadata files are designed to be easily read and
448 writable by humans, they are also processed and written by various scripts.
449 They are capable of rewriting the entire file when necessary. Even so,
450 the structure and comments will be preserved correctly, although the order
451 of fields will be standardised. (In the event that the original file was
452 in a different order, comments are considered as being attached to the field
453 following them). In fact, you can standardise all the metadata in a single
454 command, without changing the functional content, by running:
457 fdroid rewritemetadata
460 The following sections describe the fields recognised within the file.
485 * Update Check Mode::
486 * Update Check Ignore::
487 * Vercode Operation::
488 * Update Check Name::
489 * Update Check Data::
492 * Current Version Code::
499 Any number of categories for the application to be placed in. There is no
500 fixed list of categories - both the client and the web site will automatically
501 show any categories that exist in any applications. However, if your metadata
502 is intended for the main F-Droid repository, you should use one of the
503 existing categories (look at the site/client), or discuss the proposal to add
506 Categories must be separated by a single comma character, ','. For backwards
507 compatibility, F-Droid will use the first category given as <category> element
508 for older clients to at least see one category.
510 This is converted to (@code{<categories>}) in the public index file.
517 The overall license for the application, or in certain cases, for the
530 GNU GPL version 2 or later
538 GNU GPL version 3 or later
542 An unspecified GPL version. Use this only as a last resort or if there is
543 some confusion over compatiblity of component licenses: particularly the use of
544 Apache libraries with GPLv2 source code.
548 Afferro GPL version 3.
560 BSD license - the original '4-clause' version.
564 BSD license - the new, or modified, version.
568 This is converted to (@code{<license>}) in the public index file.
575 The name of the application as can best be retrieved from the source code.
576 This is done so that the commitupdates script can put a familiar name in the
577 description of commits created when a new update of the application is
578 found. The Auto Name entry is generated automatically when @code{fdroid
579 checkupdates} is run.
586 The name of the application. Normally, this field should not be present since
587 the application's correct name is retrieved from the APK file. However, in a
588 situation where an APK contains a bad or missing application name, it can be
589 overridden using this. Note that this only overrides the name in the list of
590 apps presented in the client; it doesn't changed the name or application label
598 Comma-separated list of application IDs that this app provides. In other
599 words, if the user has any of these apps installed, F-Droid will show this app
600 as installed instead. It will also appear if the user clicks on urls linking
601 to the other app IDs. Useful when an app switches package name, or when you
602 want an app to act as multiple apps.
609 The URL for the application's web site. If there is no relevant web site, this
610 can be omitted (or left blank).
612 This is converted to (@code{<web>}) in the public index file.
619 The URL to view or obtain the application's source code. This should be
620 something human-friendly. Machine-readable source-code is covered in the
623 This is converted to (@code{<source>}) in the public index file.
626 @section Issue Tracker
628 @cindex Issue Tracker
630 The URL for the application's issue tracker. Optional, since not all
631 applications have one.
633 This is converted to (@code{<tracker>}) in the public index file.
640 The URL to donate to the project. This should be the project's donate page
643 It is possible to use a direct PayPal link here, if that is all that is
644 available. However, bear in mind that the developer may not be aware of
645 that direct link, and if they later changed to a different PayPal account,
646 or the PayPal link format changed, things could go wrong. It is always
647 best to use a link that the developer explicitly makes public, rather than
648 something that is auto-generated 'button code'.
650 This is converted to (@code{<donate>}) in the public index file.
657 The project's Flattr (http://flattr.com) ID, if it has one. This should be
658 a numeric ID, such that (for example) https://flattr.com/thing/xxxx leads
659 directly to the page to donate to the project.
661 This is converted to (@code{<flattr>}) in the public index file.
668 A bitcoin address for donating to the project.
670 This is converted to (@code{<bitcoin>}) in the public index file.
677 A litecoin address for donating to the project.
684 A brief summary of what the application is. Since the summary is only allowed
685 one line on the list of the F-Droid client, keeping it to within 50 characters
686 will ensure it fits most screens.
693 A full description of the application, relevant to the latest version.
694 This can span multiple lines (which should be kept to a maximum of 80
695 characters), and is terminated by a line containing a single '.'.
697 Basic MediaWiki-style formatting can be used. Leaving a blank line starts a
698 new paragraph. Surrounding text with @code{''} make it italic, and with
699 @code{'''} makes it bold.
701 You can link to another app in the repo by using @code{[[app.id]]}. The link
702 will be made appropriately whether in the Android client, the web repo
703 browser or the wiki. The link text will be the apps name.
705 Links to web addresses can be done using @code{[http://example.com Text]}.
707 For both of the above link formats, the entire link (from opening to closing
708 square bracket) must be on the same line.
710 Bulletted lists are done by simply starting each item with a @code{*} on
711 a new line, and numbered lists are the same but using @code{#}. There is
712 currently no support for nesting lists - you can have one level only.
714 It can be helpful to note information pertaining to updating from an
715 earlier version; whether the app contains any prebuilts built by the
716 upstream developers or whether non-free elements were removed; whether the
717 app is in rapid development or whether the latest version lags behind the
718 current version; whether the app supports multiple architectures or whether
719 there is a maximum SDK specified (such info not being recorded in the index).
721 This is converted to (@code{<desc>}) in the public index file.
723 @node Maintainer Notes
724 @section Maintainer Notes
726 @cindex Maintainer Notes
728 This is a multi-line field using the same rules and syntax as the description.
729 It's used to record notes for F-Droid maintainers to assist in maintaining and
730 updating the application in the repository.
732 This information is also published to the wiki.
739 The type of repository - for automatic building from source. If this is not
740 specified, automatic building is disabled for this application. Possible
762 The repository location. Usually a git: or svn: URL, for example.
764 The git-svn option connects to an SVN repository, and you specify the URL in
765 exactly the same way, but git is used as a back-end. This is preferable for
766 performance reasons, and also because a local copy of the entire history is
767 available in case the upstream repository disappears. (It happens!). In
768 order to use Tags as update check mode for this VCS type, the URL must have
769 the tags= special argument set. Likewise, if you intend to use the
770 RepoManifest/branch scheme, you would want to specify branches= as well.
771 Finally, trunk= can also be added. All these special arguments will be passed
772 to "git svn" in order, and their values must be relative paths to the svn repo
774 Here's an example of a complex git-svn Repo URL:
775 http://svn.code.sf.net/p/project/code/svn;trunk=trunk;tags=tags;branches=branches
777 If the Repo Type is @code{srclib}, then you must specify the name of the
778 according srclib .txt file. For example if @code{scrlibs/FooBar.txt} exist
779 and you want to use this srclib, then you have to set Repo to
787 Any number of these fields can be present, each specifying a version to
788 automatically build from source. The value is a comma-separated list.
793 The above specifies to build version 1.2, which has a version code of 12.
794 The @code{commit=} parameter specifies the tag, commit or revision number from
795 which to build it in the source repository. It is the only mandatory flag,
796 which in this case could for example be @code{commit=v1.2}.
798 In addition to the three, always required, parameters described above,
799 further parameters can be added (in name=value format) to apply further
800 configuration to the build. These are (roughly in order of application):
804 @item disable=<message>
805 Disables this build, giving a reason why. (For backwards compatibility, this
806 can also be achieved by starting the commit ID with '!')
808 The purpose of this feature is to allow non-buildable releases (e.g. the source
809 is not published) to be flagged, so the scripts don't generate repeated
810 messages about them. (And also to record the information for review later).
811 If an apk has already been built, disabling causes it to be deleted once
812 @code{fdroid update} is run; this is the procedure if ever a version has to
816 Specifies to build from a subdirectory of the checked out source code.
817 Normally this directory is changed to before building,
820 Use if the project (git only) has submodules - causes @code{git submodule
821 update --init --recursive} to be executed after the source is cloned.
822 Submodules are reset and cleaned like the main app repository itself before
826 As for 'prebuild', but runs on the source code BEFORE any other processing
829 You can use $$SDK$$, $$NDK$$ and $$MVN3$$ to substitute the paths to the
830 android SDK and NDK directories, and maven 3 executable respectively.
833 The sdk location in the repo is in an old format, or the build.xml is
834 expecting such. The 'new' format is sdk.dir while the VERY OLD format
835 is sdk-location. Typically, if you get a message along the lines of:
836 "com.android.ant.SetupTask cannot be found" when trying to build, then
837 try enabling this option.
839 @item target=<target>
840 Specifies a particular SDK target for compilation, overriding the value
841 defined in the code by upstream. This has different effects depending on what
842 build system used — this flag currently affects Ant, Maven and Gradle projects
843 only. Note that this does not change the target SDK in the
844 AndroidManifest.xml, which determines the level of features that can be
845 included in the build.
847 In the case of an Ant project, it modifies project.properties of the app and
848 possibly sub-projects. This is likely to cause the whole build.xml to be
849 rewritten, which is fine if it's a 'standard' android file or doesn't already
850 exist, but not a good idea if it's heavily customised.
852 @item update=<auto/dirs>
853 By default, 'android update' is used in Ant builds to generate or update the
854 project and all its referenced projects. Specifying update=no bypasses that.
855 Note that this is useless in builds that don't use Ant.
857 Default value is '@code{auto}', which recursively uses the paths in
858 project.properties to find all the subprojects to update.
860 Otherwise, the value can be a comma-separated list of directories in which to
861 run 'android update' relative to the application directory.
864 Adds a java.encoding property to local.properties with the given
865 value. Generally the value will be 'utf-8'. This is picked up by the
866 SDK's ant rules, and forces the Java compiler to interpret source
867 files with this encoding. If you receive warnings during the compile
868 about character encodings, you probably need this.
870 @item forceversion=yes
871 If specified, the package version in AndroidManifest.xml is replaced
872 with the version name for the build as specified in the metadata.
874 This is useful for cases when upstream repo failed to update it for
875 specific tag; to build an arbitrary revision; to make it apparent that
876 the version differs significantly from upstream; or to make it apparent
877 which architecture or platform the apk is designed to run on.
879 @item forcevercode=yes
880 If specified, the package version code in the AndroidManifest.xml is
881 replaced with the version code for the build. See also forceversion.
883 @item rm=<path1>[,<path2>,...]
884 Specifies the relative paths of files or directories to delete before
885 the build is done. The paths are relative to the base of the build
886 directory - i.e. the root of the directory structure checked out from
887 the source respository - not necessarily the directory that contains
890 Multiple files/directories can be specified by separating them with ','.
891 Directories will be recursively deleted.
893 @item extlibs=<lib1>[,<lib2>,...]
894 Comma-separated list of external libraries (jar files) from the
895 @code{build/extlib} library, which will be placed in the @code{libs} directory
898 @item srclibs=[n:]a@@r,[n:]b@@r1,...
899 Comma-separated list of source libraries or Android projects. Each item is of
900 the form name@@rev where name is the predefined source library name and rev is
901 the revision or tag to use in the respective source control.
903 For Ant projects, you can optionally append a number with a colon at the
904 beginning of a srclib item to automatically place it in project.properties as
905 a library under the specified number. For example, if you specify
906 @code{1:somelib@@1.0}, f-droid will automatically do the equivalent of the
907 legacy practice @code{prebuild=echo "android.library.reference.1=$$somelib$$"
908 >> project.properties}.
910 Each srclib has a metadata file under srclibs/ in the repository directory,
911 and the source code is stored in build/srclib/.
912 Repo Type: and Repo: are specified in the same way as for apps; Subdir: can be
913 a comma separated list, for when directories are renamed by upstream; Update
914 Project: updates the projects in the working directory and one level down;
915 Prepare: can be used for any kind of preparation: in particular if you need to
916 update the project with a particular target. You can then also use $$name$$ in
917 the init/prebuild/build command to substitute the relative path to the library
918 directory, but it could need tweaking if you've changed into another directory.
921 Apply patch(es). 'x' names one (or more - comma-seperated) files within a
922 directory below the metadata, with the same name as the metadata file but
923 without the extension. Each of these patches is applied to the code in turn.
926 Specifies a shell command (or commands - chain with &&) to run before the
927 build takes place. Backslash can be used as an escape character to insert
928 literal commas, or as the last character on a line to join that line with the
929 next. It has no special meaning in other contexts; in particular, literal
930 backslashes should not be escaped.
932 The command runs using bash.
934 Note that nothing should be built during this prebuild phase - scanning of the
935 code and building of the source tarball, for example, take place after this.
936 For custom actions that actually build things or produce binaries, use 'build'
939 You can use $$name$$ to substitute the path to a referenced srclib - see
940 the @code{srclib} directory for details of this.
942 You can use $$SDK$$, $$NDK$$ and $$MVN3$$ to substitute the paths to the
943 android SDK and NDK directories, and Maven 3 executable respectively e.g.
944 for when you need to run @code{android update project} explicitly.
946 @item scanignore=<path1>[,<path2>,...]
947 Enables one or more files/paths to be excluded from the scan process.
948 This should only be used where there is a very good reason, and
949 probably accompanied by a comment explaining why it is necessary.
951 When scanning the source tree for problems, matching files whose relative
952 paths start with any of the paths given here are ignored.
954 @item scandelete=<path1>[,<path2>,...]
955 Similar to scanignore=, but instead of ignoring files under the given paths,
956 it tells f-droid to delete the matching files directly.
959 As for 'prebuild', but runs during the actual build phase (but before the
960 main Ant/Maven build). Use this only for actions that do actual building.
961 Any prepartion of the source code should be done using 'init' or 'prebuild'.
963 Any building that takes place before build= will be ignored, as either Ant,
964 mvn or gradle will be executed to clean the build environment right before
965 build= (or the final build) is run.
967 You can use $$SDK$$, $$NDK$$ and $$MVN3$$ to substitute the paths to the
968 android SDK and NDK directories, and Maven 3 executable respectively.
970 @item buildjni=[yes|no|<dir list>]
971 Enables building of native code via the ndk-build script before doing
972 the main Ant build. The value may be a list of directories relative
973 to the main application directory in which to run ndk-build, or 'yes'
974 which corresponds to '.' . Using explicit list may be useful to build
975 multi-component projects.
977 The build and scan processes will complain (refuse to build) if this
978 parameter is not defined, but there is a @code{jni} directory present.
979 If the native code is being built by other means like a Gradle task, you
980 can specify @code{no} here to avoid that. However, if the native code is
981 actually not required or used, remove the directory instead (using
982 @code{rm=jni} for example). Using @code{buildjni=no} when the jni code
983 isn't used nor built will result in an error saying that native
984 libraries were expected in the resulting package.
987 Version of the NDK to use in this build. Defaults to the latest NDK release
988 that included legacy toolchains, so as to not break builds that require
989 toolchains no longer included in current versions of the NDK.
991 The buildserver supports r9b with its legacy toolchains and the latest release
992 as of writing this document, r10d. You may add support for more versions by
993 adding them to 'ndk_paths' in your config file.
995 @item gradle=<flavour1>[,<flavour2>,...]
996 Build with Gradle instead of Ant, specifying what flavours to use. Flavours
997 are case sensitive since the path to the output apk is as well.
999 If only one flavour is given and it is 'yes' or 'main', no flavour will be
1000 used. Note that for projects with flavours, you must specify at least one
1001 valid flavour since 'yes' or 'main' will build all of them separately.
1003 @item maven=yes[@@<dir>]
1004 Build with Maven instead of Ant. An extra @@<dir> tells f-droid to run Maven
1005 inside that relative subdirectory. Sometimes it is needed to use @@.. so that
1006 builds happen correctly.
1008 @item preassemble=<task1>[,<task2>,...]
1009 List of Gradle tasks to be run before the assemble task in a Gradle project
1012 @item antcommands=<target1>[,<target2>,...]
1013 Specify an alternate set of Ant commands (target) instead of the default
1014 'release'. It can't be given any flags, such as the path to a build.xml.
1016 @item output=path/to/output.apk
1017 To be used when app is built with a tool other than the ones natively
1018 supported, like GNU Make. The given path will be where the build= set of
1019 commands should produce the final unsigned release apk.
1022 Don't check that the version name and code in the resulting apk are
1023 correct by looking at the build output - assume the metadata is
1024 correct. This takes away a useful level of sanity checking, and should
1025 only be used if the values can't be extracted.
1029 Another example, using extra parameters:
1031 @samp{Build Version:1.09.03,10903,45,subdir=Timeriffic,oldsdkloc=yes}
1034 @section AntiFeatures
1036 @cindex AntiFeatures
1038 This is optional - if present, it contains a comma-separated list of any of
1039 the following values, describing an anti-feature the application has.
1040 It is a good idea to mention the reasons for the anti-feature(s) in the
1046 @samp{Ads} - the application contains advertising.
1049 @samp{Tracking} - the application tracks and reports your activity to
1050 somewhere without your consent. It's commonly used for when developers
1051 obtain crash logs without the user's consent, or when an app is useless
1052 without some kind of authentication.
1055 @samp{NonFreeNet} - the application relies on computational services that
1056 are impossible to replace or that the replacement cannot be connected to
1057 without major changes to the app.
1060 @samp{NonFreeAdd} - the application promotes non-free add-ons, such that the
1061 app is effectively an advert for other non-free software and such software is
1062 not clearly labelled as such.
1065 @samp{NonFreeDep} - the application depends on a non-free application (e.g.
1066 Google Maps) - i.e. it requires it to be installed on the device, but does not
1070 @samp{UpstreamNonFree} - the application is or depends on non-free software.
1071 This does not mean that non-free software is included with the app: Most
1072 likely, it has been patched in some way to remove the non-free code. However,
1073 functionality may be missing.
1082 If this field is present, the application does not get put into the public
1083 index. This allows metadata to be retained while an application is temporarily
1084 disabled from being published. The value should be a description of why the
1085 application is disabled. No apks or source code archives are deleted: to purge
1086 an apk see the Build Version section or delete manually for developer builds.
1087 The field is therefore used when an app has outlived it's usefulness, because
1088 the source tarball is retained.
1091 @section Requires Root
1093 @cindex Requires Root
1095 Set this optional field to "Yes" if the application requires root
1096 privileges to be usable. This lets the client filter it out if the
1097 user so desires. Whether root is required or not, it is good to give
1098 a paragraph in the description to the conditions on which root may be
1099 asked for and the reason for it.
1101 @node Archive Policy
1102 @section Archive Policy
1104 @cindex Archive Policy
1106 This determines the policy for moving old versions of an app to the archive
1107 repo, if one is configured. The configuration sets a default maximum number
1108 of versions kept in the main repo, after which older ones are moved to the
1109 archive. This app-specific policy setting can override that.
1111 Currently the only supported format is "n versions", where n is the number
1112 of versions to keep.
1114 @node Update Check Mode
1115 @section Update Check Mode
1117 @cindex Update Check Mode
1119 This determines the method using for determining when new releases are
1120 available - in other words, the updating of the Current Version and Current
1121 Version Code fields in the metadata by the @code{fdroid checkupdates} process.
1127 @code{None} - No checking is done because there's no appropriate automated way
1128 of doing so. Updates should be checked for manually. Use this, for example,
1129 when deploying betas or patched versions; when builds are done in a directory
1130 different to where the AndroidManifest.xml is; if the developers use the
1131 Gradle build system and store version info in a separate file; if the
1132 developers make a new branch for each release and don't make tags; or if you've
1133 changed the package name or version code logic.
1135 @code{Static} - No checking is done - either development has ceased or new versions
1136 are not desired. This method is also used when there is no other checking method
1137 available and the upstream developer keeps us posted on new versions.
1139 @code{RepoManifest} - At the most recent commit, the AndroidManifest.xml file
1140 is looked for in the directory where it was found in the the most recent build.
1141 The appropriateness of this method depends on the development process used by
1142 the application's developers. You should not specify this method unless you're
1143 sure it's appropriate. For example, some developers bump the version when
1144 commencing development instead of when publishing.
1145 It will return an error if the AndroidManifest.xml has moved to a different
1146 directory or if the package name has changed.
1147 The current version that it gives may not be accurate, since not all
1148 versions are fit to be published. Therefore, before building, it is often
1149 necessary to check if the current version has been published somewhere by the
1150 upstream developers, either by checking for apks that they distribute or for
1151 tags in the source code repository.
1153 It currently works for every repository type to different extents, except
1154 the srclib repo type. For git, git-svn and hg repo types, you may use
1155 "RepoManifest/yourbranch" as UCM so that "yourbranch" would be the branch used
1156 in place of the default one. The default values are "master" for git,
1157 "default" for hg and none for git-svn (it stays in the same branch).
1158 On the other hand, branch support hasn't been implemented yet in bzr and svn,
1159 but RepoManifest may still be used without it.
1161 @code{RepoTrunk} - For svn and git-svn repositories, especially those who
1162 don't have a bundled AndroidManifest.xml file, the Tags and RepoManifest
1163 checks will not work, since there is no version information to obtain. But,
1164 for those apps who automate their build process with the commit ref that HEAD
1165 points to, RepoTrunk will set the Current Version and Current Version Code to
1168 @code{Tags} - The AndroidManifest.xml file in all tagged revisions in the
1169 source repository is checked, looking for the highest version code. The
1170 appropriateness of this method depends on the development process used by the
1171 application's developers. You should not specify this method unless you're sure
1172 it's appropriate. It shouldn't be used if the developers like to tag betas or
1173 are known to forget to tag releases. Like RepoManifest, it will not return the
1174 correct value if the directory containing the AndroidManifest.xml has moved.
1175 Despite these caveats, it is the often the favourite update check mode.
1177 It currently only works for git, hg, bzr and git-svn repositories. In the case
1178 of the latter, the repo URL must contain the path to the trunk and tags or
1179 else no tags will be found.
1181 Optionally append a regex pattern at the end - separated with a space - to
1182 only check the tags matching said pattern. Useful when apps tag non-release
1183 versions such as X.X-alpha, so you can filter them out with something like
1184 @code{.*[0-9]$} which requires tag names to end with a digit.
1186 @code{HTTP} - HTTP requests are used to determine the current version code and
1187 version name. This is controlled by the @code{Update Check Data} field, which
1188 is of the form @code{urlcode|excode|urlver|exver}.
1190 Firstly, if @code{urlcode} is non-empty, the document from that URL is
1191 retrieved, and matched against the regular expression @code{excode}, with the
1192 first group becoming the version code.
1194 Secondly, if @code{urlver} is non-empty, the document from that URL is
1195 retrieved, and matched against the regular expression @code{exver}, with the
1196 first group becoming the version name. The @code{urlver} field can be set to
1197 simply '.' which says to use the same document returned for the version code
1198 again, rather than retrieving a different one.
1201 @node Vercode Operation
1202 @section Vercode Operation
1204 @cindex Vercode Operation
1206 Operation to be applied to the vercode obtained by the defined @code{Update
1207 Check Mode}. @code{%c} will be replaced by the actual vercode, and the whole
1208 string will be passed to python's @code{eval} function.
1210 Especially useful with apps that we want to compile for different ABIs, but
1211 whose vercodes don't always have trailing zeros. For example, with
1212 @code{Vercode Operation} set at something like @code{%c*10 + 4}, we will be
1213 able to track updates and build up to four different versions of every
1216 @node Update Check Ignore
1217 @section Update Check Ignore
1219 @cindex Update Check Ignore
1221 When checking for updates (via @code{Update Check Mode}) this can be used to
1222 specify a regex which, if matched against the version name, causes that version
1223 to be ignored. For example, 'beta' could be specified to ignore version names
1224 that include that text.
1226 @node Update Check Name
1227 @section Update Check Name
1229 @cindex Update Check Name
1231 When checking for updates (via @code{Update Check Mode}) this can be used to
1232 specify the package name to search for. Useful when apps have a static package
1233 name but change it programmatically in some app flavors, by e.g. appending
1234 ".open" or ".free" at the end of the package name.
1236 @node Update Check Data
1237 @section Update Check Data
1239 @cindex Update Check Data
1241 Used in conjunction with @code{Update Check Mode} for certain modes.
1243 @node Auto Update Mode
1244 @section Auto Update Mode
1246 @cindex Auto Update Mode
1248 This determines the method using for auto-generating new builds when new
1249 releases are available - in other words, adding a new Build Version line to the
1251 This happens in conjunction with the 'Update Check Mode' functionality - i.e.
1252 when an update is detected by that, it is also processed by this.
1258 @code{None} - No auto-updating is done
1260 @code{Version} - Identifies the target commit (i.e. tag) for the new build based
1261 on the given version specification, which is simply text in which %v and %c are
1262 replaced with the required version name and version code respectively.
1264 For example, if an app always has a tag "2.7.2" corresponding to version 2.7.2,
1265 you would simply specify "Version %v". If an app always has a tag "ver_1234"
1266 for a version with version code 1234, you would specify "Version ver_%c".
1268 Additionally, a suffix can be added to the version name at this stage, to
1269 differentiate F-Droid's build from the original. Continuing the first example
1270 above, you would specify that as "Version +-fdroid %v" - "-fdroid" is the suffix.
1274 @node Current Version
1275 @section Current Version
1277 @cindex Current Version
1279 The name of the version that is current. There may be newer versions of the
1280 application than this (e.g. betas), and there will almost certainly be older
1281 ones. This should be the one that is recommended for general use.
1282 In the event that there is no source code for the current version, or that
1283 non-free libraries are being used, this would ideally be the latest
1284 version that is still free, though it may still be expedient to
1285 retain the automatic update check — see No Source Since.
1287 This field is normally automatically updated - see Update Check Mode.
1289 This is converted to (@code{<marketversion>}) in the public index file.
1291 @node Current Version Code
1292 @section Current Version Code
1294 @cindex Current Version Code
1296 The version code corresponding to the Current Version field. Both these fields
1297 must be correct and matching although it's the current version code that's
1298 used by Android to determine version order and by F-Droid client to determine
1299 which version should be recommended.
1301 This field is normally automatically updated - see Update Check Mode.
1303 This is converted to (@code{<marketvercode>}) in the public index file.
1305 @node No Source Since
1306 @section No Source Since
1308 @cindex No Source Since
1310 In case we are missing the source code for the Current Version reported by
1311 Upstream, or that non-free elements have been introduced, this defines the
1312 first version that began to miss source code.
1313 Apps that are missing source code for just one or a few versions, but provide
1314 source code for newer ones are not to be considered here - this field is
1315 intended to illustrate which apps do not currently distribute source code, and
1316 since when have they been doing so.
1318 @node Update Processing
1319 @chapter Update Processing
1323 There are various mechanisms in place for automatically detecting that updates
1324 are available for applications, with the @code{Update Check Mode} field in the
1325 metadata determining which method is used for a particular application.
1327 Running the @code{fdroid checkupdates} command will apply this method to each
1328 application in the repository and update the @code{Current Version} and
1329 @code{Current Version Code} fields in the metadata accordingly.
1331 As usual, the @code{-p} option can be used with this, to restrict processing
1332 to a particular application.
1334 Note that this only updates the metadata such that we know what the current
1335 published/recommended version is. It doesn't make that version available in
1336 the repository - for that, see the next section.
1340 Adding updates (i.e. new versions of applications already included in the
1341 repository) happens in two ways. The simple case is applications where the
1342 APK files are binaries, retrieved from a developer's published build. In this
1343 case, all that's required is to place the new binary in the @code{Repo}
1344 directory, and the next run of @code{fdroid update} will pick it up.
1346 For applications built from source, it is necessary to add a new
1347 @code{Build Version} line to the metadata file. At the very least, the version
1348 name, version code and commit will be different. It is also possible that the
1349 additional build flags will change between versions.
1351 For processing multiple updates in the metadata at once, it can be useful to
1352 run @code{fdroid update --interactive}. This will check all the applications
1353 in the repository, and where updates are required you will be prompted to
1354 [E]dit the metadata, [I]gnore the update, or [Q]uit altogether.
1357 @chapter Build Server
1359 The Build Server system isolates the builds for each package within a clean,
1360 isolated and secure throwaway virtual machine environment.
1364 Building applications in this manner on a large scale, especially with the
1365 involvement of automated and/or unattended processes, could be considered
1366 a dangerous pastime from a security perspective. This is even more the case
1367 when the products of the build are also distributed widely and in a
1368 semi-automated ("you have updates available") fashion.
1370 Assume that an upstream source repository is compromised. A small selection
1371 of things that an attacker could do in such a situation:
1375 Use custom Ant build steps to execute virtually anything as the user doing
1378 Access the keystore.
1380 Modify the built apk files or source tarballs for other applications in the
1383 Modify the metadata (which includes build scripts, which again, also includes
1384 the ability to execute anything) for other applications in the repository.
1387 Through complete isolation, the repurcussions are at least limited to the
1388 application in question. Not only is the build environment fresh for each
1389 build, and thrown away afterwards, but it is also isolated from the signing
1392 Aside from security issues, there are some applications which have strange
1393 requirements such as custom versions of the NDK. It would be impractical (or
1394 at least extremely messy) to start modifying and restoring the SDK on a
1395 multi-purpose system, but within the confines of a throwaway single-use
1396 virtual machine, anything is possible.
1398 All this is in addition to the obvious advantage of having a standardised
1399 and completely reproducible environment in which builds are made. Additionally,
1400 it allows for specialised custom build environments for particular
1403 @section Setting up a build server
1405 In addition to the basic setup previously described, you will also need
1406 a Vagrant-compatible Debian Testing base box called 'testing32' (or testing64
1407 for a 64-bit VM, if you want it to be much slower, and require more disk
1410 You can use a different version or distro for the base box, so long as you
1411 don't expect any help making it work. One thing to be aware of is that
1412 working copies of source trees are moved from the host to the guest, so
1413 for example, having subversion v1.6 on the host and v1.7 on the guest
1416 @subsection Creating the Debian base box
1418 The output of this step is a minimal Debian VM that has support for remote
1419 login and provisioning.
1421 Unless you're very trusting, you should create one of these for yourself
1422 from verified standard Debian installation media. However, by popular
1423 demand, the @code{makebuildserver} script will automatically download a
1424 prebuilt image unless instructed otherwise. If you choose to use the
1425 prebuilt image, you may safely skip the rest of this section.
1427 Documentation for creating a base box can be found at
1428 @url{http://docs.vagrantup.com/v1/docs/base_boxes.html}.
1430 In addition to carefully following the steps described there, you should
1431 consider the following:
1435 It is advisable to disable udev network device persistence, otherwise any
1436 movement of the VM between machines, or reconfiguration, will result in
1439 For a Debian/Ubuntu default install, just
1440 @code{touch /etc/udev/rules.d/75-persistent-net-generator.rules} to turn
1441 off rule generation, and at the same time, get rid of any rules it's
1442 already created in @code{/etc/udev/rules.d/70-persistent-net.rules}.
1444 Unless you want the VM to become totally inaccessible following a failed
1445 boot, you need to set @code{GRUB_RECORDFAIL_TIMEOUT} to a value other than
1446 -1 in @code{/etc/grub/default} and then run @code{update-grub}.
1449 @subsection Creating the F-Droid base box
1451 The next step in the process is to create @code{makebs.config.py},
1452 using @code{./examples/makebs.config.py} as a reference - look at the settings and
1453 documentation there to decide if any need changing to suit your environment.
1454 There is a path for retrieving the base box if it doesn't exist, and an apt
1455 proxy definition, both of which may need customising for your environment.
1456 You can then go to the @code{fdroidserver} directory and run this:
1462 This will take a long time, and use a lot of bandwidth - most of it spent
1463 installing the necessary parts of the Android SDK for all the various
1464 platforms. Luckily you only need to do it occasionally. Once you have a
1465 working build server image, if the recipes change (e.g. when packages need
1466 to be added) you can just run that script again and the existing one will
1467 be updated in place.
1469 The main sdk/ndk downloads will automatically be cached to speed things
1470 up the next time, but there's no easy way of doing this for the longer
1471 sections which use the SDK's @code{android} tool to install platforms,
1472 add-ons and tools. However, instead of allowing automatic caching, you
1473 can supply a pre-populated cache directory which includes not only these
1474 downloads, but also .tar.gz files for all the relevant additions. If the
1475 provisioning scripts detect these, they will be used in preference to
1476 running the android tools. For example, if you have
1477 @code{buildserver/addons/cache/platforms/android-19.tar.gz} that will be
1478 used when installing the android-19 platform, instead of re-downloading it
1479 using @code{android update sdk --no-ui -t android-19}. It is possible to
1480 create the cache files of this additions from a local installation of the
1481 SDK including these:
1484 cd /path/to/android-sdk/platforms
1485 tar czf android-19.tar.gz android-19
1486 mv android-19.tar.gz /path/to/buildserver/addons/cache/platforms/}
1489 If you have already built a buildserver it is also possible to get this
1490 files directly from the buildserver:
1493 vagrant ssh -- -C 'tar -C ~/android-sdk/platforms czf android-19.tar.gz android-19'
1494 vagrant ssh -- -C 'cat ~/android-sdk/platforms/android-19.tar.gz' > /path/to/fdroidserver/buildserver/cache/platforms/android19.tar.gz
1497 Once it's complete you'll have a new base box called 'buildserver' which is
1498 what's used for the actual builds. You can then build packages as normal,
1499 but with the addition of the @code{--server} flag to @code{fdroid build} to
1500 instruct it to do all the hard work within the virtual machine.
1502 The first time a build is done, a new virtual machine is created using the
1503 'buildserver' box as a base. A snapshot of this clean machine state is saved
1504 for use in future builds, to improve performance. You can force discarding
1505 of this snapshot and rebuilding from scratch using the @code{--resetserver}
1506 switch with @code{fdroid build}.
1511 There are two kinds of signing involved in running a repository - the signing
1512 of the APK files generated from source builds, and the signing of the repo
1513 index itself. The latter is optional, but very strongly recommended.
1515 @section Repo Index Signing
1517 When setting up the repository, one of the first steps should be to generate
1518 a signing key for the repository index. This will also create a keystore, which
1519 is a file that can be used to hold this and all other keys used. Consider the
1520 location, security and backup status of this file carefully, then create it as
1523 @code{keytool -genkey -v -keystore my.keystore -alias repokey -keyalg RSA -keysize 2048 -validity 10000}
1525 In the above, replace 'my.keystore' with the name of the keystore file to be
1526 created, and 'repokey' with a name to identify the repo index key by.
1528 You'll be asked for a password for the keystore, AND a password for the key.
1529 They shouldn't be the same. In between, you'll be asked for some identifying
1530 details which will go in the certificate.
1532 The two passwords entered go into @code{config.py}, as @code{keystorepass} and
1533 @code{keypass} respectively. The path to the keystore file, and the alias you
1534 chose for the key also go into that file, as @code{keystore} and
1535 @code{repo_keyalias} respectively.
1537 @section Package Signing
1539 With the repo index signing configured, all that remains to be done for package
1540 signing to work is to set the @code{keydname} field in @code{config.py} to
1541 contain the same identifying details you entered before.
1543 A new key will be generated using these details, for each application that is
1544 built. (If a specific key is required for a particular application, this system
1545 can be overridden using the @code{keyaliases} config settings.
1548 @node GNU Free Documentation License
1549 @appendix GNU Free Documentation License