To create new wiki account, please join us on #znc at freenode and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.

savebuff

From ZNC
Jump to: navigation, search

This module saves your channel buffers to a file so they can survive restarts and reboots.

Usage

Arguments

This network module takes up to one arguments. Either --ask-pass or the password itself (which may contain spaces) or nothing. If password is provided, the file will be encrypted

Read loading modules to learn more about loading modules.

Savebuff stores information in ~/.znc/users/<user>/networks/<network>/moddata/savebuff/. The filename is a MD5 hash of the username and channel name (in lowercase).

Client scripts and plugins

There are several scripts and plugins available to parse the actions sent by this module. You can find them below. In previous versions, this module helped parsing actions which happened on IRC, by adding JOINs, QUITs, etc. to the playback buffer with a not-really-human-readable format. It was recommended to be used in combination with a client script or plugin, otherwise the output was pretty much useless or rather annoying.

This feature was deprecated, however, and that functionality has moved to its own module, buffextras.

Note: These scripts are not required to use save buff, and only useful with previous versions.

Known Issues

Savebuff blocks starting ZNC

What am I supposed to do if I can't start ZNC because the savebuff module fails to decrypt its saved messages?

The easiest way to fix this is to enter the correct password.

The second easiest way is to remove savebuff's saved messages:

rm ~/.znc/users/*/networks/*/moddata/savebuff/.*

If you only want to remove the messages of some user, use this:

rm ~/.znc/users/<username>/networks/*/moddata/savebuff/.*

To avoid this error in the future, add your password to the ZNC config:

Via webadmin (Recommended)
Adding your password to the savebuff module in webadmin will safely make this change to the ZNC config file for you. Just enter the password into the text box and save.
By editing znc.conf
If you must edit znc.conf directly (be sure to stop ZNC first—see FAQ#How to reload ZNC config without restart?), change the line(s):
LoadModule = savebuff
…to include the password:
LoadModule = savebuff This is my secret pass