From 3f1cc004b89b90287ef1aa03f6b0d6f15f37f8da Mon Sep 17 00:00:00 2001 From: "FeRD (Frank Dana)" Date: Thu, 1 Jul 2021 21:19:22 -0400 Subject: [PATCH] Document unit installation, install options --- src/doc/user/usermanual.xml | 44 +++++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 11 deletions(-) diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 5c9848fe..e3f49673 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -1775,21 +1775,28 @@ metadatacmds = ; tags = tmsu tags %f The installation contains two example files (in share/recoll/examples) for starting the indexing daemon with systemd. - recollindex-user.service would be used for - starting recollindex as a user service, and can be installed with the - following commands: -systemctl --user link /usr/share/recoll/examples/recollindex-user.service -systemctl --user enable --now recollindex-user.service + recollindex.service would be used for + starting recollindex as a user service. The indexer will start when the user logs in and run while there is a session open for them. - recollindex-system.service 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 systemd system service. Of course, if you want to - run several such units, you will also need to rename the installed file. +recollindex@.service 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). + If configured to do so, the unit files should have been installed in your system's + default systemd paths (usually /usr/lib/systemd/system/ and + /usr/lib/systemd/user/). If not, you may need to copy the files there + before starting the service. + + With the unit files installed in the proper location, the user unit can be + started with the following commands: +systemctl --user daemon-reload +systemctl --user enable --now recollindex.service + The system unit file can be enabled for a particular user by running, as root: +systemctl daemon-reload +systemctl enable --now recollindex@username.service + (A valid user name should be substituted for username, of course.) @@ -6443,6 +6450,21 @@ hasextract = False or PHP extensions, but might yield very marginally faster code. + Disable + the automatic installation of systemd unit files. Normally + unit files are installed if the install path can be detected. + + + + Provide + an install path for the systemd system unit template file. + + + + Provide + an install path for the systemd user unit file. + + Of course the usual autoconf configure options, like apply.