Changeset 52b47970 for general/prog/gitserver.xml

Timestamp:

01/08/2021 09:19:18 PM (3 years ago)

Author:

Thomas Trepl <thomas@…>

Branches:

10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, lazarus, lxqt, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal

Children:

d6de80b

Parents:

7c9ae62

Message:

Explain the config file

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24094 af4574ff-66df-0310-9fd7-8a98e5e911e0

File:

• general/prog/gitserver.xml (modified) (1 diff)

general/prog/gitserver.xml

@@ -285 +285 @@
 <screen role="root"><userinput>touch /srv/git/project1.git/git-daemon-export-ok</userinput></screen>
 
-      <para>
-        Finally, review the configuration file
-        <filename revision="sysv">/etc/sysconfig/git-daemon</filename>
-        <filename revision="systemd">/etc/default/git-daemon</filename>
-        for valid repository paths and change them as appropriate.
-      </para>
-
+      <para revision="sysv">
+        The script to start the git daemon uses some default values
+        internally. Most important is the path to the repository
+        directory which is set to <filename class="directory">/srv/git</filename>.
+        In case you have for whatever reason created the repository in a
+        different location, you'll need to tell the boot script where the
+        repository is to be found. This can be achieved by creating a
+        configuration file named <filename>/etc/sysconfig/git-daemon</filename>.
+        This configuration file will be imported if it exists. It can 
+        look like:</para>
+<screen revision="sysv">
+# Begin /etc/sysconfig/git-daemon
+
+# Specify the location of the git repository
+GIT_BASE_DIR="/srv/git/"
+
+# Directories added to whitelist
+DFT_REPO_DIR="$GIT_BASE_DIR"
+
+# Add extra options which will appended to the 'git daemon'
+# command executed in the boot script
+GIT_DAEMON_OPTS=""
+
+# End /etc/sysconfig/git-daemon
+</screen>
+      <para revision="systemd">
+        Along with the <filename>git-daemon.service</filename> unit, a
+        configuration file named <filename>/etc/default/git-daemon</filename>
+        has been installed. Review this configuration file to match your
+        needs.
+      </para>
+
+      <para>
+        There are only three options to set in the configuration file:
+        <itemizedlist>
+          <listitem>
+            <para>
+              GIT_BASE_DIR=&lt;dirname&gt;
+            </para>
+            <para>Specify the location of the repository directory
+              on which the git daemon operates on. Relative pathes
+              in access to the daemon will translated to be relative
+              to this directory.
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              DFT_REPO_DIR=&lt;dirname&gt;
+            </para>
+            <para>The directory is added to the white list of allowed
+              directories. This variable can hold multible directory
+              names but is usually set equal to <literal>GIT_BASE_DIR</literal>.
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              GIT_DAEMON_OPTS=&lt;options&gt;
+            </para>
+            <para>In case you have to pass special options to the
+              <command>git daemon</command> command, they have to be
+              specified in this setting. On example might be to adjust
+              the port number the daemon is listening on. In this case,
+              add <literal>--port=XYZ</literal> to this variable.
+              For more information which options can be set, take a look
+              at the output of <command>git daemon --help</command>.
+            </para>
+          </listitem>
+        </itemizedlist>
+      </para>
+      
     </sect3>