rclone/docs/content
nielash e9cd3e5986 bisync: allow lock file expiration/renewal with --max-lock - #7470
Background: Bisync uses lock files as a safety feature to prevent
interference from other bisync runs while it is running. Bisync normally
removes these lock files at the end of a run, but if bisync is abruptly
interrupted, these files will be left behind. By default, they will lock out
all future runs, until the user has a chance to manually check things out and
remove the lock.

Before this change, lock files blocked future runs indefinitely, so a single
interrupted run would lock out all future runs forever (absent user
intervention), and there was no way to change this behavior.

After this change, a new --max-lock flag can be used to make lock files
automatically expire after a certain period of time, so that future runs are
not locked out forever, and auto-recovery is possible. --max-lock can be any
duration 2m or greater (or 0 to disable). If set, lock files older than this
will be considered "expired", and future runs will be allowed to disregard them
and proceed. (Note that the --max-lock duration must be set by the process that
left the lock file -- not the later one interpreting it.)

If set, bisync will also "renew" these lock files every
--max-lock_minus_one_minute throughout a run, for extra safety. (For example,
with --max-lock 5m, bisync would renew the lock file (for another 5 minutes)
every 4 minutes until the run has completed.) In other words, it should not be
possible for a lock file to pass its expiration time while the process that
created it is still running -- and you can therefore be reasonably sure that
any _expired_ lock file you may find was left there by an interrupted run, not
one that is still running and just taking awhile.

If --max-lock is 0 or not set, the default is that lock files will never
expire, and will block future runs (of these same two bisync paths)
indefinitely.

