]> git.armaanb.net Git - bin.git/blob - man/scoop-cgi.1.scd
scoop-cgi: add logbot archive capabilities
[bin.git] / man / scoop-cgi.1.scd
1 scoop-cgi(1)
2
3 # NAME
4 scoop-cgi - run scoop as a cgi script
5
6 # SYNOPSIS
7 Run with your favorite web server
8
9 # DESCRIPTION
10 june's scooper is a great, full-featured web interface to litterbox, however it
11 is relatively complex. The plaintext output of scoop is good enough for me. This
12 script just makes it accesible via the web. It can also support logbot
13 archive files. Requires scoop and litterbox.
14
15 # URL SCHEME
16 */*
17         Home page
18
19 */channel*
20         Logs from channel from today
21
22 */channel/date*
23         Logs from channel from specified date. The date is passed through the date
24         command so on systems running the GNU coreutils, keywords like "last-thursday"
25         will work, however for portability, using ISO8601 (YYYY-MM-DD) is safest.
26
27 # CONFIGURATION
28 */etc/scoop-cgi/channels*
29         Contains a newline delimited list of channels to be publicly logged
30         from scoop.
31
32 */etc/scoop-cgi/database*
33         Contains the path to the litterbox database file.
34
35 */etc/scoop-cgi/logbot*
36         Contains a newline delimited list of channels to be publicly logged
37         from logbot archive files in /srv/www/scoop-cgi/.
38
39 # DRAWBACKS
40 - No built-in search functionality. Combine with YaCy or scoot for a searching
41   solution.
42 - Only supports a single database at a time
43 - Homepage text is hard coded
44
45 # SEE ALSO
46 *scoop*(1), *litterbox*(1)
47
48 # COPYRIGHT
49 This is free and unencumbered software released into the public domain. For more
50 information, please refer to <https://unlicense.org/>.