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

Added 2 example files and documentation for starting recollindex with systemd

Browse Source
This commit is contained in:
Jean-Francois Dockes 2021-07-01 10:15:20 +02:00
parent e9ad7251ef
commit 2a92200012
6 changed files with 100 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Makefile.am
View File

@ -357,6 +357,8 @@ doc/user/custom.xsl doc/user/usermanual.xml \
filters/injectcommon.sh filters/recfiltcommon filters/rcltxtlines.py \
\
index/rclmon.sh \
index/recollindex-system.service \
index/recollindex-user.service \
\
kde/kioslave/kio_recoll/00README.txt \
kde/kioslave/kio_recoll/CMakeLists.txt \
@ -652,6 +654,8 @@ defconfdir = $(pkgdatadir)/examples
defconf_DATA = \
desktop/recollindex.desktop \
index/rclmon.sh \
index/recollindex-system.service \
index/recollindex-user.service \
sampleconf/fragbuts.xml \
sampleconf/fields \
sampleconf/recoll.conf \

43
src/doc/user/usermanual.html
View File

@ -423,7 +423,7 @@ alink="#0000FF">
<div class="list-of-tables">
<p><b>List of Tables</b></p>
<dl>
<dt>3.1. <a href="#idm1453">Keyboard shortcuts</a></dt>
<dt>3.1. <a href="#idm1465">Keyboard shortcuts</a></dt>
</dl>
</div>
<div class="chapter">
@ -2576,6 +2576,43 @@ metadatacmds = ; <em class=
notify the running process. The <span class=
"command"><strong>recoll</strong></span> GUI also has a
menu entry for this.</p>
<div class="simplesect">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INDEXING.MONITOR.START.SYSTEMD" id=
"RCL.INDEXING.MONITOR.START.SYSTEMD"></a>Automatic
daemon start with systemd</h3>
</div>
</div>
</div>
<p>The installation contains two example files (in
<code class="filename">share/recoll/examples</code>) for
starting the indexing daemon with <span class=
"application">systemd</span>.</p>
<p><code class="filename">recollindex-user.service</code>
would be used for starting <span class=
"command"><strong>recollindex</strong></span> as a user
service, and can be installed with the following
commands:</p>
<pre class=
"programlisting">systemctl --user link /usr/share/recoll/examples/recollindex-user.service
systemctl --user enable --now recollindex-user.service</pre>
<p>The indexer will start when the user logs in and run
while there is a session open for them.</p>
<p><code class=
"filename">recollindex-system.service</code> 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 <span class=
"application">systemd</span> system service. Of course,
if you want to run several such units, you will also need
to rename the installed file.</p>
</div>
<div class="simplesect">
<div class="titlepage">
<div>
@ -2583,7 +2620,7 @@ metadatacmds = ; <em class=
<h3 class="title"><a name=
"RCL.INDEXING.MONITOR.START" id=
"RCL.INDEXING.MONITOR.START"></a>Automatic daemon
start</h3>
start from the desktop session</h3>
</div>
</div>
</div>
@ -4017,7 +4054,7 @@ fs.inotify.max_user_watches=32768
given context (e.g. within a preview window, within the
result table).</p>
<div class="table">
<a name="idm1453" id="idm1453"></a>
<a name="idm1465" id="idm1465"></a>
<p class="title"><b>Table&nbsp;3.1.&nbsp;Keyboard
shortcuts</b></p>
<div class="table-contents">

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

@ -1769,8 +1769,31 @@ metadatacmds = ; <replaceable>tags</replaceable> = tmsu tags %f
process. The <command>recoll</command> GUI also has a menu entry for
this.</para>
<simplesect id="RCL.INDEXING.MONITOR.START.SYSTEMD">
<title>Automatic daemon start with systemd</title>
<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>
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>
</simplesect>
<simplesect id="RCL.INDEXING.MONITOR.START">
<title>Automatic daemon start</title>
<title>Automatic daemon start from the desktop session</title>
<para>Under <application>KDE</application>,
<application>Gnome</application> and some other desktop

14
src/index/recollindex-system.service Normal file
View File

@ -0,0 +1,14 @@
[Unit]
Description=Recollindex indexing for @SOMEUSER@
After=network-online.target
RequiresMountsFor=/home/@SOMEUSER@
[Service]
Type=simple
Restart=on-failure
RestartSec=30
ExecStart=/usr/bin/recollindex -m -D -x -w 10 -c /home/@SOMEUSER@/.recoll
User=@SOMEUSER@
[Install]
WantedBy=multi-user.target

12
src/index/recollindex-user.service Normal file
View File

@ -0,0 +1,12 @@
# Contributed by Frank Dana, licensed as Recoll itself
[Unit]
Description=Recoll real-time document indexing
After=gnome-session-manager.target
[Service]
Type=simple
ExecStart=/usr/bin/recollindex -m -D -x -w 30 -c %h/.recoll/
Restart=on-failure
[Install]
WantedBy=graphical-session.target

12
tests/chm/chm.txt
View File

@ -1,11 +1,11 @@
1 results
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/Nokia_Nseries_Help_jpn.chm] [デジタル著作権管理(DRM)] 2948 bytes
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/Nokia_Nseries_Help_jpn.chm] [デジタル著作権管理(DRM)] 2947 bytes
2 results
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/soundrec.chm] [Superposer (mixer) des fichiers son] 2279 bytes
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/zippedsoundrec.zip] [Superposer (mixer) des fichiers son] 2279 bytes
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/soundrec.chm] [Superposer (mixer) des fichiers son] 2278 bytes
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/zippedsoundrec.zip] [Superposer (mixer) des fichiers son] 2278 bytes
1 results
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/Django-1.1a1-r9905.chm] [User authentication in Django] 115179 bytes
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/Django-1.1a1-r9905.chm] [User authentication in Django] 115178 bytes
1 results
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/PMGlossary.chm] [Project Management Glossary: P09] 64703 bytes
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/PMGlossary.chm] [Project Management Glossary: P09] 64702 bytes
1 results
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/2006Susla-handbookCriticalCareDrugTherapy.CHM] [Ovid: Handbook of Critical Care Drug Therapy] 124329 bytes
text/html [file:///home/dockes/projets/fulltext/testrecoll/chm/2006Susla-handbookCriticalCareDrugTherapy.CHM] [Ovid: Handbook of Critical Care Drug Therapy] 124328 bytes