For maximum resilience from disruptions, consider setting a relatively short
duration like --max-lock 2m along with --resilient and --recover, and a
relatively frequent cron schedule. The result will be a very robust
"set-it-and-forget-it" bisync run that can automatically bounce back from
almost any interruption it might encounter, without requiring the user to get
involved and run a --resync.
2024-01-20 16:31:28 -05:00
..
commands sync: report list of synced paths to file -- see #7282 2024-01-20 14:50:08 -05:00
oracleobjectstorage docs: fix typos found by codespell in docs and code comments 2023-09-23 12:20:01 +01:00
_index.md docs: add bisync to index 2024-01-20 14:50:08 -05:00
alias.md docs: Add minimum versions to all the backend pages and some of the other pages 2022-11-18 14:41:24 +00:00
amazonclouddrive.md amazonclouddrive: remove Amazon Drive backend code and docs #7539 2024-01-04 17:05:54 +00:00
authors.md Add Harshit Budhraja to contributors 2024-01-17 10:23:50 +00:00
azureblob.md Version v1.65.0 2023-11-26 16:07:39 +00:00
azurefiles.md azurefiles: finish docs and implementation and add optional interfaces 2023-11-18 16:48:23 +00:00
b2.md Version v1.65.0 2023-11-26 16:07:39 +00:00
bisync.md bisync: allow lock file expiration/renewal with --max-lock - #7470 2024-01-20 16:31:28 -05:00
box.md Version v1.65.0 2023-11-26 16:07:39 +00:00
bugs.md docs: improve grammar and fix typos (#5361) 2021-11-04 12:50:43 +01:00
cache.md docs: add badge for experimental/beta/deprecated status next to version in backend docs 2022-12-03 18:58:55 +01:00
changelog.md Changelog updates from Version v1.65.1 2024-01-08 11:54:02 +00:00
chunker.md docs: cleanup backend hashes sections 2023-11-20 17:43:57 +00:00
combine.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
compress.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
contact.md docs: update contact page on website 2023-07-05 16:57:07 +01:00
crypt.md amazonclouddrive: remove Amazon Drive backend code and docs #7539 2024-01-04 17:05:54 +00:00
docker.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
docs.md sync: --fix-case flag to rename case insensitive dest - fixes #4854 2024-01-20 14:50:08 -05:00
downloads.md docs: add rclone OS requirements 2024-01-17 16:42:33 +00:00
drive.md Version v1.65.0 2023-11-26 16:07:39 +00:00
dropbox.md Version v1.65.0 2023-11-26 16:07:39 +00:00
faq.md docs: faq: add solution for port opening issues on Windows 2023-06-25 11:20:54 +01:00
fichier.md Version v1.65.0 2023-11-26 16:07:39 +00:00
filefabric.md Version v1.65.0 2023-11-26 16:07:39 +00:00
filtering.md add missing backtick 2024-01-19 11:17:36 +00:00
flags.md Version v1.65.0 2023-11-26 16:07:39 +00:00
ftp.md Version v1.65.0 2023-11-26 16:07:39 +00:00
googlecloudstorage.md Version v1.65.0 2023-11-26 16:07:39 +00:00
googlephotos.md Version v1.65.0 2023-11-26 16:07:39 +00:00
gui.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
hasher.md docs: fix typos found by codespell 2023-03-24 20:49:00 +00:00
hdfs.md Version v1.65.0 2023-11-26 16:07:39 +00:00
hidrive.md Version v1.65.0 2023-11-26 16:07:39 +00:00
http.md Version v1.65.0 2023-11-26 16:07:39 +00:00
imagekit.md Version v1.65.0 2023-11-26 16:07:39 +00:00
install.md docs: document how to build with version info and icon resources on windows 2023-11-01 12:44:04 +01:00
install.sh install.sh: fix harmless error message on install 2023-11-28 19:10:04 +00:00
internetarchive.md Version v1.65.0 2023-11-26 16:07:39 +00:00
jottacloud.md Version v1.65.0 2023-11-26 16:07:39 +00:00
KEYS docs: document release signing and verification 2023-09-11 12:28:23 +01:00
koofr.md Version v1.65.0 2023-11-26 16:07:39 +00:00
licence.md docs: fix typo in license webpage 2022-07-06 11:25:31 +01:00
linkbox.md backend: add Linkbox backend 2023-11-18 17:14:45 +00:00
local.md Version v1.65.0 2023-11-26 16:07:39 +00:00
mailru.md Version v1.65.0 2023-11-26 16:07:39 +00:00
mega.md Version v1.65.0 2023-11-26 16:07:39 +00:00
memory.md docs: cleanup backend hashes sections 2023-11-20 17:43:57 +00:00
netstorage.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
onedrive.md Version v1.65.0 2023-11-26 16:07:39 +00:00
opendrive.md Version v1.65.0 2023-11-26 16:07:39 +00:00
oracleobjectstorage.md oracleobjectstorage: Support "backend restore" command - fixes #7371 2024-01-09 09:43:36 +00:00
overview.md imagekit: updated overview - supported operations 2024-01-17 16:38:54 +00:00
pcloud.md Version v1.65.0 2023-11-26 16:07:39 +00:00
pikpak.md Version v1.65.0 2023-11-26 16:07:39 +00:00
premiumizeme.md Version v1.65.0 2023-11-26 16:07:39 +00:00
privacy.md docs: improve grammar and fix typos (#5361) 2021-11-04 12:50:43 +01:00
protondrive.md Version v1.65.0 2023-11-26 16:07:39 +00:00
putio.md Version v1.65.0 2023-11-26 16:07:39 +00:00
qingstor.md Version v1.65.0 2023-11-26 16:07:39 +00:00
quatrix.md Version v1.65.0 2023-11-26 16:07:39 +00:00
rc.md Version v1.65.0 2023-11-26 16:07:39 +00:00
release_signing.md docs: document release signing and verification 2023-09-11 12:28:23 +01:00
remote_setup.md amazonclouddrive: remove Amazon Drive backend code and docs #7539 2024-01-04 17:05:54 +00:00
s3.md amazonclouddrive: remove Amazon Drive backend code and docs #7539 2024-01-04 17:05:54 +00:00
seafile.md Version v1.65.0 2023-11-26 16:07:39 +00:00
sftp.md Version v1.65.0 2023-11-26 16:07:39 +00:00
sharefile.md Version v1.65.0 2023-11-26 16:07:39 +00:00
sia.md Version v1.65.0 2023-11-26 16:07:39 +00:00
smb.md Version v1.65.0 2023-11-26 16:07:39 +00:00
sponsor.md docs: rename donate page to sponsor page and rework 2023-06-30 14:32:53 +01:00
storj.md storj: update satellite urls and labels 2023-02-06 13:18:15 +00:00
sugarsync.md Version v1.65.0 2023-11-26 16:07:39 +00:00
swift.md Version v1.65.0 2023-11-26 16:07:39 +00:00
tardigrade.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
union.md union: fix documentation 2023-10-21 10:37:43 +01:00
uptobox.md Version v1.65.0 2023-11-26 16:07:39 +00:00
webdav.md Version v1.65.0 2023-11-26 16:07:39 +00:00
yandex.md Version v1.65.0 2023-11-26 16:07:39 +00:00
zoho.md Version v1.65.0 2023-11-26 16:07:39 +00:00