openSUSE Build Service

Overview Repositories Revisions Requests Users Attributes Meta

File README.SUSE of Package limnoria

########### Limnoria IRC Bot - SUSE package ###########

Thanks for choosing to install the Limnoria IRC Bot using the this RPM package.
This installation allows for easy instantiations of many Limnoria instances, but it is just as easy to use for a single, simple, bot.
Whilst the focus is to not divert from upstream, there are some noteworthy points about this packaged version of Limnoria which you should be aware of - especially when referring to upstream documentation.

###########
# 1. Spawning new Limnoria instances

* `sudo -u limnoria limnoria_wizard-suse`
    This will launch a modified version of the upstream `limnoria_wizard` which takes care of all configuration and data paths automatically, leaving you only with questions actually relevant to the customization of the bot instance.

* `systemctl start limnoria@<instance>`, `sytemctl stop limnoria@<instance>`, `systemctl restart limnoria@<instance>`
    This will start/stop/restart the bot instance named <instance>. You defined the name of the instance during creation of the instance using the beforementioned script.

* `journalctl -u limnoria@<instance>`
    This will query syslog output of the bot instance. In most cases this is only relevant to troubleshoot startup errors, as regular log output will be printed to files in the log directory mentioned below.

* `systemctl enable limnoria@<instance>`
    This sets the bot instance to automatically start during boot.

###########
# 2. Removing a Limnoria instance
  * This is not yet implemented. If you are absolutely sure you know what you are doing, clean up all instance related directories, then remove the instance name from '/etc/limnoria/.limnoria.configured'

###########
# 3. Installing plugins
  * Using system packages:
    This is the recommended way. Please check if a package for your desired plugin exists in `zypper se limnoria` and install it using `zypper in limnoria-<plugin>`.

* Manually:
    If the plugin you wish to install is not available as a package, please install its source tree to /usr/local/limnoria/<instance>/plugins/<plugin>. Note that the leading directories may not yet exist - create them with 'limnoria' user and group ownership.

* Using pip:
    This is NOT recommended. Python libraries downloaded and installed from PyPi may conflict with system libraries. Maintaining pip installations is almost impossible - you do not benefit from regular updates and security patches in addition to entering the risk of installing unsigned code. Furthermore, pip installed libraries may conflict with system libraries.

###########
# 4. Loading plugins
  * In IRC:
    `/msg <bot nickname> load <plugin>`

###########
# 5. Noteworthy paths
  * Configuration files, which you should not edit manually (use `config` in IRC instead): /etc/limnoria/<instance>/
  * Log files will be stored in: /var/log/limnoria/<instance>/
  * Data of the internal webserver: /srv/www/limnoria/<instance>/
  * Other data and backups: /var/lib/limnoria/<instance>/

########### EOF ###########

Places

File README.SUSE of Package limnoria

Places