KOPANO-ARCHIVER(8)

💖 KOPANO-ARCHIVER(8) 💖

okay bestie, gather round, because we're about to talk about kopano-archiver — the little legend from the Kopano Core user reference that runs the whole archive situation for you. no cap, this one's a whole personality. 🗂️✨

---

✨ NAME ✨

kopano-archiver — manages kopano archives and performs the archive operation. that's it, that's the job. she does both. 💅

---

🌸 SYNOPSIS 🌸

kopano-archiver [OPTION...]

---

🦋 DESCRIPTION 🦋

so basically, this tool is how you attach or detach archives to a user's store. and what even is an archive? an archive is defined as a special non-active store or a folder inside such a store. that's the definition, take it or leave it. 📦

and on top of the whole managing-archives thing, this tool is also the one that performs the actual archive operation. if you use the -u option, the archiver can be told to archive a single store, or, like, literally all of them. main character energy honestly. 👑

---

🎀 ACTIONS 🎀

kopano-archiver needs an action command plus the appropriate options. the valid actions are, in order, no skipping:

• -l, --list — list archives for the specified user. the -u option is required here, don't forget it bestie.
• -L, --list-archiveusers — list the users that have an archive attached. simple, clean, iconic.
• -A, --archive — perform an archive run. if you give it a -u option, only the store of that one user gets archived. otherwise all stores get archived. optionally you can set the --local-only option so it only archives stores that exist on the server to which kopano-archiver is connected (usually the local server). 🖥️
• -C, --cleanup — perform an archive cleanup run. if a -u option is provided, only the archives of that one user get cleaned. otherwise all stores get cleaned. optionally the --local-only option can be set so it only cleans up archives of users that have their primary store on the server to which kopano-archiver is connected (usually the local server).
• -a archive, --attach-to archive — attach an archive to the store of the user specified with the -u option. if you don't specify any additional options, a folder gets created in the archive store, and that folder acts as the root of the archive for that user. the foldername gets set to the username of the user. want different behaviour? pass --archive-folder or --no-folder and it'll switch up. 🫶
• -d archive, --detach-from archive — detach an archive from the store of the user specified with the -u option. kopano-archiver will automatically figure out which folder to detach. BUT. if a user has two archives in one archive store, kopano-archiver won't be able to tell which one needs to be detached. in that case the folder has to be specified with the --archive-folder option. no guessing games, bestie. 😭
• -D archiveno, --detach archiveno — detach an archive from the store of the user specified with the -u option. the archive to detach is indicated by archiveno, and you can get that by running kopano-archiver -u username -l. iykyk. 🔥
• --auto-attach — when no user is specified with -u, all users will have their archives attached or detached based on the LDAP/ADS settings. if a user is specified, only that user's store gets processed. you can combine this with -A to force an auto-attach run regardless of the enable_auto_attach configuration option. forcing it? bold. we respect it. 💅
• --dump-config — displays the values of archiver.cfg configuration parameters and the implied defaults. peak transparency, we love to see it. 📋

---

💜 OPTIONS 💜

the options used by actions are as follows:

• -u username — use this parameter to specify a user on which store to perform the provided action. this one shows up everywhere, she's booked and busy.
• --local-only — if this option is passed when an archive run is started, only stores that exist on the server to which kopano-archiver is connected will be archived.
• --archive-folder foldername — use this option to force kopano-archiver to create the archive folder with a different name than the username of the user for whom you're attaching an archive.
• --archive-server serverpath — use this option to specify the path to the archive server. super useful when you're using the archiver in a non-multiserver setup.
• --no-folder — use this option to force kopano-archiver to create the root of the archive in the root of the archive store (the IPM subtree). heads up though: this way only one user store can be attached to an archive. one. single. user. choose wisely. 🚨
• -w — by default kopano-archiver makes an archive read-only for the user. by passing this option, the user gets read/write permissions in the attached archive.

this will override the auto_attach_writable configuration options when auto attaching archives.

• --writable yes|no — explicitly enable or disable write permissions when (auto) attaching archives.

this will override the auto_attach_writable configuration options when auto attaching archives.

• -c file — select an alternate config file to be used by kopano-archiver.
  • Default: /etc/kopano/archiver.cfg

---

🌈 EXAMPLES 🌈

okay now the fun part, copy-paste fuel:

for attaching an archive:

kopano-archiver -u username --attach-to archive

for attaching an archive with a custom archive name:

kopano-archiver -u username --attach-to archive --archive-name archivename

for attaching an archive without an archive folder:

kopano-archiver -u username --attach-to archive --no-folder

for detaching an archive:

kopano-archiver -u username --detach-from archive

for starting an archive run:

kopano-archiver -A

for starting an archive run for one user:

kopano-archiver -u username -A

for starting a cleanup run:

kopano-archiver -C

for starting a cleanup run for one user:

kopano-archiver -u username -C

ate. no crumbs. ✨

---

👑 AUTHOR 👑

written by Kopano. 💖

---

🧚 SEE ALSO 🧚

kopano-server(8), kopano-archiver.cfg(5) — go read those too, they're the supporting cast and they serve. 🎀

---

and that's the whole vibe bestie!! this page is straight from Kopano 8, dated November 2016 — old but iconic, fr fr. now go archive something responsibly. 🌸🦋⭐💅