Guides to IRC Client Configuration

i2p2www/pages/site/docs/applications/irc.html

@@ -0,0 +1,235 @@
+{% extends "global/layout.html" %}
+{% block title %}{% trans %}Configuring IRC Software{% endtrans %}{% endblock %}
+{% block lastupdated %}2020-11{% endblock %}
+{% block accuratefor %}0.9.47{% endblock %}
+{% block content %}
+<h1>{% trans %}IRC Software{% endtrans %}</h1>
+<ul>
+    <li><a href="#clients">Clients</a></li>
+    <li><a href="#servers">Servers</a></li>
+</ul>
+
+<a name="clients"></a>
+<h2>{% trans %}Clients{% endtrans %}</h2>
+
+<p>{% trans %} There are many IRC clients that can be used with I2P. In
+fact, all IRC clients can be connected to the Irc2P Service by connecting
+them to the IRC Tunnel.{% endtrans %}</p>
+
+<ul>
+    <li><a href="#pidgin">Pidgin(Windows, Linux) Adium(OSX)</a></li>
+    <li><a href="#xchat">XChat(Windows, Linux) XChat Aqua(OSX)</a></li>
+    <li><a href="#thunderbird">Thunderbird(Windows, Linux, OSX)</a></li>
+    <li><a href="#revolution">Revolution IRC(Android)</a></li>
+    <li><a href="#dispatch">Dispatch(Windows, Linux, OSX)(WebClient)</a></li>
+</ul>
+
+<h3>Check the IRC tunnel</h3>
+<p>{% trans %}To configure any IRC client to chat on Irc2P, first, make sure that
+your IRC tunnel is available. Visit the <a href="http://127.0.0.1:7657/i2ptunnel/">Hidden Services Manager</a>
+and look for Irc2P in your "Client Tunnels" section. If the "Status" indicator on
+the right-hand side is yellow or green, your Irc2P tunnel is ready and you should 
+proceed to the next step.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/tuncheck-irc-all.png') }}"
+alt="{{ _('IRC Tunnel Check') }}" title="{{ _('IRC Tunnel Check') }}">
+
+<p>{% trans %}Any IRC client can be connected to this IRC tunnel, but detailed
+instructions for several popular clients are provided below.{% endtrans %}</p>
+
+<a name="pidgin"></a>
+<h3>Pidgin</h3>
+<p>{% trans %}Pidgin is a very popular Instant Messaging client with built-in IRC
+support. It is also possible to use it with many other kinds of chat service, and
+it supports using multiple accounts at once and has a variety of plugin-ins. There
+is a similar application for OSX called "Adium." The instructions for Pidgin are
+similar in Adium.
+{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/pidgin-irc-0.png') }}"
+alt="{{ _('Open the menu') }}" title="{{ _('Pidgin Step One') }}">
+
+<p>{% trans %}After launching Pidgin, you should see a "Buddy List" window. From
+that window, open the "Accounts" menu from the toolbar. Select "Manage Accounts" to
+begin configuring your I2P account.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/pidgin-irc-1.png') }}"
+alt="{{ _('Add the account') }}" title="{{ _('Pidgin Step Two') }}">
+
+<p>{% trans %}Click the "Add" button. In the window that opens, select "IRC" under
+"Protocol," and set the "Host" to 127.0.0.1. Then pick a username and password. IRC
+does not require you to register a nickname to join, but you may if you wish, after
+you connect to Irc2P.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/pidgin-irc-2.png') }}"
+alt="{{ _('Configure username, hostname, password') }}" title="{{ _('Pidgin Step Three') }}">
+
+<p>{% trans %}Navigate to the "Advanced" tab and set the "Port" field to 6668 and
+make sure that SSL is <em>disabled</em>, since your tunnel has encryption provided
+by I2P.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/pidgin-irc-3.png') }}"
+alt="{{ _('Configure port') }}" title="{{ _('Pidgin Step Four') }}">
+
+<a name="xchat"></a>
+<h3>XChat</h3>
+<p>{% trans %}Open the Server List menu of XChat and click the "Add" button.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/xchat-irc-0.png') }}"
+alt="{{ _('Add a server') }}" title="{{ _('XChat Step One') }}">
+
+<p>{% trans %}Create a new network named "Irc2P" to configure for I2P IRC. Click
+the "Edit" button on the right-hand side.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/xchat-irc-1.png') }}"
+alt="{{ _('Add a server') }}" title="{{ _('XChat Step Two') }}">
+
+<p>{% trans %}Change the value in "Servers" from the default to `localhost/6669`,
+and configure the default channels you want to join. I suggest #i2p and #i2p-dev
+{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/xchat-irc-2.png') }}"
+alt="{{ _('Add a server') }}" title="{{ _('XChat Step Three') }}">
+
+<p>{% trans %}Close the "Edit Server" window from to return to the Server List
+page and click "Connect" to join I2PRC.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/xchat-irc-3.png') }}"
+alt="{{ _('Add a server') }}" title="{{ _('XChat Step Four') }}">
+
+<a name="thunderbird"></a>
+<h3>Thunderbird</h3>
+<p>{% trans %}Click on the "Chat" button in the toolbar at the top of the
+Thunderbird window.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/thunderbird-irc-0.png') }}"
+alt="{{ _('Add a chat') }}" title="{{ _('Thunderbird Step One') }}">
+
+<p>{% trans %}Click the get started button to begin setting up Irc2P.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/thunderbird-irc-1.png') }}"
+alt="{{ _('Get Started') }}" title="{{ _('Thunderbird Step Two') }}">
+
+<p>{% trans %}In the first step, select "IRC" for your network type.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/thunderbird-irc-2.png') }}"
+alt="{{ _('Pick IRC') }}" title="{{ _('Thunderbird Step Three') }}">
+
+<p>{% trans %}Choose a nickname and set your IRC Server to 127.0.0.1, but do not
+set a port.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/thunderbird-irc-3.png') }}"
+alt="{{ _('Set username and server') }}" title="{{ _('Thunderbird Step Four') }}">
+
+<p>{% trans %}Set a password if you want.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/thunderbird-irc-4.png') }}"
+alt="{{ _('Add a server') }}" title="{{ _('Thunderbird Step Five') }}">
+
+<p>{% trans %}Configure the IRC Server with an alias like "Irc2P" and set the
+port to 6668.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/thunderbird-irc-5.png') }}"
+alt="{{ _('Add a server') }}" title="{{ _('Thunderbird Step Six') }}">
+
+<p>{% trans %}If your summary looks like this, then you're ready to connect
+with Irc2P.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/thunderbird-irc-6.png') }}"
+alt="{{ _('Add a server') }}" title="{{ _('Thunderbird Step Seven') }}">
+
+<a name="revolution"></a>
+<h3>Revolution IRC</h3>
+<p>{% trans %}Revolution IRC is an easy to use IRC client for Android. It's able to
+handle multiple accounts on multiple services, so you can use it for Irc2P and for
+your non-I2P IRC networks as well.{% endtrans %}</p>
+
+<p>{% trans %}Click the "Add Server" button(Shaped like this: `+`) in the corner
+to get started configuring Revolution IRC for I2P.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/revolution-irc-0.png') }}"
+alt="{{ _('Add a server') }}" title="{{ _('Revolution Step One') }}">
+
+<p>{% trans %}Fill in the server name, change the address to "127.0.0.1" and the
+port to 6668.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/revolution-irc-1.png') }}"
+alt="{{ _('Configure it like this') }}" title="{{ _('Revolution Step Two') }}">
+
+<p>{% trans %}Give yourself a nickname and configure some channels to automatically
+join.{% endtrans %}</p>
+
+<img src="{{ url_for('static', filename='images/irc/revolution-irc-2.png') }}"
+alt="{{ _('Open the menu') }}" title="{{ _('Revolution Step Three') }}">
+
+<a name="dispatch"></a>
+<h3>Dispatch</h3>
+<p>{% trans %}Dispatch is a stable, self-hosted IRC client with a web interface. It
+has native I2P configuration available by communicating over the{% endtrans %} <a href="{{ site_url('docs/api/samv3') }}">SAM v3 API</a>.</p>
+
+<p>{% trans %}Dispatch is configured with a file called `config.toml`, which you can
+configure the common settings.{% endtrans %}</p>
+
+<p>{% trans %} {% endtrans %}</p>
+<pre><code>
+# Defaults for the client connect form
+[defaults]
+name = "myinvisibleirc.i2p"
+host = "anircservergoeshere.b32.i2p"
+port = 6667
+channels = [
+  "#i2p",
+  "#i2p-dev"
+]
+server_password = ""
+ssl = false
+</code></pre>
+
+<a name="servers"></a>
+<h2>{% trans %}Servers{% endtrans %}</h2>
+<ul>
+    <li><a href="#eris">Eris(Windows, OSX, Linux)</a></li>
+</ul>
+
+<a name="eris"></a>
+<h3>Eris</h3>
+<p>{% trans %}Eris is an easy-to-configure IRC server with self-configuring support
+for I2P. If you want to run a private IRC server it's one of the easiest ways.{% endtrans %}</p>
+
+<p>{% trans %} This is a valid configuration of the Eris IRC server, but it uses a
+default password for the admin account(admin). You should change the operator.admin.password
+and account.admin.password before deploying to a real service.{% endtrans %}</p>
+
+<pre><code>
+mutex: {}
+network:
+  name: Local
+server:
+  password: ""
+  listen: []
+  tlslisten: {}
+  i2plisten:
+    invisibleirc:
+      i2pkeys: iirc
+      samaddr: 127.0.0.1:7656
+  log: ""
+  motd: ircd.motd
+  name: myinvisibleirc.i2p
+  description: Hidden IRC Services
+operator:
+  admin:
+    password: JDJhJDA0JE1vZmwxZC9YTXBhZ3RWT2xBbkNwZnV3R2N6VFUwQUI0RUJRVXRBRHliZVVoa0VYMnlIaGsu
+account:
+  admin:
+    password: JDJhJDA0JGtUU1JVc1JOUy9DbEh1WEdvYVlMdGVnclp6YnA3NDBOZGY1WUZhdTZtRzVmb1VKdXQ5ckZD
+www: 
+  listen: []
+  tlslisten: {}
+  i2plisten:
+    i2pinfoirc:
+      i2pkeys: iircwww
+      samaddr: "127.0.0.1:7656"
+templatedir: lang
+</pre></code>
+
+{% endblock %}