README.md

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