add documentation for lock file (#4862)

This commit is contained in:
Noah Swartz 2017-06-21 14:23:19 -07:00 committed by Brad Warren
parent 3cb92d33eb
commit 077aea5fb1

View file

@ -722,7 +722,28 @@ Example usage for DNS-01 (Cloudflare API v4) (for example purposes only, do not
fi
fi
.. _lock-files:
Lock Files
==========
When processing a validation Certbot writes a number of lock files on your system
to prevent multiple instances from overwriting each other's changes. This means
that be default two instances of Certbot will not be able to run in parallel.
Since the directories used by Certbot are configurable, Certbot
will write a lock file for all of the directories it uses. This include Certbot's
``--work-dir``, ``--logs-dir``, and ``--config-dir``. By default these are
``/var/lib/letsencrypt``, ``/var/logs/letsencrypt``, and ``/etc/letsencrypt``
respectively. Additionally if you are using Certbot with Apache or nginx it will
lock the configuration folder for that program, which are typically also in the
``/etc`` directory.
Note that these lock files will only prevent other instances of Certbot from
using those directories, not other processes. If you'd like to run multiple
instances of Certbot simultaneously you should specify different directories
as the ``--work-dir``, ``--logs-dir``, and ``--config-dir`` for each instance
of Certbot that you would like to run.
.. _config-file: