-F-Droid Server
-==============
+
+<a name="build-status"></a>
+
+| CI Builds | fdroidserver | buildserver | fdroid build --all | publishing tools |
+|--------------------------|:-------------:|:-----------:|:------------------:|:----------------:|
+| Debian | [](https://gitlab.com/fdroid/fdroidserver/builds) | [](https://jenkins.debian.net/job/reproducible_setup_fdroid_build_environment) | [](https://jenkins.debian.net/job/reproducible_fdroid_build_apps/) | [](https://jenkins.debian.net/job/reproducible_fdroid_test/) |
+| macOS & Ubuntu/LTS | [](https://travis-ci.org/f-droid/fdroidserver) | | | |
+
+
+# F-Droid Server
Server for [F-Droid](https://f-droid.org), the Free Software repository system
for Android.
-The F-Droid server tools provide various scripts and tools that are used to
-maintain the main [F-Droid application repository](https://f-droid.org/repository/browse).
-You can use these same tools to create your own additional or alternative
-repository for publishing, or to assist in creating, testing and submitting
-metadata to the main repository.
+The F-Droid server tools provide various scripts and tools that are
+used to maintain the main
+[F-Droid application repository](https://f-droid.org/packages). You
+can use these same tools to create your own additional or alternative
+repository for publishing, or to assist in creating, testing and
+submitting metadata to the main repository.
-For documentation, please see the docs directory.
+For documentation, please see <https://f-droid.org/docs/>, or you can
+find the source for the documentation in
+[fdroid/fdroid-website](https://gitlab.com/fdroid/fdroid-website).
-Alternatively, visit [https://f-droid.org/manual/](https://f-droid.org/manual/).
-What is F-Droid?
-----------------
+### What is F-Droid?
F-Droid is an installable catalogue of FOSS (Free and Open Source Software)
applications for the Android platform. The client makes it easy to browse,
install, and keep track of updates on your device.
-Installing
-----------
-
-The easiest way to install the `fdroidserver` tools is on Ubuntu, Mint or other
-Ubuntu based distributions, you can install using:
-```
-sudo apt-get install fdroidserver
-```
+### Installing
-For older Ubuntu releases or to get the latest version, you can get
-`fdroidserver` from the Guardian Project PPA (the signing key
-fingerprint is `6B80 A842 07B3 0AC9 DEE2 35FE F50E ADDD 2234 F563`)
+There are many was to install _fdroidserver_, they are documented on
+the website:
+https://f-droid.org/docs/Installing_the_Server_and_Repo_Tools
-```
-sudo add-apt-repository ppa:guardianproject/ppa
-sudo apt-get update
-sudo apt-get install fdroidserver
-```
+All sorts of other documentation lives there as well.
-On OSX, `fdroidserver` is available from third party package managers,
-like Homebrew, MacPorts, and Fink:
-```
-sudo brew install fdroidserver
-```
+### Drozer Scanner
-For Arch-Linux is a package in the AUR available. If you have installed
-`yaourt` or something similiar, you can do:
+There is a new feature under development that can scan any APK in a
+repo, or any build, using Drozer. Drozer is a dynamic exploit
+scanner, it runs an app in the emulator and runs known exploits on it.
-```
-yaourt -S fdroidserver
-```
+This setup requires specific versions of two Python modules:
+_docker-py_ 1.9.0 and _requests_ older than 2.11. Other versions
+might cause the docker-py connection to break with the containers.
+Newer versions of docker-py might have this fixed already.
-For any platform where Python's `easy_install` is an option (e.g. OSX
-or Cygwin, you can use it:
-
-```
-sudo easy_install fdroidserver
-```
-
-Python's `pip` also works:
-
-```
-sudo pip install fdroidserver
-```
+For Debian based distributions:
-The combination of `virtualenv` and `pip` is great for testing out the
-latest versions of `fdroidserver`. Using `pip`, `fdroidserver` can
-even be installed straight from git. First, make sure you have
-installed the python header files, virtualenv and pip. They should be
-included in your OS's default package manager or you can install them
-via other mechanisms like Brew/dnf/pacman/emerge/Fink/MacPorts.
+ apt-get install libffi-dev libssl-dev python-docker
-For Debian based distributions:
+## Translation
-```
-apt-get install python-dev python-pip python-virtualenv
-```
-Then here's how to install:
-
-```
-git clone https://gitlab.com/fdroid/fdroidserver.git
-cd fdroidserver
-virtualenv env/
-source env/bin/activate
-pip install -e .
-python2 setup.py install
-```
+Everything can be translated. See
+[Translation and Localization](https://f-droid.org/docs/Translation_and_Localization)
+for more info.
+[](https://hosted.weblate.org/engage/f-droid/?utm_source=widget)
~ianmdlvl / fdroidserver.git / blobdiff