COOLCONFIG(1)

πŸ“¦ version 25.04.12, in nixos 26.05, nixpkgs unstable

πŸ’– coolconfig β€” the Collabora Online config bestie πŸ’–

okay bestie, you're reading the COOLCONFIG(1) manual, aka the User Commands corner of the Unix universe, and this page is literally all about coolconfig. πŸ’…βœ¨

🌸 NAME 🌸

coolconfig β€” the configuration tool for Collabora Online. πŸŽ€

πŸ¦‹ SYNOPSIS πŸ¦‹

coolconfig COMMAND [OPTIONS]

πŸŽ€ COMMANDS AND OPTIONS πŸŽ€

🌈 General options 🌈

  • -h, --help β€” shows this usage information, like a little β€œhere’s how to use me” moment. 🫢
  • --config-file=path β€” manually sets the configuration file path. The default is usually /etc/coolwsd/coolwsd.xml. πŸ“

🧚 anonymize 🧚

okay so anonymize is your log-reading helper. If you know a document and/or a user had an issue, you can find their session in the logs by running this command with the username and/or document name, and you get the anonymized hash β€” that’s the thing you use to search the logs with. πŸ”πŸ’–

anonymize [string-1]...[string-n]
  • --anonymization-salt=salt β€” anonymizes strings with the given 64-bit salt instead of the one in the config file. πŸ§‚βœ¨

πŸ¦‹ migrateconfig πŸ¦‹

migrateconfig is the glow-up command that migrates the config file of Collabora Online 6.4 or older to the new format. πŸ’«

migrateconfig [--old-config-file=<path>] [--config-file=<path>] [--write]
  • --old-config-file=path β€” manually specifies the file path for the old configuration. The default is /etc/loolwsd/loolwsd.xml. πŸ“œ
  • --write β€” writes the migrated configuration. Without this option, no changes are written to the config file; only information about differences between old and new config is printed. πŸ‘€

Example:

Example: coolconfig migrateconfig
--old-config-file=/etc/loolwsd/loolwsd.xml
--config-file=/etc/coolwsd/coolwsd.xml --write

🌟 set 🌟

The set command changes an existing configuration setting in the config file. The <key> is the XPath expression of the config item in the config XML file (coolwsd.xml). πŸ”‘

set <key> <value>

Example: coolconfig set logging.level trace

πŸ‘‘ set-admin-password πŸ‘‘

set-admin-password sets the user name and password of the administrator who can access Collabora Online's admin console. πŸ›‘οΈ

set-admin-password
  • --pwd-salt-length=number β€” length of the salt to use to hash password. πŸ§‚
  • --pwd-iterations=number β€” number of iterations to do in PKDBF2 password hashing. πŸ”
  • --pwd-hash-length=number β€” length of password hash to generate. πŸ”
  • --user=name β€” user name for the admin console. If unspecified, it will be requested on the terminal. πŸ™‹
  • --password=password β€” password for the admin console. If unspecified, it will be requested on the terminal. 🀫

🎨 update-system-template 🎨

update-system-template updates Collabora Online's system template. It is used typically when new fonts are added to the system that need to be used with Collabora Online. πŸ”€πŸ’–

update-system-template

πŸ—οΈ generate-proof-key πŸ—οΈ

generate-proof-key creates an RSA key pair in /etc/coolwsd for the WOPI Proof headers. The postinstall script of the coolwsd package usually creates this RSA key pair in case of new installation. ✨

generate-proof-key

πŸ’œ SEE ALSO πŸ’œ


this page comes from coolconfig, dated Jul 2023, and the manual is COOLCONFIG(1) β€” bye bestie, go config slay πŸ’…βœ¨

πŸ“¦ where this page comes from