.. highlight:: sh

=========================
 Registering the Service
=========================

Note that all commands on this page must be ran in an *admin console*
(right-click on ``cmd.exe``, run as administrator).

At minimum you must register the service in order to use it.  Here is
the most basic command you can use for that::

   rattail filemon install

However you will most likely want the service startup set to
"automatic" - and you may also need to set it to run as a particular
user account (see :doc:`/base/install/windows/user`).

You can take care of all that at once with the command::

   rattail filemon install --auto-start --username rattail

This will register the service (so it's visible in Windows Services)
and set it to automatic startup and to run as ``rattail`` user.

(If the command fails then please be sure you are running an *admin
console*.)

Note that the service will *not* have been started yet.  Before you
can do that though you will need to configure it; see
:doc:`config/index` if you've not already done that.


.. _unregister-windows-filemon:

Unregistering the Service
=========================

To *unregister* the filemon service, you can do (again, in an *admin
console*):

.. code-block:: sh

   rattail filemon remove

Note that if you have the Windows Services snap-in open, or possibly
one of a few other things, the service may not truly be removed until
you close those things.  For more info see this `Stack Overflow
post`_.

.. _Stack Overflow post: https://stackoverflow.com/questions/20561990/how-to-solve-the-specified-service-has-been-marked-for-deletion-error

You can close, then re-open Windows Servies snap-in to see if it has
been truly removed from that list.