Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-06 15:29:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

configuration: reorder editing config manually section

Browse Source 
It's better to disable flushing first, rather than risk having your changes overwritten...
This commit is contained in:
James Lu
2025-02-03 21:37:18 -08:00
parent 947e800fbb
commit f8fc966d98
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
use/configuration.rst
View File

@ -157,22 +157,23 @@ Note that channel-specific settings take precedence over network-specific ones.
Finally, you can also unset any channel-specific or network-specific variables Finally, you can also unset any channel-specific or network-specific variables
with the ``config reset channel`` and ``config reset network`` commands. with the ``config reset channel`` and ``config reset network`` commands.
Editing the Configuration Values by Hand Editing the Config Manually
---------------------------------------- ---------------------------
NOTE: **We don't recommend this; you should normally .. note::
do everything with the commands in the Config plugin.** We don't recommend this; you should normally do everything with the commands
in the Config plugin.
To reload Limnoria's configuration from disk, use the ``config reload`` command. Before editing the config manually, you should either stop the bot or
set the ``supybot.flush`` option to ``false`` to prevent Limnoria from
writing its config out and overwriting your changes.
Once you have made your changes, use the ``config reload`` command to reload
Limnoria's configuration from disk.
This will refresh the bot's main configuration as well as any user/channel/ignore This will refresh the bot's main configuration as well as any user/channel/ignore
databases, which are stored by default in separate files under the ``conf/`` databases, which are stored by default in separate files under the ``conf/``
directory. directory.
Note that Limnoria writes its configuration files to disk periodically,
so it may overwrite manual edits to configuration files.
To prevent this, set the ``supybot.flush`` option to ``false`` while editing
its config files to disable automatic flushing.
If you cannot access the bot on IRC and your bot is running on a POSIX If you cannot access the bot on IRC and your bot is running on a POSIX
system, you can also send it a SIGHUP signal; it is exactly the same system, you can also send it a SIGHUP signal; it is exactly the same
as ``config reload`` (note that the Config plugin has to be loaded for this as ``config reload`` (note that the Config plugin has to be loaded for this