From a377d1298ebd799ca7bb3fc834d96e12e47868bc Mon Sep 17 00:00:00 2001 From: reppep Date: Wed, 8 Oct 2014 22:53:18 -0400 Subject: [PATCH] Prettify IRC docs. Clarify distinction between IRC and shell servers. --- docs/ircserver.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/ircserver.md b/docs/ircserver.md index cc7d32a..5d59a25 100644 --- a/docs/ircserver.md +++ b/docs/ircserver.md @@ -1,31 +1,31 @@ -# Setting up the tilde.club IRC server +# Setting up the `tilde.club` IRC server -We chose to go with charybdis, mostly because it's in the Debian/Ubuntu package repository (universe), so we can update it without having to go through the configure/make/make install process. +We chose to go with `charybdis`, mostly because it's in the Debian/Ubuntu package repository (universe), so we can update it without having to go through the `configure`/`make`/`make install` process. ## System setup -The server is an Amazon EC2 instance, running Ubuntu. Initial system setup included: +The IRC server is an Amazon EC2 instance running Ubuntu. Initial system setup on the IRC server included: -* modifying the hostname (`sudo hostname irc`) (and perhaps also needing to edit the `/etc/hostname` file, unclear) +* Setting the hostname (`sudo hostname irc`) (and perhaps also needing to edit the `/etc/hostname` file -- unclear) * updating the `/etc/hosts` file (add `172.30.0.216 irc.tilde.club irc` and `172.30.0.176 tilde.club tilde`) -* setting the EC2 security group to allow TCP traffic on port 6667 from the tilde shell server only +* setting the EC2 security group to allow TCP traffic on port 6667 from the `tilde.club` shell server only -### Setup changes on the tilde shell server to support the IRC server +### Setup changes on the `tilde.club` shell server to access the IRC server -The tilde shell server needed a few tweaks, as well: +The `tilde.club` shell server needed a few tweaks as well: -* updating `/etc/hosts` (add `172.30.0.216 irc.tilde.club irc` so users can get to the server by hostname alone) -* setting the EC2 security group to allow TCP traffic on port 113 (identd) from the IRC server only +* updating `/etc/hosts` (add `172.30.0.216 irc.tilde.club irc` so users can reach the IRC server by hostname) +* setting the EC2 security group to allow TCP traffic on port 113 (`identd`) from the IRC server only -## Installing charybdis +## Installing `charybdis` -First, we needed to add the "universe" repository to the `apt` repository list: +First we needed to add the "universe" repository to the `apt` repository list: ``` sudo add-apt-repository "deb http://archive.ubuntu.com/ubuntu $(lsb_release -sc) universe" ``` -Once that was added, charybdis could be installed: +Once that was added, `charybdis` could be installed: ``` sudo apt-get install charybdis