For a quick start, see the bottom of this file.
-Why ctrlproxy?
---------------
-CtrlProxy is a project I started because I got bored with running irssi in
-screen on my server. My server isn't very fast and that meant
-when it was on high load ircing was getting pretty hard. I could
-of course run irssi on my workstation, but my workstation isn't on
-24/7 and some people depend on the channel logs I generate.
+If you are upgrading from an older version of ctrlproxy, please read the
+file UPGRADING.
+
+Introduction
+------------
+CtrlProxy is a lightweight IRC proxy. It allows you to keep a permanent
+connection open to an IRC server and using that connection from wherever
+you would like to use IRC, without the need to disconnect and connect to IRC
+continuously while missing text.
-Running ctrlproxy requires much less bandwidth then running a
-remote irssi inside screen.
+Information for users upgrading from 2.6 or 2.7-preXX:
+------------------------------------------------------
-The structure of ctrlproxy is very modular and it is easily extendible.
+The configuration is now maintained as a set of flat-text files in
+~/.ctrlproxy/. Existing configuration files can be upgraded by
+running the experimental upgrade utility available in the directory 'scripts'
+in the source tarball.
Features
--------
* Connect to one server with many clients under one nick transparently
* Connect to multiple servers using only one process
* CTCP support when no client is attached
- * irssi-style logging support
* Transparent detaching and attaching of clients
* Password support
- * Replication support (from memory or file)
+ * Replication support
* Auto-Away support
* Keeping track of events occuring
- * Direct, inetd-style interfacing with local IRC servers (such as bitlbee)
- * Responses to queries are only sent to the originator of the query
+ * Direct, inetd-style interfacing with local IRC servers (such as BitlBee)
+ * Works transparently
* SSL support
* Custom logging in any format you specify
* Flood protection
+ * IPv6 Support
+ * Automatic NickServ support
+ * Low memory, CPU and bandwidth requirements
+ * Management of running instances using a command-line tool or
+ over IRC.
-Requirements
+Dependencies
------------
- * libpopt
* GNU glib
- * libxml2
+ * GNU TLS (optional, for SSL support)
+ * Python (optional, for Python scripting)
- And for the stats module:
- * libtdb
- * libpcre (optional)
-
Building
--------
-ctrlproxy can be installed using:
+ctrlproxy can be installed by running:
-$ ./configure
-$ make
-$ make install
+::
-If you have a CVS checkout, run :
+ $ ./configure
+ $ make
+ $ make install
+
+If you have a bzr checkout, run :
-$ autoreconf
+::
+
+ $ ./autogen.sh
before you run ./configure, make and make install
-Documentation
--------------
-Most documentation is in the manual and the
-manpages: ctrlproxy(1) and ctrlproxyrc(5).
-The example ctrlproxyrc file might be of some use..
+Quick start
+-----------
+1. Install ctrlproxy
-After you've installed, configured and started ctrlproxy you can connect to
-it on port 6668 and up.
+2. Run ctrlproxy --init
-To build the documentation, run ./configure --enable-docs. Please note that
-a pregenerated version of the documentation is available in the tarball. So,
-in most cases, you shouldn't need to rebuild.
+Enter a password and a port to ctrlproxy should listen on.
-Quick start
------------
-1. Install ctrlproxy (either from debian, or from source, see above)
+CtrlProxy will write a configuration to ~/.ctrlproxy. You may
+want to edit ~/.ctrlproxy/config.
-2. Run ctrlproxy-setup
+3. Run ctrlproxy --daemon or ctrlproxy
-3. Run ctrlproxy --daemon
+4. Connect to ctrlproxy from your IRC client on the port you specified earlier.
+For more information on connecting with your favorite IRC client, see the
+user guide.
-4. Connect to ctrlproxy from your IRC client. By default, you can connect
-to port 6670.
+Documentation
+-------------
+Most documentation is in the user guide and the
+manpages: ctrlproxy(1) and ctrlproxy_config(5).
+The example config.example file might also be of some use.
-5. Simply disconnect by typing /QUIT
+Reporting Bugs
+--------------
+Bugs can be reported at http://bugs.bitlbee.org/ctrlproxy/
git.samba.org / jelmer / ctrlproxy.git / blobdiff