Compare commits
5 Commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
a6c6ddd155 | ||
![]() |
e5cec00ab9 | ||
![]() |
8c73a63311 | ||
![]() |
0b121f8cb3 | ||
![]() |
867ca0560d |
151
CHANGELOG.html
Normal file
151
CHANGELOG.html
Normal file
@@ -0,0 +1,151 @@
|
||||
<html>
|
||||
<head>
|
||||
<title></title>
|
||||
<meta name="author" content="eyedeekay" />
|
||||
<meta name="description" content="terrarium.git" />
|
||||
<meta name="keywords" content="master" />
|
||||
<link rel="stylesheet" type="text/css" href="style.css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="navbar">
|
||||
<a href="#shownav">
|
||||
Show navigation
|
||||
</a>
|
||||
<div id="shownav">
|
||||
<div id="hidenav">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="index.html">
|
||||
index
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CHANGELOG.html">
|
||||
CHANGELOG
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
<br>
|
||||
<a href="#hidenav">
|
||||
Hide Navigation
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<h1>
|
||||
0.0.08
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
include license in plugin package
|
||||
</li>
|
||||
<li>
|
||||
fix license in plugin config
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
0.0.07
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
restart changelog.
|
||||
</li>
|
||||
<li>
|
||||
fix websiteURL in plugin.
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.14.0
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Stop publishing arm releases.
|
||||
</li>
|
||||
<li>
|
||||
Support TLS 1.3.
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.13.0 (2019-07-08)
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Include Go version in version string.
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.12.0 (2019-07-06)
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Update dependencies.
|
||||
</li>
|
||||
<li>
|
||||
Send messages during connect immediately rather than only after we’ve
|
||||
performed our reverse DNS lookup.
|
||||
</li>
|
||||
<li>
|
||||
Stop logging client reads/writes.
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.11.0 (2019-01-01)
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
No longer automatically rehash once a week. I changed my mind about this!
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.10.0 (2018-08-18)
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Rehashing now reloads the TLS certificate and key.
|
||||
</li>
|
||||
<li>
|
||||
Rehashing now automatically happens once a week. This is so we load new
|
||||
certificates.
|
||||
</li>
|
||||
<li>
|
||||
Require valid TLS certificates on outbound TLS connections. This means
|
||||
servers we connect to must have valid certificates that match the name we
|
||||
connect to them as.
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.9.0 (2018-07-28)
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Started tracking changes in a changelog.
|
||||
</li>
|
||||
<li>
|
||||
If a message is invalid, send a notice to opers about it rather than just
|
||||
log. This is to catch bugs arising from this behaviour.
|
||||
</li>
|
||||
<li>
|
||||
Send a notice to opers if there is an unprocessed buffer after a read
|
||||
error. This is again to catch bugs from this behaviour.
|
||||
</li>
|
||||
<li>
|
||||
Failing to set read deadlines now logs rather than triggers client quit.
|
||||
This is to allow for the read to happen which can have data in the
|
||||
buffer.
|
||||
</li>
|
||||
<li>
|
||||
Delay before flagging the client as dead if there is a write error. This
|
||||
is to give us a window to read anything further from the client that
|
||||
might be available.
|
||||
</li>
|
||||
</ul>
|
||||
<div>
|
||||
<iframe src="https://snowflake.torproject.org/embed.html" width="320" height="240" frameborder="0" scrolling="no"></iframe>
|
||||
</div>
|
||||
<div>
|
||||
<a href="https://geti2p.net/">
|
||||
I2P
|
||||
</a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
2
Makefile
2
Makefile
@@ -1,4 +1,4 @@
|
||||
VERSION=0.0.10
|
||||
VERSION=1.14.0
|
||||
CGO_ENABLED=0
|
||||
export CGO_ENABLED=0
|
||||
|
||||
|
339
index.html
339
index.html
@@ -1,73 +1,268 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>terrarium - IRC</title>
|
||||
<link rel="stylesheet" type="text/css" href ="/style.css" />
|
||||
</head>
|
||||
<body>
|
||||
<h1 id="terrarium"><img src="doc/terrarium-with-text.png" alt="terrarium" /></h1>
|
||||
<p><a href="https://travis-ci.org/eyedeekay/terrarium"><img src="https://travis-ci.org/eyedeekay/terrarium.svg" alt="Build Status" /></a> <a href="https://goreportcard.com/report/i2pgit.org/idk/terrarium"><img src="https://goreportcard.com/badge/i2pgit.org/idk/terrarium" alt="Go Report Card" /></a></p>
|
||||
<p>terrarium is an IRC server with a focus on being small and understandable, originally forked from <a href="https://github.com/horgh/catbox">horgh/catbox</a>. The goal is to create an easy-to-configure I2P IRC server which is highly stable and secure, while retaining the ability to link with non-I2P IRC servers using TLS in order to bridge anonymous and non-anonymous chat. For now, Bridged servers are not anonymous, this may change in the future as I evaluate the feasibility of outproxies or Tor.</p>
|
||||
<h1 id="features">Features</h1>
|
||||
<ul>
|
||||
<li>Server to server linking</li>
|
||||
<li>IRC operators</li>
|
||||
<li>Private (WHOIS shows no channels, LIST isn’t supported)</li>
|
||||
<li>Flood protection</li>
|
||||
<li>K: line style connection banning</li>
|
||||
<li>TLS</li>
|
||||
</ul>
|
||||
<p>terrarium implements enough of <a href="https://tools.ietf.org/html/rfc1459">RFC 1459</a> to be recognisable as IRC and be minimally functional. It will intentionally omit unnecessary features. Priority features are those which enable moderation and provide more flexible security.</p>
|
||||
<h1 id="plugin-installation-urls">Plugin Installation URL’s</h1>
|
||||
<p><a href="https://geti2p.net/en/docs/plugins">A guide to installing I2P plugins can be found on the I2P web site.</a></p>
|
||||
<h3 id="inside-i2p">Inside I2P</h3>
|
||||
<ul>
|
||||
<li><a href="http://idk.i2p/terrarium/terrarium-windows-amd64.su3">Windows (In-I2P)</a></li>
|
||||
<li><a href="http://idk.i2p/terrarium/terrarium-linux-amd64.su3">Linux (In-I2P)</a></li>
|
||||
</ul>
|
||||
<h3 id="outside-i2p">Outside I2P</h3>
|
||||
<ul>
|
||||
<li><a href="https://github.com/terrarium/blizzard/releases">Windows</a></li>
|
||||
<li><a href="https://github.com/terrarium/blizzard/releases">Linux</a></li>
|
||||
</ul>
|
||||
<h1 id="installation">Installation</h1>
|
||||
<ol type="1">
|
||||
<li>Clone the software from <a href="https://i2pgit.org/idk/terrarium">i2pgit.org</a> (<code>git clone https://i2pgit.org/idk/terrarium go/src/i2pgit.org/idk/terrarium && cd go/src/i2pgit.org/idk/terrarium</code>).</li>
|
||||
<li>Build from source (<code>go build</code>).</li>
|
||||
<li>Configure terrarium through config files. There are example configs in the <code>conf</code> directory. All settings are optional and have defaults.</li>
|
||||
<li>Run it, e.g. <code>./terrarium -conf terrarium.conf</code>. You might run it via systemd via a service such as:</li>
|
||||
</ol>
|
||||
<pre><code>[Service]
|
||||
ExecStart=/home/ircd/terrarium/terrarium -conf /home/ircd/terrarium/terrarium.conf
|
||||
Restart=always
|
||||
|
||||
[Install]
|
||||
WantedBy=default.target</code></pre>
|
||||
<h1 id="configuration">Configuration</h1>
|
||||
<h2 id="terrarium.conf">terrarium.conf</h2>
|
||||
<p>Global server settings.</p>
|
||||
<h2 id="opers.conf">opers.conf</h2>
|
||||
<p>IRC operators.</p>
|
||||
<h2 id="servers.conf">servers.conf</h2>
|
||||
<p>The servers to link with.</p>
|
||||
<h2 id="users.conf">users.conf</h2>
|
||||
<p>Privileges and hostname spoofs for users.</p>
|
||||
<p>The only privilege right now is flood exemption.</p>
|
||||
<h2 id="tls">TLS</h2>
|
||||
<p>A setup for a network might look like this:</p>
|
||||
<ul>
|
||||
<li>Give each server a certificate with 2 SANs: Its own hostname, e.g. server1.example.com, and the network hostname, e.g. irc.example.com.</li>
|
||||
<li>Set up irc.example.com with DNS round-robin listing each server’s IP.</li>
|
||||
<li>List each server by its own hostname in servers.conf.</li>
|
||||
</ul>
|
||||
<p>Clients connect to the network hostname and verify against it. Servers connect to each other by server hostname and verify against it.</p>
|
||||
<h2 id="i2p">I2P</h2>
|
||||
<p>An example I2P configuration can be found in:</p>
|
||||
<p><code>conf/catbox-i2p.conf</code></p>
|
||||
<p>That’s all the docs I have for now</p>
|
||||
<h1 id="why-the-name">Why the name?</h1>
|
||||
<p>It was forked from an IRC server called catbox which had a focus on simplicity and understandability. It now has the ability to connect to other IRC servers through I2P Tunnels. Clearnet is to I2P Tunnels is sort of like Catbox is to Terrarium.</p>
|
||||
<h1 id="logo">Logo</h1>
|
||||
<p>terrarium logo (c) 2017 Bee</p>
|
||||
</body>
|
||||
</html>
|
||||
<head>
|
||||
<title></title>
|
||||
<meta name="author" content="eyedeekay" />
|
||||
<meta name="description" content="terrarium.git" />
|
||||
<meta name="keywords" content="master" />
|
||||
<link rel="stylesheet" type="text/css" href="style.css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="navbar">
|
||||
<a href="#shownav">
|
||||
Show navigation
|
||||
</a>
|
||||
<div id="shownav">
|
||||
<div id="hidenav">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="index.html">
|
||||
index
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CHANGELOG.html">
|
||||
CHANGELOG
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
<br>
|
||||
<a href="#hidenav">
|
||||
Hide Navigation
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a href="/"></a>
|
||||
<h1>
|
||||
<img src="doc/terrarium-with-text.png" alt="terrarium"/>
|
||||
</h1>
|
||||
<p>
|
||||
<a href="https://travis-ci.org/eyedeekay/terrarium" rel="nofollow">
|
||||
<img src="https://travis-ci.org/eyedeekay/terrarium.svg" alt="Build
|
||||
Status"/>
|
||||
</a>
|
||||
<a href="https://goreportcard.com/report/i2pgit.org/idk/terrarium" rel="nofollow">
|
||||
<img src="https://goreportcard.com/badge/i2pgit.org/idk/terrarium" alt="Go Report
|
||||
Card"/>
|
||||
</a>
|
||||
</p>
|
||||
<p>
|
||||
terrarium is an IRC server with a focus on being small and understandable,
|
||||
originally forked from
|
||||
<a href="https://github.com/horgh/catbox" rel="nofollow">
|
||||
horgh/catbox
|
||||
</a>
|
||||
. The
|
||||
goal is to create an easy-to-configure I2P IRC server which is highly stable
|
||||
and secure, while retaining the ability to link with non-I2P IRC servers using
|
||||
TLS in order to bridge anonymous and non-anonymous chat. For now, Bridged
|
||||
servers are not anonymous, this may change in the future as I evaluate the
|
||||
feasibility of outproxies or Tor.
|
||||
</p>
|
||||
<h1>
|
||||
Features
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Server to server linking
|
||||
</li>
|
||||
<li>
|
||||
IRC operators
|
||||
</li>
|
||||
<li>
|
||||
Private (WHOIS shows no channels, LIST isn’t supported)
|
||||
</li>
|
||||
<li>
|
||||
Flood protection
|
||||
</li>
|
||||
<li>
|
||||
K: line style connection banning
|
||||
</li>
|
||||
<li>
|
||||
TLS
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
terrarium implements enough of
|
||||
<a href="https://tools.ietf.org/html/rfc1459" rel="nofollow">
|
||||
RFC 1459
|
||||
</a>
|
||||
to be recognisable as IRC and be minimally functional. It will intentionally
|
||||
omit unnecessary features. Priority features are those which enable moderation
|
||||
and provide more flexible security.
|
||||
</p>
|
||||
<h1>
|
||||
Plugin Installation URL’s
|
||||
</h1>
|
||||
<p>
|
||||
<a href="https://geti2p.net/en/docs/plugins" rel="nofollow">
|
||||
A guide to installing I2P plugins can be found on the I2P web site.
|
||||
</a>
|
||||
</p>
|
||||
<h3>
|
||||
Inside I2P
|
||||
</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="http://idk.i2p/terrarium/terrarium-windows-amd64.su3" rel="nofollow">
|
||||
Windows (In-I2P)
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="http://idk.i2p/terrarium/terrarium-linux-amd64.su3" rel="nofollow">
|
||||
Linux (In-I2P)
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>
|
||||
Outside I2P
|
||||
</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="https://github.com/terrarium/blizzard/releases" rel="nofollow">
|
||||
Windows
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/terrarium/blizzard/releases" rel="nofollow">
|
||||
Linux
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
Installation
|
||||
</h1>
|
||||
<ol>
|
||||
<li>
|
||||
Clone the software from
|
||||
<a href="https://i2pgit.org/idk/terrarium" rel="nofollow">
|
||||
i2pgit.org
|
||||
</a>
|
||||
(
|
||||
<code>
|
||||
git clone https://i2pgit.org/idk/terrarium go/src/i2pgit.org/idk/terrarium && cd go/src/i2pgit.org/idk/terrarium
|
||||
</code>
|
||||
).
|
||||
</li>
|
||||
<li>
|
||||
Build from source
|
||||
(
|
||||
<code>
|
||||
go build
|
||||
</code>
|
||||
).
|
||||
</li>
|
||||
<li>
|
||||
Configure terrarium through config files. There are example configs in the
|
||||
<code>
|
||||
conf
|
||||
</code>
|
||||
directory. All settings are optional and have defaults.
|
||||
</li>
|
||||
<li>
|
||||
Run it, e.g.
|
||||
<code>
|
||||
./terrarium -conf terrarium.conf
|
||||
</code>
|
||||
. You might run it via systemd
|
||||
via a service such as:
|
||||
<code>
|
||||
[Service]
|
||||
ExecStart=/home/ircd/terrarium/terrarium -conf /home/ircd/terrarium/terrarium.conf
|
||||
Restart=always
|
||||
[Install]
|
||||
WantedBy=default.target
|
||||
</code>
|
||||
</li>
|
||||
</ol>
|
||||
<h1>
|
||||
Configuration
|
||||
</h1>
|
||||
<h2>
|
||||
terrarium.conf
|
||||
</h2>
|
||||
<p>
|
||||
Global server settings.
|
||||
</p>
|
||||
<h2>
|
||||
opers.conf
|
||||
</h2>
|
||||
<p>
|
||||
IRC operators.
|
||||
</p>
|
||||
<h2>
|
||||
servers.conf
|
||||
</h2>
|
||||
<p>
|
||||
The servers to link with.
|
||||
</p>
|
||||
<h2>
|
||||
users.conf
|
||||
</h2>
|
||||
<p>
|
||||
Privileges and hostname spoofs for users.
|
||||
</p>
|
||||
<p>
|
||||
The only privilege right now is flood exemption.
|
||||
</p>
|
||||
<h2>
|
||||
TLS
|
||||
</h2>
|
||||
<p>
|
||||
A setup for a network might look like this:
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
Give each server a certificate with 2 SANs: Its own hostname, e.g.
|
||||
server1.example.com, and the network hostname, e.g. irc.example.com.
|
||||
</li>
|
||||
<li>
|
||||
Set up irc.example.com with DNS round-robin listing each server’s IP.
|
||||
</li>
|
||||
<li>
|
||||
List each server by its own hostname in servers.conf.
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
Clients connect to the network hostname and verify against it. Servers
|
||||
connect to each other by server hostname and verify against it.
|
||||
</p>
|
||||
<h2>
|
||||
I2P
|
||||
</h2>
|
||||
<p>
|
||||
An example I2P configuration can be found in:
|
||||
</p>
|
||||
<p>
|
||||
<code>
|
||||
conf/catbox-i2p.conf
|
||||
</code>
|
||||
</p>
|
||||
<p>
|
||||
That’s all the docs I have for now
|
||||
</p>
|
||||
<h1>
|
||||
Why the name?
|
||||
</h1>
|
||||
<p>
|
||||
It was forked from an IRC server called catbox which had a focus on simplicity
|
||||
and understandability. It now has the ability to connect to other IRC servers
|
||||
through I2P Tunnels. Clearnet is to I2P Tunnels is sort of like Catbox is to
|
||||
Terrarium.
|
||||
</p>
|
||||
<h1>
|
||||
Logo
|
||||
</h1>
|
||||
<p>
|
||||
terrarium logo © 2017 Bee
|
||||
</p>
|
||||
<div>
|
||||
<iframe src="https://snowflake.torproject.org/embed.html" width="320" height="240" frameborder="0" scrolling="no"></iframe>
|
||||
</div>
|
||||
<div>
|
||||
<a href="https://geti2p.net/">
|
||||
I2P
|
||||
</a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
157
style.css
Normal file
157
style.css
Normal file
@@ -0,0 +1,157 @@
|
||||
/* edgar default CSS file */
|
||||
|
||||
body {
|
||||
font-family: "Roboto";
|
||||
font-family: monospace;
|
||||
text-align: justify;
|
||||
background-color: #373636;
|
||||
color: whitesmoke;
|
||||
font-size: 1.15em;
|
||||
}
|
||||
|
||||
ul {
|
||||
width: 55%;
|
||||
display: block;
|
||||
}
|
||||
|
||||
ol {
|
||||
width: 55%;
|
||||
display: block;
|
||||
}
|
||||
|
||||
li {
|
||||
margin-top: 1%;
|
||||
}
|
||||
|
||||
p {
|
||||
max-width: 90%;
|
||||
margin-top: 1%;
|
||||
margin-left: 3%;
|
||||
margin-right: 3%;
|
||||
}
|
||||
|
||||
img {
|
||||
float: left;
|
||||
top: 5%;
|
||||
left: 5%;
|
||||
max-width: 60%;
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.inline {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.link-button:focus {
|
||||
outline: none;
|
||||
}
|
||||
|
||||
.link-button:active {
|
||||
color: red;
|
||||
}
|
||||
|
||||
code {
|
||||
font-family: monospace;
|
||||
border-radius: 5%;
|
||||
padding: 1%;
|
||||
border-color: darkgray;
|
||||
font-size: .9em;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #C6D9FE;
|
||||
padding: 1%;
|
||||
}
|
||||
|
||||
ul li {
|
||||
color: #C6D9FE;
|
||||
}
|
||||
|
||||
iframe {
|
||||
background: aliceblue;
|
||||
border-radius: 15%;
|
||||
margin: 2%;
|
||||
}
|
||||
|
||||
.container {
|
||||
width: 36vw;
|
||||
height: 64vh;
|
||||
display: inline-block;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.editor-toolbar a {
|
||||
display: inline-block;
|
||||
text-align: center;
|
||||
text-decoration: none !important;
|
||||
color: whitesmoke !important;
|
||||
}
|
||||
|
||||
#feed {
|
||||
width: 60vw;
|
||||
height: unset !important;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
float: right;
|
||||
background-color: #373636;
|
||||
color: whitesmoke;
|
||||
border: #C6D9FE solid 1px;
|
||||
}
|
||||
|
||||
.thread-post,
|
||||
.thread {
|
||||
color: whitesmoke !important;
|
||||
background-color: #373636;
|
||||
border: 1px solid darkgray;
|
||||
font-size: inherit;
|
||||
padding-top: 1%;
|
||||
padding-bottom: 1%;
|
||||
}
|
||||
|
||||
.thread-post {
|
||||
margin-left: 4%;
|
||||
}
|
||||
|
||||
input {
|
||||
text-align: center;
|
||||
color: whitesmoke !important;
|
||||
background-color: #373636;
|
||||
border: 1px solid darkgray;
|
||||
font: normal normal normal 14px/1 FontAwesome;
|
||||
font-size: inherit;
|
||||
padding-top: 1%;
|
||||
padding-bottom: 1%;
|
||||
}
|
||||
|
||||
.thread-hash {
|
||||
text-align: right;
|
||||
color: whitesmoke !important;
|
||||
background-color: #373636;
|
||||
border: 1px solid darkgray;
|
||||
font-size: inherit;
|
||||
padding-top: 1%;
|
||||
padding-bottom: 1%;
|
||||
}
|
||||
|
||||
.post-body {
|
||||
text-align: left;
|
||||
color: whitesmoke !important;
|
||||
font-size: inherit;
|
||||
padding-top: 1%;
|
||||
padding-bottom: 1%;
|
||||
}
|
||||
#show {display:none; }
|
||||
#hide {display:block; }
|
||||
#show:target {display: block; }
|
||||
#hide:target {display: none; }
|
||||
|
||||
#shownav {display:none; }
|
||||
#hidenav {display:block; }
|
||||
#shownav:target {display: block; }
|
||||
#hidenav:target {display: none; }
|
||||
|
||||
#navbar {
|
||||
float: right;
|
||||
width: 10%;
|
||||
}
|
Reference in New Issue
Block a user