README.md

   1 F-Droid Server
   2 ==============
   3
   4 [![build status](https://ci.gitlab.com/projects/6642/status.png?ref=master)](https://ci.gitlab.com/projects/6642?ref=master)
   5
   6 Server for [F-Droid](https://f-droid.org), the Free Software repository system
   7 for Android.
   8
   9 The F-Droid server tools provide various scripts and tools that are used to
  10 maintain the main [F-Droid application repository](https://f-droid.org/repository/browse).
  11 You can use these same tools to create your own additional or alternative
  12 repository for publishing, or to assist in creating, testing and submitting
  13 metadata to the main repository.
  14
  15 For documentation, please see the docs directory.
  16
  17 Alternatively, visit [https://f-droid.org/manual/](https://f-droid.org/manual/).
  18
  19 What is F-Droid?
  20 ----------------
  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 Installing
  27 ----------
  28
  29 The easiest way to install the `fdroidserver` tools is on Ubuntu, Mint or other
  30 Ubuntu based distributions, you can install using:
  31
  32 ```
  33 sudo apt-get install fdroidserver
  34 ```
  35
  36 For older Ubuntu releases or to get the latest version, you can get
  37 `fdroidserver` from the Guardian Project PPA (the signing key
  38 fingerprint is `6B80 A842 07B3 0AC9 DEE2 35FE F50E ADDD 2234 F563`)
  39
  40 ```
  41 sudo add-apt-repository ppa:guardianproject/ppa
  42 sudo apt-get update
  43 sudo apt-get install fdroidserver
  44 ```
  45
  46 On OSX, `fdroidserver` is available from third party package managers,
  47 like Homebrew, MacPorts, and Fink:
  48
  49 ```
  50 sudo brew install fdroidserver
  51 ```
  52
  53 For Arch-Linux is a package in the AUR available. If you have installed
  54 `yaourt` or something similiar, you can do:
  55
  56 ```
  57 yaourt -S fdroidserver
  58 ```
  59
  60 For any platform where Python's `easy_install` is an option (e.g. OSX
  61 or Cygwin, you can use it:
  62
  63 ```
  64 sudo easy_install fdroidserver
  65 ```
  66
  67 Python's `pip` also works:
  68
  69 ```
  70 sudo pip install fdroidserver
  71 ```
  72
  73 The combination of `virtualenv` and `pip` is great for testing out the
  74 latest versions of `fdroidserver`.  Using `pip`, `fdroidserver` can
  75 even be installed straight from git.  First, make sure you have
  76 installed the python header files, virtualenv and pip.  They should be
  77 included in your OS's default package manager or you can install them
  78 via other mechanisms like Brew/dnf/pacman/emerge/Fink/MacPorts.
  79
  80 For Debian based distributions:
  81
  82 ```
  83 apt-get install python-dev python-pip python-virtualenv
  84 ```
  85 Then here's how to install:
  86
  87 ```
  88 git clone https://gitlab.com/fdroid/fdroidserver.git
  89 cd fdroidserver
  90 virtualenv env/
  91 source env/bin/activate
  92 pip install -e .
  93 python2 setup.py install
  94 ```