Skip to content

Commit 40a01a9

Browse files
committed
Gopher: document the feature in redis.conf.
1 parent e247c9a commit 40a01a9

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

redis.conf

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,61 @@ latency-monitor-threshold 0
11831183
# specify at least one of K or E, no events will be delivered.
11841184
notify-keyspace-events ""
11851185

1186+
############################### GOPHER SERVER #################################
1187+
1188+
# Redis contains an implementation of the Gopher protocol, as specified in
1189+
# the RFC 1436 (https://www.ietf.org/rfc/rfc1436.txt).
1190+
#
1191+
# The Gopher protocol was very popular in the late '90s. It is an alternative
1192+
# to the web, and the implementation both server and client side is so simple
1193+
# that the Redis server has just 100 lines of code in order to implement this
1194+
# support.
1195+
#
1196+
# What do you do with Gopher nowadays? Well Gopher never *really* died, and
1197+
# lately there is a movement in order for the Gopher more hierarchical content
1198+
# composed of just plain text documents to be resurrected. Some want a simpler
1199+
# internet, others believe that the mainstream internet became too much
1200+
# controlled, and it's cool to create an alternative space for people that
1201+
# want a bit of fresh air.
1202+
#
1203+
# Anyway for the 10nth birthday of the Redis, we gave it the Gopher protocol
1204+
# as a gift.
1205+
#
1206+
# --- HOW IT WORKS? ---
1207+
#
1208+
# The Redis Gopher support uses the inline protocol of Redis, and specifically
1209+
# two kind of inline requests that were anyway illegal: an empty request
1210+
# or any request that starts with "/" (there are no Redis commands starting
1211+
# with such a slash). Normal RESP2/RESP3 requests are completely out of the
1212+
# path of the Gopher protocol implementation and are served as usually as well.
1213+
#
1214+
# If you open a connection to Redis when Gopher is enabled and send it
1215+
# a string like "/foo", if there is a key named "/foo" it is served via the
1216+
# Gopher protocol.
1217+
#
1218+
# In order to create a real Gopher "hole" (the name of a Gopher site in Gopher
1219+
# talking), you likely need a script like the following:
1220+
#
1221+
# https://github.com/antirez/gopher2redis
1222+
#
1223+
# --- SECURITY WARNING ---
1224+
#
1225+
# If you plan to put Redis on the internet in a publicly accessible address
1226+
# to server Gopher pages MAKE SURE TO SET A PASSWORD to the instance.
1227+
# Once a password is set:
1228+
#
1229+
# 1. The Gopher server (when enabled, not by default) will kill serve
1230+
# content via Gopher.
1231+
# 2. However other commands cannot be called before the client will
1232+
# authenticate.
1233+
#
1234+
# So use the 'requirepass' option to protect your instance.
1235+
#
1236+
# To enable Gopher support uncomment the following line and set
1237+
# the option from no (the default) to yes.
1238+
#
1239+
# gopher-enabled no
1240+
11861241
############################### ADVANCED CONFIG ###############################
11871242

11881243
# Hashes are encoded using a memory efficient data structure when they have a

0 commit comments

Comments
 (0)