kopano-storeadm(8)

💖 kopano-storeadm — store management utility 💖

okay bestie, gather round, because this is the Kopano Groupware Core reference page for kopano-storeadm and it's literally the little tool that handles all your message stores. she's an 8, she's iconic, and she's here to help you create, delete, attach and detach stores like it's nothing. no cap.

---

✨ SYNOPSIS ✨

kopano-storeadm {-A guid|-C|-D|-M|-O|-P|-R guid|-V} [-c file] [-h uri]
[-k company] [-n name] [-p] [-t {user|archive|group|company}]

---

🌸 DESCRIPTION 🌸

so. this tool manages message stores on the Kopano server. that's the whole vibe. specifically it lets you create, delete, attach and detach those stores.

🚨 important queen: the storage server must be running for kopano-storeadm to work. no server, no slay. it's giving "waiting at the club and the bouncer never shows up".

---

💅 OPTIONS 💅

• -A guid — okay this one does one of two things depending on your friends. with -n, an orphaned store gets attached (hooked 🪝) to the account you named with -n. heads up: if the target user already has a store attached, that one gets detached first, no hard feelings. OR, when you use -p, an orphaned store gets copied instead. see -p below for the tea.
• -C — create a brand new store and attach it to the user account you gave with -n. that account must NOT already have a store, periodt. if it does, this is not the move.
• -D — detach (unhook) the store from the user account specified with -n. bye bestie 👋
• -M — lists ALL the mailboxes (stores) the server knows about. a whole roster. 🌈
• -O — shows a list of stores that aren't hooked to any user (the orphans 🥺). the GUIDs in that output can be passed straight to -A or -R. very useful, very cunty.
• -P — create a public store. and listen: only one public store can be created. one. singular. don't be greedy. 👑
• -R guid — remove an orphaned store. ngl it doesn't actually fully delete it, it just marks it as deleted in the database and the softdelete mechanism will remove it later on. so it's a "she's on her way out" situation, not an instant vanish. 💀
• -V — display the program version. flex the build, bestie.
• -c config-file — location of a config file to read.

Default: /etc/kopano/admin.cfg

• -h host — URI for a specific server to connect to and execute the action on.

Default: default:

• -k company-name — sets the company name for the -P action. lowkey niche: this option is only available for multi-tenancy Kopano. 🏢
• -l locale — when you create a new store with -C or -P, the standard folders like Inbox, Drafts, Sent Items, etc. get translated into the language you pick. a locale name is typically language[_territory], where language is an ISO-639 language code and territory is an ISO-3166 country code — but inherently these are system-specific, so it depends on your setup. on Linux systems, see locale(1) for details. 🌍
• -n entity-name — for -C and -D, this specifies the user to work on. for -A, it specifies the user name, group name or company name to operate on. if the implicit default "user" isn't the right vibe, you may need to specify the store type with -t.
• -p — for use with -A. instead of attaching an orphaned store to a user account, the orphaned store's contents get copied into "Public Store\Admin\Deleted User - username". and the orphaned store itself? left unmodified, untouched, unbothered. 💖
• -t {user|archive|group|company} — the store type for the entity specified with -n. if you don't specify it, -t user is implicitly assumed. (this option only has an effect when used with -A or -D, iykyk.)

---

🎀 EXAMPLES 🎀

1. create new store for user: kopano-storeadm -Cn user1
2. create new store with German names: kopano-storeadm -Cn user1 -l de_DE
3. attach orphaned store to user: kopano-storeadm -A 24680B -n user2
4. copy orphaned store to public: kopano-storeadm -A 24680B -p
5. detach store from user: kopano-storeadm -Dn user2
6. remove store: kopano-storeadm -R 24680B
7. create pubilc store: kopano-storeadm -P

(that last one says "pubilc" in the original and honestly? we respect the typo. she's doing her best 🫶)

---

🧚 CONFIGURATION FILE 🧚

normally, no configuration file is used or required. but if the file /etc/kopano/admin.cfg exists, it is used. here's what you can set in there:

🌸 default_store_locale

new folders created as part of the initial store creation (see -C) will use the language of the locale. a suitable locale string is in the form of an ISO 639 code for the language, followed by an underscore, followed by an ISO 3166 code for the region, e.g. de_DE, en_US, etc.

Default: (empty)

🌸 server_socket

URI for the connection to the Kopano server.

Default: (localhost connection via socket)

🌸 sslkey_file

use this file as key to logon to the server. this is only used when server_socket is set to an HTTPS transport. see the kopano-server(8) manual page on how to setup SSL keys. 🔐

🌸 sslkey_pass

the password of the SSL key file that is set in sslkey_file.

---

okay that's the whole page, you're fully caught up, you're literally a store management icon now 👑✨

this was Kopano 8, dated 2018-01-11, and it's the kopano-storeadm(8) manual page. go forth and manage those stores, bestie 💖🦋🌸