Edit History

Wiki

Version 14 (Gunnar Beutner, 08/16/2011 06:16 am)

1 1 
h1. shroudBNC
2 1 






    3
    1
    
    
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.






    4
    1
    
    






    5
    13
    Gunnar Beutner
    
Among its features you can find a user-friendly web interface (written in TCL and PHP) which allows you to easily create and manage your users. Some [[Web11Screenshots|screenshots]] are also available.






    6
    1
    
    






    7
    1
    
    
A variety of operating systems are currently supported: Linux and FreeBSD (and possibly other variations of BSD).






    8
    1
    
    






    9
    1
    
    
h2. Features (summary)






    10
    1
    
    






    11
    1
    
    
* support for TCL scripts and partial emulation of eggdrop commands






    12
    1
    
    
* web interface (which can easily be customized)






    13
    1
    
    
* SSL support for both IRC and client connections; including support for client-certificates (and thus public key/passwordless authentication)






    14
    1
    
    
* built-in flood protection (so you do not get "excess flood" errors)






    15
    1
    
    
* module support (c++ shared libraries)






    16
    1
    
    
* asynchronous dns resolving so the bouncer does not freeze while users reconnect






    17
    1
    
    
* private messages are logged when users are not connected to the bouncer






    18
    1
    
    
* support for IPv6






    19
    1
    
    
* vhost.tcl: limit number of users per virtual host






    20
    1
    
    
* virtual.tcl: adds "groups" and "virtual admins" who are able to create/manage users within their own group






    21
    1
    
    
* lock.tcl: allows you to disable settings for specific users or globally






    22
    1
    
    
* partyline.tcl: "internal" channels for bouncer users






    23
    1
    
    
* and a lot more...






    24
    2
    Gunnar Beutner
    






    25
    2
    Gunnar Beutner
    
h2. Downloads






    26
    2
    Gunnar Beutner
    






    27
    2
    Gunnar Beutner
    
The following downloads are currently available:






    28
    2
    Gunnar Beutner
    






    29
    2
    Gunnar Beutner
    
h3. shroudBNC 1.1 (stable release)






    30
    2
    Gunnar Beutner
    






    31
    6
    Gunnar Beutner
    
* source .tar.gz:	"sbnc-1.1.tar.gz":http://ng.shroudbnc.info/redmine/attachments/download/1/sbnc-1.1.tar.gz






    32
    14
    Gunnar Beutner
    
* web interface .tar.gz:	"sbnc-1.1webifc.tar.gz":http://ng.shroudbnc.info/redmine/attachments/download/29/sbnc-1.1webifc.tar.gz






    33
    3
    Gunnar Beutner
    






    34
    2
    Gunnar Beutner
    
Note: You should not use the web interface from 1.1 with version 1.2; it won't work as expected.






    35
    2
    Gunnar Beutner
    






    36
    1
    
    
h3. shroudBNC 1.2 (new release)






    37
    1
    
    






    38
    6
    Gunnar Beutner
    
* source .tar.gz:	"sbnc-1.2.tar.gz":http://ng.shroudbnc.info/redmine/attachments/download/7/sbnc-1.2.tar.gz






    39
    3
    Gunnar Beutner
    
* web interface .tar.gz:	not yet available






    40
    2
    Gunnar Beutner
    






    41
    3
    Gunnar Beutner
    
h3. shroudBNC development (git access)






    42
    3
    Gunnar Beutner
    






    43
    3
    Gunnar Beutner
    
* github:	http://github.com/gunnarbeutner/shroudbnc






    44
    3
    Gunnar Beutner
    
* git url:	git://github.com/gunnarbeutner/shroudbnc.git






    45
    3
    Gunnar Beutner
    






    46
    2
    Gunnar Beutner
    
If you are unsure which .tar.gz is the right one you should probably pick the "shroudBNC 1.2 (new release)" package.






    47
    2
    Gunnar Beutner
    






    48
    9
    Gunnar Beutner
    
If you plan to submit patches for shroudBNC you should use the Git repository.






    49
    4
    Gunnar Beutner
    






    50
    4
    Gunnar Beutner
    
h2. Support






    51
    4
    Gunnar Beutner
    






    52
    4
    Gunnar Beutner
    
Are you having problems with installing or running shroudBNC?






    53
    4
    Gunnar Beutner
    






    54
    4
    Gunnar Beutner
    
In case you have not found a solution in the README files which are contained in the shroudBNC .tar.gz you can try the following support methods:






    55
    4
    Gunnar Beutner
    






    56
    7
    Gunnar Beutner
    
* "Wiki:":http://wiki.shroudbnc.info/ - Our wiki provides information about setting up shroudBNC and frequently asked questions.






    57
    7
    Gunnar Beutner
    
* IRC: #sbnc @ irc.quakenet.org	- There's usually someone available at our IRC channel who can help you with your questions.






    58
    7
    Gunnar Beutner
    
* "Board:":http://board.shroudbnc.info/ - Ask your questions or post feature suggestions on our forums.






    59
    4
    Gunnar Beutner
    






    60
    4
    Gunnar Beutner
    
We offer a lot of support for shroudBNC - however you can also support us:






    61
    4
    Gunnar Beutner
    






    62
    8
    Gunnar Beutner
    
"Donations":http://sourceforge.net/donate/index.php?group_id=133833 will help me to keep working on this project.