File: README

package info (click to toggle)
sbnc 1.2-26
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 6,216 kB
  • sloc: cpp: 17,556; ansic: 15,514; sh: 13,419; tcl: 5,567; php: 448; makefile: 284
file content (140 lines) | stat: -rw-r--r-- 4,955 bytes parent folder | download | duplicates (3)
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
shroudBNC 1.2
-------------

shroudBNC is a modular IRC proxy written in C++. It is capable of proxying
IRC connections for multiple users. Using TCL scripts it can be extended.

Installation
------------

First of all make sure that you have the following libraries (and development files) installed:

- openssl (if you're going to use ssl-encrypted connections; README.ssl
           contains more details about how to use SSL)
- tcl     (if you're going to use the tcl module, version 8.4 or later, earlier
           versions have not been tested)

In order to compile and install sbnc you will have to use the 'configure'
script which is included in the distribution of sbnc:

./configure
make
make install

(You need to use the GNU make utility on FreeBSD; i.e. use 'gmake' rather than 'make'.)

"make install" will install shroudBNC in a directory named "sbnc" in your home
directory.

Keep in mind that you need to change your current directory to ~/sbnc once you've
run "make install".

Once you've compiled sbnc you will need to edit shroudBNC's configuration
files:

You can do that by simply starting shroudBNC in the installation directory:

<--
shroud@hermes:~/sbnc$ ./sbnc
shroudBNC 1.2 $Revision: 1048 $- an object-oriented IRC bouncer
Sun May 27 08:39:51 2007: Log system initialized.
No valid configuration file has been found. A basic
configuration file can be created for you automatically. Please
answer the following questions:
1. Which port should the bouncer listen on (valid ports are in the range 1025 - 65535): 9000
2. What should the first user's name be? test
Please note that passwords will not be echoed while you type them.
3. Please enter a password for the first user:
4. Please confirm your password by typing it again:
Writing main configuration file... DONE
Writing first user's configuration file... DONE
Configuration has been successfully saved. Please restart shroudBNC now.
shroud@testbed:~/sbnc$
-->

After creating the configuration files you can start shroudBNC:

<--
shroud@testbed:~/sbnc$ ./sbnc
shroudBNC 1.2 $Revision: 1048 $- an object-oriented IRC bouncer
Daemonizing... DONE
shroud@testbed:~/sbnc$
-->

You might want to edit the sbnc.tcl if you plan to use the TCL module. Load
any scripts you want. You will have to rehash the tcl module after every
change you make to sbnc.tcl or any other .tcl script which you have loaded:

/sbnc tcl rehash (while you're connected to the bouncer using an IRC client)

Usage
-----

Just connect to the bouncer using your favorite IRC client. You will have to set
your username (i.e. e-mail address in most clients) to the accountname you've
chosen for your bouncer account.

Once you're connected you should type /msg -sBNC help to get a list of available commands.

shroudBNC supports oidentd in order to provide unique idents for each bouncer
user. You will need to enable ident-spoofing for the unix account you're using
to run shroudBNC if you want each user to have his/her own ident. Read oidentd's
manual or http://board.shroudbnc.info/index.php?t=msg&th=9 for more details.

TCL
---

The tcl module is automatically built and installed if the configure script
was able to find the appropriate tcl libraries and headers.

If the configure script was unable to find the TCL libraries/headers and you
are sure that they are installed you might use the --with-tcl parameter to
specify the location of the tclConfig.sh file manually; e.g.:

./configure --with-tcl=/usr/local/ActiveTcl/tcl8.4

Updating shroudBNC
------------------

shroudBNC can be updated while it is running - without losing any active irc
or client connections. In order to update it you need to extract a clean copy
of shroudBNC somewhere.

After compiling it you can run the "make update" script which will
automatically update your currently running shroudBNC. (The script assumes
that the bouncer's directory is ~/sbnc/).

Please note that "make update" can NOT be used to update from old
version of shroudBNC (i.e. version 1.1 and before; this also
includes the beta version of shroudBNC 1.2).

Security
--------

It is vital that you understand that any bouncer admin has access to:

a) the shell account where the bouncer is running
b) any user connections

Using the TCL module any admin can perform shell commands (using the exec
command) and send IRC commands for any user's connection. Thus you should
choose your admins wisely. Do not load arbitrary scripts and make sure you
understand any scripts you want to load.

Credits
-------

I'd like to thank all the beta testers who have been using shroudBNC so far.
Feature requests and bug reports are welcome; please send them to: 
gb@prco23.org

In case you encounter problems while compiling and/or using shroudBNC you can
contact us on IRC:

Server: irc.quakenet.org / 6667
Channel: #sbnc

Third Party Software
--------------------

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit.