tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Document unit installation, install options

Browse Source
This commit is contained in:
FeRD (Frank Dana) 2021-07-01 21:19:22 -04:00
parent a1f78ba57c
commit 3f1cc004b8
1 changed files with 33 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
src/doc/user/usermanual.xml
View File

@ -1775,21 +1775,28 @@ metadatacmds = ; <replaceable>tags</replaceable> = tmsu tags %f
<para>The installation contains two example files
(in <filename>share/recoll/examples</filename>) for starting the indexing daemon with
<application>systemd</application>.</para>
<para><filename>recollindex-user.service</filename> would be used for
starting <command>recollindex</command> as a user service, and can be installed with the
following commands:
<programlisting>systemctl --user link /usr/share/recoll/examples/recollindex-user.service
systemctl --user enable --now recollindex-user.service</programlisting>
<para><filename>recollindex.service</filename> would be used for
starting <command>recollindex</command> as a user service.
The indexer will start when the user logs in and run while there is a session open for
them.</para>
<para><filename>recollindex-system.service</filename> would be used for starting the indexer
at boot time, running as a specific user. It can be useful when running the text search as a
shared service (e.g. when users access it through the WEB UI). You will need to edit it to
replace the @SOMEUSER@ value with something which makes sense in your case, then install it
as a regular <application>systemd</application> system service. Of course, if you want to
run several such units, you will also need to rename the installed file.</para>
<para><filename>recollindex@.service</filename> is a template service which would be used
for starting the indexer at boot time, running as a specific user. It can be useful when
running the text search as a shared service (e.g. when users access it through the WEB UI).</para>
<para>If configured to do so, the unit files should have been installed in your system's
default systemd paths (usually <filename>/usr/lib/systemd/system/</filename> and
<filename>/usr/lib/systemd/user/</filename>). If not, you may need to copy the files there
before starting the service.</para>
<para>With the unit files installed in the proper location, the user unit can be
started with the following commands:
<programlisting>systemctl --user daemon-reload
systemctl --user enable --now recollindex.service</programlisting>
The system unit file can be enabled for a particular user by running, as root:
<programlisting>systemctl daemon-reload
systemctl enable --now recollindex@<varname>username</varname>.service</programlisting>
(A valid user name should be substituted for <varname>username</varname>, of course.)</para>
</simplesect>
<simplesect id="RCL.INDEXING.MONITOR.START">
@ -6443,6 +6450,21 @@ hasextract = False
or <application>PHP</application> extensions, but might
yield very marginally faster code.</para></listitem>
<listitem><para><option>--without-systemd</option> Disable
the automatic installation of systemd unit files. Normally
unit files are installed if the install path can be detected.
</para></listitem>
<listitem><para>
<option>--with-system-unit-dir=DIR</option> Provide
an install path for the systemd system unit template file.
</para></listitem>
<listitem><para>
<option>--with-user-unit-dir=DIR</option> Provide
an install path for the systemd user unit file.
</para></listitem>
<listitem><para>Of course the usual
<application>autoconf</application> <command>configure</command>
options, like <option>--prefix</option> apply.</para>