KOPANO-UNIX.CFG(5)

📦 version 8.7.0, in ubuntu jammy

💖 KOPANO-UNIX.CFG — the Kopano Unix user plugin config file 💖

okay so bestie, welcome to kopano-unix.cfg(5), part of the Kopano Core user reference. this is THE page about the config file for the unix user plugin, and i'm gonna walk you through every single bit of it. grab a snack. 🍓

✨ SYNOPSIS ✨

unix.cfg

🌸 DESCRIPTION 🌸

so unix.cfg is a configuration file for the unix user plugin. every single option you need to correctly retrieve user and group info lives right here. that's it, that's the file. 💅

🎀 FILE FORMAT 🎀

the file is one big section, but honestly the parameters can be grouped by functionality if you want to keep things cute and organized.

parameters are written like this:

name = value

the file is line-based. every newline-terminated line is either a comment, nothing at all, a parameter, or a directive. no in-between.

a line that starts with # is a comment, and Kopano will just ignore it. parameter names are case sensitive bestie, don't play with them. and lines beginning with ! are directives.

directives look like this:

!directive [argument(s)]

the directives that exist are:

  • include — include and process argument.

example: !include common.cfg

👑 EXPLANATION OF EACH PARAMETER 👑

🦋 fullname_charset

the charset used in /etc/passwd for a user's fullname. in most setups us-ascii is used, but it could also be iso-8859-15. literally every charset your system's iconv() supports works here. since iso-8859-15 is an extension of us-ascii, that's the default — so high characters for most latin languages are covered. if your default shell is in UTF-8 (peep your locale settings 👀), put utf-8 here.

Default: iso-8859-15

🦋 default_domain

the default domain name to set as the e-mail address. when a user gets created, their email address is set to username@default_domain.

Default: no default present.

🦋 min_user_uid

the minimal uid a user must have to be created as a Kopano user. this exists to skip the system users chillin' in the /etc/passwd file. normally, users start at 1000.

Default: 1000

🦋 max_user_uid

the maximum uid a user may have to be created as a Kopano user. this is how we skip system users in /etc/passwd with a high uid — like user nobody does. 💀

Default: 10000

🦋 except_user_uids

a whitespace separated list of uids that are inside the min_user_uid and max_user_uid range but should not be considered users. exceptions, periodt.

Default: empty

🦋 min_group_gid

the minimal gid a group must have to be created as a Kopano group. this skips the system groups hanging out in the /etc/group file. normally, groups start at 1000.

Default: 1000

🦋 max_group_gid

the maximum gid a group may have to be created as a Kopano group. this skips system groups in /etc/group with a high gid — like group nogroup. not today.

Default: 10000

🦋 except_group_gids

a whitespace separated list of gids inside the min_group_gid and max_group_gid range that should not be considered groups.

Default: empty

🦋 non_login_shell

a space-separated list of shells. if a user account has one of these set as its login shell, the matching Kopano user account gets marked as locked. mail can still be delivered to that user's inbox, but the user cannot directly login with this username. locked but still receiving mail, it's giving "read the room but don't reply." 🙈

Default: /bin/false

💜 USER ATTRIBUTES 💜

not all Kopano attributes can be used from the system files. the following attributes are used from the system files:

  • username — the login name of the user.
  • fullname — the fullname of the user.
  • password — the password is in the /etc/shadow file. Kopano needs read access to this file to correctly work with the Unix plugin. yes, read access. it needs it. give it. 🫶

other attributes like quota settings, admin setting and e-mail address are kept in the database, exactly like the db user plugin does.

🌈 FILES 🌈

  • /etc/kopano/server.cfg — the server configuration file.
  • /etc/kopano/unix.cfg — the Kopano Unix user plugin configuration file.

🌟 AUTHOR 🌟

Written by Kopano.

🔥 SEE ALSO 🔥

kopano-server(8), kopano-server.cfg(5)

and that's the whole page bestie, you ate it 💅✨ — this was Kopano 8, from November 2016, and you're officially obsessed with kopano-unix.cfg now. mwah. 🎀💖

📦 where this page comes from