chiark / gitweb /
build: log vcs tools version on every build attempt
[fdroidserver.git] / README.md
1
2 <a name="build-status"></a>
3
4 | CI Builds                |  fdroidserver | buildserver | fdroid build --all | publishing tools |
5 |--------------------------|:-------------:|:-----------:|:------------------:|:----------------:|
6 | Debian                   | [![fdroidserver status on Debian](https://gitlab.com/fdroid/fdroidserver/badges/master/build.svg)](https://gitlab.com/fdroid/fdroidserver/builds) | [![buildserver status](https://jenkins.debian.net/job/reproducible_setup_fdroid_build_environment/badge/icon)](https://jenkins.debian.net/job/reproducible_setup_fdroid_build_environment) | [![fdroid build all status](https://jenkins.debian.net/job/reproducible_fdroid_build_apps/badge/icon)](https://jenkins.debian.net/job/reproducible_fdroid_build_apps/) | [![fdroid build all status](https://jenkins.debian.net/job/reproducible_fdroid_test/badge/icon)](https://jenkins.debian.net/job/reproducible_fdroid_test/) |
7 | macOS & Ubuntu/LTS       | [![fdroidserver status on macOS & Ubuntu/LTS](https://travis-ci.org/f-droid/fdroidserver.svg?branch=master)](https://travis-ci.org/f-droid/fdroidserver) | | | |
8
9
10 # F-Droid Server
11
12 Server for [F-Droid](https://f-droid.org), the Free Software repository system
13 for Android.
14
15 The F-Droid server tools provide various scripts and tools that are
16 used to maintain the main
17 [F-Droid application repository](https://f-droid.org/packages).  You
18 can use these same tools to create your own additional or alternative
19 repository for publishing, or to assist in creating, testing and
20 submitting metadata to the main repository.
21
22 For documentation, please see <https://f-droid.org/docs/>, or you can
23 find the source for the documentation in
24 [fdroid/fdroid-website](https://gitlab.com/fdroid/fdroid-website).
25
26
27 ### What is F-Droid?
28
29 F-Droid is an installable catalogue of FOSS (Free and Open Source Software)
30 applications for the Android platform. The client makes it easy to browse,
31 install, and keep track of updates on your device.
32
33
34 ### Installing
35
36 There are many was to install _fdroidserver_, they are documented on
37 the website:
38 https://f-droid.org/docs/Installing_the_Server_and_Repo_Tools
39
40 All sorts of other documentation lives there as well.
41
42
43 ### Drozer Scanner
44
45 There is a new feature under development that can scan any APK in a
46 repo, or any build, using Drozer.  Drozer is a dynamic exploit
47 scanner, it runs an app in the emulator and runs known exploits on it.
48
49 This setup requires specific versions of two Python modules:
50 _docker-py_ 1.9.0 and _requests_ older than 2.11.  Other versions
51 might cause the docker-py connection to break with the containers.
52 Newer versions of docker-py might have this fixed already.
53
54 For Debian based distributions:
55
56         apt-get install libffi-dev libssl-dev python-docker
57
58 ## Translation
59
60 Everything can be translated.  See
61 [Translation and Localization](https://f-droid.org/docs/Translation_and_Localization)
62 for more info.
63 [![translation status](https://hosted.weblate.org/widgets/f-droid/-/fdroidserver/multi-auto.svg)](https://hosted.weblate.org/engage/f-droid/?utm_source=widget)