/usr/share/doc/fdroidserver/html/html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for the F-Droid repository server tools.

Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015 Ciaran Gultnieks

Copyright (C) 2011 Henrik Tunedal, Michael Haas, John Sullivan

Copyright (C) 2013 David Black

Copyright (C) 2013, 2014, 2015 Daniel Martí

Copyright (C) 2015 Boris Kraut

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License". -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>F-Droid Server Manual: Setup</title>

<meta name="description" content="F-Droid Server Manual: Setup">
<meta name="keywords" content="F-Droid Server Manual: Setup">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index.html#Index" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top">
<link href="Simple-Binary-Repository.html#Simple-Binary-Repository" rel="next" title="Simple Binary Repository">
<link href="System-Requirements.html#System-Requirements" rel="prev" title="System Requirements">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Setup"></a>
<div class="header">
<p>
Next: <a href="Simple-Binary-Repository.html#Simple-Binary-Repository" accesskey="n" rel="next">Simple Binary Repository</a>, Previous: <a href="System-Requirements.html#System-Requirements" accesskey="p" rel="prev">System Requirements</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Setup-1"></a>
<h2 class="chapter">3 Setup</h2>

<a name="index-setup_002c-installation"></a>

<p>Because the tools and data will always change rapidly, you will almost
certainly want to work from a git clone of the tools at this stage. To
get started:
</p>
<div class="example">
<pre class="example">git clone https://gitlab.com/fdroid/fdroidserver.git
</pre></div>

<p>You now have lots of stuff in the fdroidserver directory, but the most
important is the &rsquo;fdroid&rsquo; command script which you run to perform all tasks.
This script is always run from a repository data directory, so the
most sensible thing to do next is to put your new fdroidserver directory
in your <code>PATH</code>.
</p>
<a name="Data"></a>
<h3 class="section">3.1 Data</h3>

<p>To do anything, you&rsquo;ll need at least one repository data directory. It&rsquo;s
from this directory that you run the <code>fdroid</code> command to perform all
repository management tasks. You can either create a brand new one, or
grab a copy of the data used by the main F-Droid repository:
</p>
<div class="example">
<pre class="example">git clone https://gitlab.com/fdroid/fdroiddata.git
</pre></div>

<p>Regardless of the intended usage of the tools, you will always need to set
up some basic configuration details. This is done by creating a file called
<code>config.py</code> in the data directory. You should do this by copying the
example file (<code>./examples/config.py</code>) from the fdroidserver project to
your data directory and then editing according to the instructions within.
</p>
<p>Once configured in this way, all the functionality of the tools is accessed
by running the <code>fdroid</code> command. Run it on its own to get a list of the
available sub-commands.
</p>
<p>You can follow any command with <code>--help</code> to get a list of additional
options available for that command.
</p>
<div class="example">
<pre class="example">fdroid update --help
</pre></div>


<hr>
<div class="header">
<p>
Next: <a href="Simple-Binary-Repository.html#Simple-Binary-Repository" accesskey="n" rel="next">Simple Binary Repository</a>, Previous: <a href="System-Requirements.html#System-Requirements" accesskey="p" rel="prev">System Requirements</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
fdroidserver 0.7.0-2 / usr / share / doc / fdroidserver / html / html_node / Setup.html
