Commit 01dca7e2 authored by Svetlana A. Tkachenko's avatar Svetlana A. Tkachenko
Browse files

Updates install instructions

parent 5bc2e894
1) Download
Use your operating system installer to download Guppy on these systems:
* Archlinux
* Windows (coming soon)
Alternatively, use wget to download guppy over http, or git.
* (git instructions coming soon)
2) Directory structure
After downloading guppy, the directory structure will be similar to something like this:
conf/
......@@ -10,11 +23,11 @@ After downloading guppy, the directory structure will be similar to something li
The extra/ directory contains plugins that are either unfinished or very specific, you will usually not need them. (You can put them in plugins/ before running the install script, if you need them, but do please read them first if you decide to do so.)
The dist/ directory contains installation scripts for certain operating systems, this may be useful if you are using them. Currently available install scripts are for:
The dist/ directory contains installation scripts for supported operating systems.
Archlinux
3) Configuration
If this is not your distro, run the guppy executably once to launch the installer script.
Run the guppy executably once to launch the installer script.
$ ./guppy
......@@ -22,12 +35,13 @@ It will prompt you with a list of plugins. Choose carefully, the default is mini
$ ./guppy
__ _ _ _ _ __ _ __ _ _
__ _ _ _ _ __ _ __ _ _
/ _` | | | | '_ \| '_ \| | | | http://repo.or.cz/w/guppy.git/summary
| (_| | |_| | |_) | |_) | |_| | irc://irc.freenode.net/guppy
\__, |\__,_| .__/| .__/ \__, | http://guppy.gshellz.org
|___/ |_| |_| |___/ version 0.4.3
\__, |\__,_| .__/| .__/ \__, | http://guppy.uk.to
|___/ |_| |_| |___/ version 0.4.4
Settings directory: /home/test/tests/ircd/guppy/conf/
No configuration file found, running makeconf
What IRC network do I connect to (just the name)? []: gnu
......@@ -36,6 +50,8 @@ It will prompt you with a list of plugins. Choose carefully, the default is mini
What nickname should I use? []:
...
4) Running in background
After the configuration, the binary will exit, and you will need to start it again in screen or tmux with no arguments; guppy does not fork into the background.
$ screen -U ./guppy
......@@ -45,6 +61,8 @@ or
$ tmux ./guppy
5) Authentication
Once the bot joins the channel, if you loaded auth plugin, you will need to set up your password. Otherwise anyone who uses your nickname can control the bot. Use the "passwd" command in PM with the bot to set a new password.
<rob> passwd lam3r lam3r
......
......@@ -41,7 +41,7 @@ class main(object):
print(" __ _ _ _ _ __ _ __ _ _ ")
print(" / _` | | | | '_ \| '_ \| | | | http://repo.or.cz/w/guppy.git/summary")
print("| (_| | |_| | |_) | |_) | |_| | irc://irc.freenode.net/guppy")
print(" \__, |\__,_| .__/| .__/ \__, | ")
print(" \__, |\__,_| .__/| .__/ \__, | http://guppy.uk.to")
print(" |___/ |_| |_| |___/ version " + self.version)
print("PID: " + str(os.getpid()))
self.directory = self.homedir + '/conf/'
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment