README.md

   1 # F-Droid Server
   2
   3 [![build status](https://gitlab.com/fdroid/fdroidserver/badges/master/build.svg)](https://gitlab.com/fdroid/fdroidserver/builds)
   4
   5 Server for [F-Droid](https://f-droid.org), the Free Software repository system
   6 for Android.
   7
   8 The F-Droid server tools provide various scripts and tools that are
   9 used to maintain the main
  10 [F-Droid application repository](https://f-droid.org/packages).  You
  11 can use these same tools to create your own additional or alternative
  12 repository for publishing, or to assist in creating, testing and
  13 submitting metadata to the main repository.
  14
  15 For documentation, please see <https://f-droid.org/docs/>, or you can
  16 find the source for the documentation in
  17 [fdroid/fdroid-website](https://gitlab.com/fdroid/fdroid-website).
  18
  19
  20 ### What is F-Droid?
  21
  22 F-Droid is an installable catalogue of FOSS (Free and Open Source Software)
  23 applications for the Android platform. The client makes it easy to browse,
  24 install, and keep track of updates on your device.
  25
  26
  27 ### Installing
  28
  29 There are many was to install _fdroidserver_, they are documented on
  30 the website:
  31 https://f-droid.org/docs/Installing_the_Server_and_Repo_Tools
  32
  33 All sorts of other documentation lives there as well.
  34
  35
  36 ### Drozer Scanner
  37
  38 There is a new feature under development that can scan any APK in a
  39 repo, or any build, using Drozer.  Drozer is a dynamic exploit
  40 scanner, it runs an app in the emulator and runs known exploits on it.
  41
  42 This setup requires specific versions of two Python modules:
  43 _docker-py_ 1.9.0 and _requests_ older than 2.11.  Other versions
  44 might cause the docker-py connection to break with the containers.
  45 Newer versions of docker-py might have this fixed already.
  46
  47 For Debian based distributions:
  48
  49         apt-get install libffi-dev libssl-dev python-docker