README.md

   1 <a name="build-status"></a>
   2
   3 | CI Builds                |  fdroidserver | buildserver | fdroid build --all | publishing tools |
   4 |--------------------------|:-------------:|:-----------:|:------------------:|:----------------:|
   5 | Debian                   | [![fdroidserver status on Debian](https://gitlab.com/fdroid/fdroidserver/badges/master/build.svg)](https://gitlab.com/fdroid/fdroidserver/builds) | [![buildserver status](https://jenkins.debian.net/job/reproducible_setup_fdroid_build_environment/badge/icon)](https://jenkins.debian.net/job/reproducible_setup_fdroid_build_environment) | [![fdroid build all status](https://jenkins.debian.net/job/reproducible_fdroid_build_apps/badge/icon)](https://jenkins.debian.net/job/reproducible_fdroid_build_apps/) | [![fdroid test status](https://jenkins.debian.net/job/reproducible_fdroid_test/badge/icon)](https://jenkins.debian.net/job/reproducible_fdroid_test/) |
   6 | macOS & Ubuntu/LTS       | [![fdroidserver status on macOS & Ubuntu/LTS](https://travis-ci.org/f-droid/fdroidserver.svg?branch=master)](https://travis-ci.org/f-droid/fdroidserver) | | | |
   7
   8
   9 # F-Droid Server
  10
  11 Server for [F-Droid](https://f-droid.org), the Free Software repository system
  12 for Android.
  13
  14 The F-Droid server tools provide various scripts and tools that are
  15 used to maintain the main
  16 [F-Droid application repository](https://f-droid.org/packages).  You
  17 can use these same tools to create your own additional or alternative
  18 repository for publishing, or to assist in creating, testing and
  19 submitting metadata to the main repository.
  20
  21 For documentation, please see <https://f-droid.org/docs/>, or you can
  22 find the source for the documentation in
  23 [fdroid/fdroid-website](https://gitlab.com/fdroid/fdroid-website).
  24
  25
  26 ### What is F-Droid?
  27
  28 F-Droid is an installable catalogue of FOSS (Free and Open Source Software)
  29 applications for the Android platform. The client makes it easy to browse,
  30 install, and keep track of updates on your device.
  31
  32
  33 ### Installing
  34
  35 There are many ways to install _fdroidserver_, they are documented on
  36 the website:
  37 https://f-droid.org/docs/Installing_the_Server_and_Repo_Tools
  38
  39 All sorts of other documentation lives there as well.
  40
  41
  42 ### Tests
  43
  44 There are many components to all of the tests for the components in
  45 this git repo.  The most commonly used parts of well tested, while
  46 some parts still lack tests.  This test suite has built over time a
  47 bit haphazardly, so it is not as clean, organized, or complete as it
  48 could be.  We welcome contributions.  Before rearchitecting any parts
  49 of it, be sure to [contact us](https://f-droid.org/about) to discuss
  50 the changes beforehand.
  51
  52
  53 #### `fdroid` commands
  54
  55 The test suite for all of the `fdroid` commands is in the _tests/_
  56 subdir.  _.gitlab-ci.yml_ and _.travis.yml_ run this test suite on
  57 various configurations.
  58
  59 * _tests/complete-ci-tests_ runs _pylint_ and all tests on two
  60   different pyvenvs
  61 * _tests/run-tests_ runs the whole test suite
  62 * _tests/*.TestCase_ are individual unit tests for all of the `fdroid`
  63   commands, which can be run separately, e.g. `./update.TestCase`.
  64
  65
  66 #### Additional tests for different linux distributions
  67
  68 These tests are also run on various distributions through GitLab CI. This is
  69 only enabled for `master@fdroid/fdroidserver` because it'll take longer to
  70 complete than the regular CI tests.  Most of the time you won't need to worry
  71 about them but sometimes it might make sense to also run them for your merge
  72 request. In that case you need to remove [these lines from
  73 .gitlab-ci.yml](https://gitlab.com/fdroid/fdroidserver/blob/master/.gitlab-ci.yml#L34-35)
  74 and push this to a new branch of your fork.
  75
  76 Alternatively [run them
  77 locally](https://docs.gitlab.com/runner/commands/README.html#gitlab-runner-exec)
  78 like this: `gitlab-runner exec docker ubuntu_lts`
  79
  80 #### buildserver
  81
  82 The tests for the whole build server setup are entirely separate
  83 because they require at least 200GB of disk space, and 8GB of
  84 RAM. These test scripts are in the root of the project, all starting
  85 with _jenkins-_ since they are run on https://jenkins.debian.net.
  86
  87
  88
  89 ### Drozer Scanner
  90
  91 There is a new feature under development that can scan any APK in a
  92 repo, or any build, using Drozer.  Drozer is a dynamic exploit
  93 scanner, it runs an app in the emulator and runs known exploits on it.
  94
  95 This setup requires specific versions of two Python modules:
  96 _docker-py_ 1.9.0 and _requests_ older than 2.11.  Other versions
  97 might cause the docker-py connection to break with the containers.
  98 Newer versions of docker-py might have this fixed already.
  99
 100 For Debian based distributions:
 101
 102         apt-get install libffi-dev libssl-dev python-docker
 103
 104 ## Translation
 105
 106 Everything can be translated.  See
 107 [Translation and Localization](https://f-droid.org/docs/Translation_and_Localization)
 108 for more info.
 109 [![translation status](https://hosted.weblate.org/widgets/f-droid/-/fdroidserver/multi-auto.svg)](https://hosted.weblate.org/engage/f-droid/?utm_source=widget)