anna/INSTALL.txt at master · maffe/anna · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
Up-to-date information can always be found on the wiki [5].

To install and run the chatbot, you will have to install a few
software-packages as well as download some data. This guide should
help you get started.


   ## 0) PREPARATIONS ##

Dependencies:

- Python: 2.5 compatible release (2.5 <= 2.x < 3.0). [1]
- Sqlalchemy 0.4.5 is known to work. Needed for the agenda, factoids and
  reactions plugin. [2]
- PyXMPP 1.0.0 is known to work. Needed for the XMPP frontend. [3]
- Python IRC library [6] 0.4.6 needed for the IRC frontend.


   ## 1) DOWNLOAD ##

Currently the source-code is only available through subversion. To
download the latest trunk, execute the following command:

  $ svn checkout https://0brg.net/svn/anna/trunk

If you don't have a subversion client you can get the official client
[4], or search the web for another one.


   ## 2) INSTALL ##

The only thing to install is the configuration-file, but the program
should do this for you automatically. Try running this first:

  $ ./anna console

If an error occured, create a directory called ".anna" in your home
directory and copy the sample.conf file to it. Rename it to "anna.conf"
and edit the values as appropriate.


   ## 3) EXECUTE ##

To see the list of available frontends, run:

  $ ./anna --list

To run the bot with the chosen frontend, run:

  $ ./anna FRONTEND_NAME

You can supply multiple frontends to run simultaneously, seperated by
spaces.


   ## 4) EXECUTE IN BACKGROUND ##

Once the chatbot is up and running, you will probably want to run it in
the background and close the login sessions you have with the server.
This command won't do the trick though:

  $ ./anna &

The problem is that, in case you're using SSH at least, once you
disconnect from the server by typing "exit", for example, the HANGUP
(HUP for short) signal is sent to all running processes of your session.
This includes the anna process you started above. To prevent this from
happening, use the nohup command:

  $ nohup ./anna &

The nohup command catches all HANGUP signals sent to it and ignores them.
This will also mean that, once logged out, there will be no way to pull
the running bot in fore-ground again. If you want that, use screen. more
information on screen can be found with the man command; "man screen".

A small note about nohup; it saves all output (stdout as well as stderr)
to a file called nohup.out in your working directory. This means that all
debugging will be stored in a file. After a while, this file can grow
pretty large. If you don't want that, try this:

  $ nohup ./anna &> /dev/null &


   ## 5) MISCELLANEOUS ##

Want to complain? Contribute? Dance? join us in:
bob at conference.jabber.xs4all.nl

Good luck =]

[1] http://www.python.org/
[2] http://www.sqlalchemy.org/
[3] http://pyxmpp.jajcus.net/
[4] http://subversion.tigris.org/
[5] https://0brg.net/anna/wiki/Install
[6] http://python-irclib.sourceforge.net/