README.md

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