Skip to content

Commit 374e19c

Browse files
committed
Clean up README
1 parent de8ef49 commit 374e19c

File tree

1 file changed

+29
-20
lines changed

1 file changed

+29
-20
lines changed

README.md

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,39 @@
1-
# Trolling telnet.
1+
# Trolling telnet (ft. rickrolld)
22

3-
You can `telnet macnugget.org` to see it in action.
3+
```sh
4+
telnet macnugget.org
5+
```
6+
7+
If your machine doesn't have telnet installed, good for you. You can also use
8+
Netcat to connect.
49

5-
If your host doesn't have the telnet client installed, good for you. You can also
6-
use Netcat to access the service with the command `nc macnugget.org 23`
10+
```sh
11+
nc macnugget.org 23
12+
```
713

814
# What is this? Whose fault is this?
915

10-
I honestly don't remember what was going through my head in 2013 when I wrote
11-
the original version of this server in Tcl 8.5 and set it up to run on one of
12-
my FreeBSD servers. I'm sure I felt then -- as I do now -- that it represents
13-
the pinnacle of [Rickrolling] humor.
16+
I honestly don't remember what exactly was going through my head in 2013 when I
17+
wrote the original version of this service. I imagine that I felt then -- as I
18+
do now -- that rickrolld represents the zenith of [Rickrolling] humor.
1419

15-
In 2022 I decommissioned the last of my FreeBSD servers which had the required
16-
enviroment to host a Tcl script which relied on [inetd], [tcpwrappers], and
17-
[tcllauncher] to function. Sadly, `telnet macnugget.org` died that day. Only
18-
the code remained as an archeological examination of how we used to do things
19-
back in the olden days of UNIX before the rise of Linux and containers.
20+
rickrolld was written in Tcl 8.5 and was bespoke to my favored-at-the-time
21+
FreeBSD environment. The script relied on [inetd], [tcpwrappers], and
22+
[tcllauncher] to function. In 2022 I decommissioned the last of my those
23+
FreeBSD servers and lost the enviroment I needed to keep rickrolld running.
24+
Sadly, rickrolld died that day.
2025

21-
It was a different world [back then](https://github.com/nugget/rickroll/tree/02f031511578bc33fd5b3df10f857620042bc857).
26+
## Version 2.0 Rewrite
2227

23-
It's old enough to have been 3-Clause BSD licensed. I remember I had strong
24-
feelings about that at the time. I changed it to MIT as part of the rewrite.
28+
In June 2025 I rewrote the server in Golang and got it containerized for an
29+
easier deployment in modern infrastructure.
2530

26-
# Version 2.0 Rewrite
31+
[The code from back then] is a time capsule from a different era. From before
32+
Linux and containers took over the Internet. It's old enough to have been
33+
3-Clause BSD licensed. I remember having strong feelings about that at the
34+
time. I changed it to MIT as part of the rewrite.
2735

28-
In June 2025 I rewrote the server in Golang and got it containerized for an easier
29-
deployment in modern infrastructure.
36+
# Description
3037

3138
This service will bind port 23 and listen as a telnet server. Incoming
3239
connections will be textually serenaded.
@@ -41,7 +48,8 @@ make run
4148

4249
# Containerized
4350

44-
Images are on dockerhub at [nugget/rickrolld](https://hub.docker.com/r/nugget/rickrolld)
51+
Images are on dockerhub at
52+
[nugget/rickrolld](https://hub.docker.com/r/nugget/rickrolld)
4553

4654
```sh
4755
docker run -p 23:23 nugget/rickrolld
@@ -73,6 +81,7 @@ RICKROLL_LISTEN_ADDR=:23
7381
RICKROLL_LYRICS_FILENAME=lyrics.dat
7482
```
7583

84+
[The code from back then]: https://github.com/nugget/rickroll/tree/02f031511578bc33fd5b3df10f857620042bc857
7685
[Rickrolling]: https://en.wikipedia.org/wiki/Rickrolling
7786
[inetd]: https://man.freebsd.org/cgi/man.cgi?inetd
7887
[tcpwrappers]: https://en.wikipedia.org/wiki/TCP_Wrappers

0 commit comments

Comments
 (0)