-
Notifications
You must be signed in to change notification settings - Fork 2
/
README
256 lines (180 loc) · 8.17 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
DEPENDENCIES
_____________________________________________________________________
- phtools
- Bash
- core utils
PHTOOLS
_____________________________________________________________________
These are a set of utilities which 1436chan uses to create
dynamic menu content. They can be downloaded at:
http://github.com/kibook/phtools
NOTES ON GOPHER SERVER COMPATIBILITY
_____________________________________________________________________
1436chan has so far been developed/tested exclusively on the
Bucktooth gopher server. As long as a gopher server has support
for the following features, it should work without issue:
- Executable scripts ("moles")
- "gophermap" files which are executable scripts
INSTALLING/UPGRADING
_____________________________________________________________________
1. Extract chan.tar.gz to the folder that will be the root of
your chan
2. Run sh setup.sh
You can use the -quick flag (sh setup.sh -quick) to skip the
setup prompts and select all defaults. This is particularly
useful when upgrading (setup.sh will use your existing
configuration as the defaults).
SETUP OPTIONS
_____________________________________________________________________
Running sh setup.sh will prompt you for several options,
which are stored in params.sh. This section outlines what
each of these options means:
SERVER_HOST
This is the hostname of the Gopher server that the board is
running on.
SERVER_PORT
This is the port of the Gopher server that the board is
running on.
CHAN_ROOT
This is the root selector of your board.
MAX_THREADS
The maximum number of threads allowed on the board. When
MAX_THREADS threads already exist and a user creates a
new thread, the oldest thread (in terms of last updated)
is either archived or deleted (see ENABLE_ARCHIVE below).
MAX_TITLELEN
The maximum characters allowed in a thread
title. Additional characters are truncated.
MAX_POSTS
The maximum number of posts allowed in a thread. When
MAX_POSTS posts already exist, users will be unable to
add more posts to a thread. If this is 0, there is no
limit to the number of posts allowed.
MAX_POSTLEN
The maximum characters allowed in a post. Additional
characters are truncated.
ENABLE_ARCHIVE
Either 'y' or 'n'. If 'y', then old threads are preserved
instead of deleted when MAX_THREADS is reached. They will
be listed in a special "Archive" section instead of the
main menu. Otherwise, old threads are permanently deleted.
DATE_FORMAT
The format for displaying the date on posts and threads.
SHOW_EMPTY_THREADS
Either 'y' or 'n'. If 'y', then threads with 0 posts
are shown on the main menu of the board. Otherwise, such
empty threads are hidden until they have at least 1 post.
LAST_POSTS
Up to LAST_POSTS posts are shown under each thread on
the main menu.
MAX_UPLOAD
Maximum size of an upload in bytes. If this is > 0 then users
are allowed to reply with 'uploaded' files.
If this is 0, then uploads are disabled.
REMOTE_FILE_UPLOAD
Allow users to provide a URL to a file which the server
downloads to the respective thread directory and then posts a
link to it in said thread.
[WARNING]: This means your server may connect to and download
from other arbitrary servers. If you are concerned about
what connections you make or what kinds of files you are
storing on your server, disable this!
MAX_IMAGE
Maximum dimensions of an uploaded image (WxH). Leave blank
to disable.
DATA_DIR
Directory where extra data will be stored. Should be a
directory outside the gopher server root but with the same
permissions as CHAN_ROOT.
DELETE_TIME
Number of seconds within which a user may delete their own
post. Set to 0 to disable this feature.
MAX_RSS_ITEMS
Maximum number of feed items in the RSS feed. Set to 0 to
disable the RSS feed entirely.
POST_LIMIT
Number of seconds of cooldown time between posting/creating
new threads. Set to 0 to disable this feature.
SALT_DIR
Directory where salts used to generate tripcodes/post IDs
will be stored. Should be a directory outside the gopher
server root but with the same permissions as CHAN_ROOT.
Multiple boards may point to the same SALT_DIR to synchronize
tripcodes/post IDs across boards.
ENABLE_POST_IDS
Either 'y' or 'n'. If 'y', posts are given a post ID based
on the IP address of the poster.
ADMINISTRATOR UTILITY
_____________________________________________________________________
The Administrator utility provides a simple menu for performing
common tasks. To use it, run:
sh admin.sh
and follow the prompts. The individual scripts this menu calls
are described below as well.
DELETING A THREAD OR POST
_____________________________________________________________________
To delete a thread (from the root folder):
sh deletethread.sh <thread>
where <thread> is the thread number (##) of the thread.
To delete a post (from the root folder):
sh deletepost.sh <post>
where <post> is the post number (#) of the post.
MESSAGE OF THE DAY
_____________________________________________________________________
Create or edit the 'motd' file to add a message of the day
to the top of the board.
Lines in the motd file without TAB characters are turned in
to inline text (type i), e.g. the line:
Hello world!
will become:
iHello world!<TAB>fake<TAB>(NULL)<TAB>0<CR><LF>
Otherwise they are interpreted as Gopher links, e.g.:
IA picture<TAB>/pic<TAB>host<TAB>port
STICKIES
_____________________________________________________________________
Stickies appear at the top of the board (in order of last
update) marked by the prefix [sticky]. Unlike threads stickies
will never be deleted or archived unless done so manually by
an administrator. The administrator can create new stickies or
turn existing threads in to stickies using the scripts below:
sh newsticky.sh <title>
Creates a new open sticky titled <title>. Open stickies
can still be replied to by anyone.
sh newrosticky.sh <title>
Creates a new read-only (closed) sticky titled
<title>. Closed stickies can only be replied to by an
administrator.
sh makesticky.sh <directory>
Turns an existing thread in to an open sticky.
sh makerosticky.sh <directory>
Turns an existing thread in to a closed sticky.
rm -r sticky_<...>
Deletes the sticky with id <...>. Alternatively use
sh deletethread.sh <##> where ## is the thread number
of the sticky.
sh post.sh sticky_<...>
Add a post to the sticky with id <...>.
MULTIPLE BOARDS
_____________________________________________________________________
There is no built-in feature for this, but if you wish to have
multiple boards (representing certain subjects for discussion
perhaps) you may simply create a parent directory for the overall
"chan" and then perform the INSTALLING/UPGRADING procedure in
multiple subdirectories, one for each board. Finally, create
your own gophermap in the parent directory to customise the
list of boards.
PERMISSIONS
_____________________________________________________________________
If you need multiple users to have write permissions to your chan
(for example, when using Bucky running as a different user than the
one running the Gopher server), it is recommended you create a
group for these users and give group ownership to the chan
directory. For example:
chgrp -R 1436chan /var/gopher/chan
will set group ownership of your chan folder to '1436chan'. Then:
usermod -aG server 1436chan
usermod -aG bucky 1436chan
now both server (the user running the Gopher server) and bucky can
write.
After modifying permissions, run:
sh setup.sh