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 used to
   9 maintain the main [F-Droid application repository](https://f-droid.org/repository/browse).
  10 You can use these same tools to create your own additional or alternative
  11 repository for publishing, or to assist in creating, testing and submitting
  12 metadata to the main repository.
  13
  14 For documentation, please see the docs directory.
  15
  16 Alternatively, visit [https://f-droid.org/manual/](https://f-droid.org/manual/).
  17
  18 ### What is F-Droid?
  19
  20 F-Droid is an installable catalogue of FOSS (Free and Open Source Software)
  21 applications for the Android platform. The client makes it easy to browse,
  22 install, and keep track of updates on your device.
  23
  24 ### Installing
  25
  26 Note that only Python 3 is supported. We recommend version 3.4 or later.
  27
  28 The easiest way to install the `fdroidserver` tools is on Ubuntu, Mint or other
  29 Ubuntu based distributions, you can install using:
  30
  31         sudo apt-get install fdroidserver
  32
  33 For older Ubuntu releases or to get the latest version, you can get
  34 `fdroidserver` from the Guardian Project PPA (the signing key
  35 fingerprint is `6B80 A842 07B3 0AC9 DEE2 35FE F50E ADDD 2234 F563`)
  36
  37         sudo add-apt-repository ppa:guardianproject/ppa
  38         sudo apt-get update
  39         sudo apt-get install fdroidserver
  40
  41 On OSX, `fdroidserver` is available from third party package managers,
  42 like Homebrew, MacPorts, and Fink:
  43
  44         brew install fdroidserver
  45
  46 For Arch-Linux is a package in the AUR available. If you have installed
  47 `yaourt` or something similiar, you can do:
  48
  49         yaourt -S fdroidserver
  50
  51 For any platform where Python's `easy_install` is an option (e.g. OSX
  52 or Cygwin, you can use it:
  53
  54         sudo easy_install fdroidserver
  55
  56 Python's `pip` also works:
  57
  58         sudo pip3 install fdroidserver
  59
  60 The combination of `pyvenv` and `pip` is great for testing out the
  61 latest versions of `fdroidserver`. Using `pip`, `fdroidserver` can
  62 even be installed straight from git. First, make sure you have
  63 installed the python header files, venv and pip. They should be
  64 included in your OS's default package manager or you can install them
  65 via other mechanisms like Brew/dnf/pacman/emerge/Fink/MacPorts.
  66
  67 For Debian based distributions:
  68
  69         apt-get install python3-dev python3-pip python3-venv libjpeg-dev zlib1g-dev
  70
  71 Then here's how to install:
  72
  73         git clone https://gitlab.com/fdroid/fdroidserver.git
  74         cd fdroidserver
  75         pyvenv env/
  76         source env/bin/activate
  77         pip3 install -e .
  78         python3 setup.py install