Optimized for usage on [Openshift's cloud platform] (https://www.openshift.com/), with help from the fine folks in [#Openshift] (http://irc.lc/freenode/openshift) and [#Cloudbot] (http://irc.lc/espernet/cloudbot).
Databases and logs will be stored in $OPENSHIFT_HOMEDIR/app-root/data/persist/ (See db.py & cloudbot.py).
Stdout and stderr are stored in $OPENSHIFT_HOMEDIR/app-root/data/cloudbot.log. (See my action_hooks).
Be aware — there are other small tweaks that have been made which reflect my personal preference (changed commands, disabled plugins, etc.).
Instructions modified from Openshift's Piwik Quickstart.
Create an account at https://www.openshift.com
Install RHC tools at https://www.openshift.com/developers/rhc-client-tools-install
Create a Python application with a Cron cartridge:
rhc app create -a cloudbot python-2.7 cron-1.4
Add this upstream Openshift-enabled Cloudbot repo (develop branch):
cd cloudbot
git remote add upstream -m develop git://github.com/whispy/CloudBot.git
git pull -s recursive -X theirs upstream develop
Push the local repository to your OpenShift repo (this may take a long while! Do not prematurely terminate the push!):
git push
Rename config.default to config and edit it with your preferred settings, then commit and push to Openshift again.
pip should automatically install the bot's requirements from the requirements.txt file. If it does not, then SSH into your application, navigate to the repo folder, and reinstall the requirements.txt. This may take a long while:
rhc ssh
cd app-root/runtime/repo
pip uninstall -r requirements.txt
pip install -r requirements.txt
The second to last line should say Successfully installed GitPython lxml pydns BeautifulSoup4 pycrypto gitdb httplib2 async smmap. Then:
gear restart
Select either 1 or 2 (whichever is labeled python-2.7). Then, to ensure the cloudbot.py process is running:
ps -ef
If it is not, run:
python cloudbot.py
CloudBot is a Python IRC bot based on Skybot by rmmh.
Get CloudBot at https://github.com/ClouDev/CloudBot/zipball/develop.
Unzip the resulting file, and continue to read this document.
Before you can run the bot, you need to install a few Python dependencies. LXML is required while Enchant and PyDNS are needed for several plugins.
These can be installed with pip (The Python package manager):
[sudo] pip install -r requirements.txt
If you use pip, you will also need the following packages on linux or pip will fail to install the requirements.
python, python-dev, libenchant-dev, libenchant1c2a, libxslt-dev, libxml2-dev.
curl -O http://python-distribute.org/distribute_setup.py # or download with your browser on windows
python distribute_setup.py
easy_install pip
If you are unable to use pip, there are Windows installers for LXML available for 64 bit and 32 bit versions of Python.
Before you run the bot, rename config.default to config and edit it with your preferred settings.
Once you have installed the required dependencies and renamed the config file, you can run the bot! Make sure you are in the correct folder and run the following command:
python bot.py
On Windows you can usually just double-click bot.py to start the bot, as long as you have Python installed correctly.
To configure your CloudBot, visit the Config Wiki Page.
To write your own plugins, visit the Plugin Wiki Page.
More at the Wiki Main Page.
(some of the information on the wiki is outdated and needs to be rewritten)
The developers reside in #CloudBot on EsperNet and would be glad to help you.
If you think you have found a bug/have a idea/suggestion, please open a issue here on Github.
CloudBot runs on Python 2.7.x. It is currently developed on Windows 8 with Python 2.7.5.
It requires the Python module lXML.
The module Enchant is needed for the spellcheck plugin.
The module PyDNS is needed for SRV record lookup in the mcping plugin.
Windows users: Windows compatibility some plugins is broken (such as ping), but we do intend to add it. Eventually.
You can find a number of example bots in #CloudBot.
CloudBot is licensed under the GPL v3 license. The terms are as follows.
CloudBot
Copyright © 2011-2014 Luke Rogers
CloudBot is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
CloudBot is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with CloudBot. If not, see <http://www.gnu.org/licenses/>.