← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gozerbot/utopic

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Malcolm
  • Date: 2009-09-14 09:00:29 UTC
  • mfrom: (1.1.4 upstream) (3.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20090914090029-uval0ekt72kmklxw
Tags: 0.9.1.3-3
http://bugs.debian.org/546435
Changed dependency on python-setuptools to python-pkg-resources
(Closes: #546435) 

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.txt
 
1
GOZERBOT 0.9.1 README
 
2
=====================
 
3
 
 
4
welcome to GOZERBOT ;] see http://gozerbot.org
 
5
 
 
6
0.9.1 Requirements 
 
7
~~~~~~~~~~~~~~~~~~
 
8
    * a shell
 
9
    * python 2.5
 
10
    * setuptools
 
11
    * gnupg
 
12
    * simplejson
 
13
    * sqlalchemy
 
14
 
 
15
install
 
16
~~~~~~~
 
17
 
 
18
    !! make a separate user and group for the bot !!
 
19
 
 
20
    (local)
 
21
 
 
22
    * wget http://gozerbot.org/gozerbot-0.9.1all.tar.gz
 
23
    * untar it
 
24
 
 
25
    (global)
 
26
 
 
27
    * run "easy_install gozerbot gozerplugs"
 
28
 
 
29
config
 
30
~~~~~~
 
31
 
 
32
    * run gozerbot-init
 
33
    * edit gozerdata/mainconfig and gozerdata/fleet/default/config
 
34
 
 
35
start the bot
 
36
~~~~~~~~~~~~~
 
37
 
 
38
    * gozerbot-start is for bots running from ~/.gozerbot
 
39
    * otherwise use the gozerbot program .. gozerbot (global) or 
 
40
      ./bin/gozerbot (local)
 
41
    * if you want to run the bot as a daemon do "gozerbot >> log 2>&1 &"
 
42
 
 
43
next
 
44
~~~~
 
45
 
 
46
    * on first startup the bot doesn't join any channels, you will have to
 
47
      /msg thebot !join #channel .. the bot wil remember channels it has joined
 
48
    * you can use the "meet <nick>" command to add other users to the bot
 
49
    * if you installed the gozerplugs package, the plugins will not be loaded
 
50
      on default. use !reload <plugin> to enable a plugin. see the !available
 
51
      command to see what plugins can be reloaded
 
52
    * when using commands in a /msg use --chan <channel> to let the command
 
53
      operate on a channel .. default channel in a /msg is the users nick
 
54
    
 
55
plugin configuration
 
56
~~~~~~~~~~~~~~~~~~~~
 
57
 
 
58
    - plugin config can be done with the <plugname>-cfg command
 
59
      usage:
 
60
      ::
 
61
 
 
62
        !<plugname>-cfg                   ->      shows list of all config
 
63
        !<plugname>-cfg key value         ->      sets value to key
 
64
        !<plugname>-cfg key               ->      shows list of key
 
65
        !<plugname>-cfg key add value     ->      adds value to list
 
66
        !<plugname>-cfg key remove value  ->      removes value from list
 
67
        !<plugname>-cfg key clear         ->      clears entire list
 
68
        !<plugname>-cfgsave               ->      force save configuration to disk
 
69
 
 
70
    - or edit gozerdata/plugs/<plugname>/config
 
71
 
 
72
notes
 
73
~~~~~
 
74
 
 
75
    - we are on #dunkbots IRCnet
 
76
 
 
77
    - MAKE REGULAR BACKUPS OF YOUR BOT DIRECTORY
 
78
 
 
79
    - see http://gozerbot.org for the bot's documentation
 
80
 
 
81
database support:
 
82
~~~~~~~~~~~~~~~~~
 
83
 
 
84
    - gozerbot now uses sqlalchemy which will created the tables needed
 
85
    - sqlite3 is now default
 
86
    - for mysql support:
 
87
 
 
88
    ==> since we use utf-8 now mysql version 5 is required for non ascii users
 
89
  
 
90
    1) create the bot database in mysql:
 
91
       CREATE DATABASE gb_db;
 
92
    2) once you've done that add mysql access rules for the bot user:
 
93
       GRANT ALL PRIVILEGES ON gb_db.* TO user@host IDENTIFIED by 'pass';
 
94
       FLUSH PRIVILEGES;
 
95
    3) edit the gozerdata/mainconfig file to set dbtype to 'mysql' and dbname
 
96
       to 'gb_db'
 
97
 
 
98
upgrading
 
99
~~~~~~~~~
 
100
 
 
101
    - run gozerbot-upgrade <oldbotdir> <newbotdir> .. 0.7 upgrading is not
 
102
      supported yet
 
103
 
 
104
links
 
105
~~~~~
 
106
::
 
107
 
 
108
    main site - http://gozerbot.org
 
109
    blog - http://blog.gozerbot.org
 
110
    docs - http://gozerbot.org
 
111
    development - http://dev.gozerbot.org
 
112
 
 
113
LAST NOTE
 
114
~~~~~~~~~
 
115
 
 
116
check http://blog.gozerbot.org for security "need to upgrade" notices.
 
117
put a rss watcher on it ;]